Download OpenAPI specification:Download
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
This API provides capability to retrieve cloud events of an asset id
asset required | string (CloudEventAssetType) Enum: "ports" "connections" "routers" "serviceTokens" "networks" "projects" "organizations" asset |
assetId required | string <uuid> (AssetId) Example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 asset UUID |
fromDateTime | string <date-time> (StartDateTime) Example: fromDateTime=2024-07-11T18:06:21Z Start date and time |
toDateTime | string <date-time> (EndDateTime) Example: toDateTime=2024-07-11T18:06:21Z End date and time |
offset | integer (Offset) Default: 0 Example: offset=0 offset |
limit | integer (Limit) Default: 20 Example: limit=20 limit |
object (Pagination) Pagination response information | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
Array of objects (CloudEvent) Data returned from the API call. | |||||||||||||||||||||||||||
Array
|
{- "pagination": {
- "offset": 20,
- "limit": 10,
- "total": 3,
- "next": null,
- "previous": null
}, - "data": [
- {
- "specversion": "1.0",
- "id": "66c62c1a-f186-4fbd-9792-71a60705518f",
- "time": "2025-03-20T13:13:12Z",
- "type": "equinix.fabric.connection.bgpipv4_session_status.connect",
- "subject": "/fabric/v4/connections/dab9fc84-cc95-4cb4-abe3-ca39361285a9/routingProtocol/e92cdf09-59eb-4131-ade4-49a87dc816dc",
- "datacontenttype": "application/json",
- "severitynumber": 5,
- "severitytext": "INFO",
- "equinixproject": "dadd3ab6-c0af-430c-8216-43d44f08c1c5",
- "authtype": "system",
- "authid": "equinix",
- "data": {
- "message": "Neighbor 100.100.100.102 address session state changed to Connect",
- "auth": {
- "type": "system",
- "id": "equinix"
}
}
}, - {
- "specversion": "1.0",
- "id": "66c62c1a-f186-4fbd-9792-71a60705518f",
- "type": "equinix.fabric.connection.state.provisioning",
- "subject": "/fabric/v4/connections/dab9fc84-cc95-4cb4-abe3-ca39361285a9",
- "time": "2025-03-20T13:13:12Z",
- "datacontenttype": "application/json",
- "severitynumber": 9,
- "severitytext": "INFO",
- "equinixproject": "dadd3ab6-c0af-430c-8216-43d44f08c1c5",
- "authtype": "user",
- "authid": 123456,
- "data": {
- "message": "Connection named TEST-CONNECTION state changed to provisioning",
- "resource": {
- "uuid": "dab9fc84-cc95-4cb4-abe3-ca39361285a9",
- "type": "IP_VC",
- "name": "TEST-CONNECTION",
- "state": "PROVISIONING"
}, - "auth": {
- "type": "user",
- "id": 123456,
- "name": "test user",
- "email": "testuser@test.com"
}
}
}, - {
- "specversion": "1.0",
- "id": "66c62c1a-f186-4fbd-9792-71a60705518f",
- "type": "equinix.fabric.connection.state.provisioned",
- "subject": "/fabric/v4/connections/dab9fc84-cc95-4cb4-abe3-ca39361285a9",
- "time": "2025-03-20T13:13:12Z",
- "datacontenttype": "application/json",
- "severitynumber": 9,
- "severitytext": "INFO",
- "equinixproject": "dadd3ab6-c0af-430c-8216-43d44f08c1c5",
- "authtype": "system",
- "authid": "equinix",
- "data": {
- "message": "Connection named TEST-CONNECTION state changed to provisioned",
- "resource": {
- "uuid": "dab9fc84-cc95-4cb4-abe3-ca39361285a9",
- "type": "IP_VC",
- "name": "TEST-CONNECTION",
- "state": "PROVISIONED"
}, - "auth": {
- "type": "system",
- "id": "equinix"
}
}
}
]
}
This API provides capability to retrieve a cloud event by uuid
cloudEventId required | string <uuid> (CloudEventId) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Cloud Event UUID |
spec | string Cloud Event Open Telemetry specification | ||||||||||||||||||||||||||||
source | string Cloud Event source | ||||||||||||||||||||||||||||
id | string <uuid> Cloud Event identifier | ||||||||||||||||||||||||||||
type | string Equinix supported event type | ||||||||||||||||||||||||||||
subject | string Cloud Event subject | ||||||||||||||||||||||||||||
dataschema | string Cloud Event dataschema reference | ||||||||||||||||||||||||||||
datacontenttype | string Cloud Event data content type | ||||||||||||||||||||||||||||
severitynumber | string Cloud Event severity number | ||||||||||||||||||||||||||||
severitytext | string Cloud Event severity text | ||||||||||||||||||||||||||||
equinixproject | string <uuid> Equinix project identifier | ||||||||||||||||||||||||||||
authtype | string Cloud Event auth type | ||||||||||||||||||||||||||||
authid | string Cloud Event user identifier | ||||||||||||||||||||||||||||
object (CloudEventData) | |||||||||||||||||||||||||||||
|
{- "specversion": "1.0",
- "id": "66c62c1a-f186-4fbd-9792-71a60705518f",
- "type": "equinix.fabric.connection.state.provisioning",
- "subject": "/fabric/v4/connections/dab9fc84-cc95-4cb4-abe3-ca39361285a9",
- "time": "2025-03-20T13:13:12Z",
- "datacontenttype": "application/json",
- "severitynumber": 9,
- "severitytext": "INFO",
- "equinixproject": "dadd3ab6-c0af-430c-8216-43d44f08c1c5",
- "authtype": "user",
- "authid": 123456,
- "data": {
- "message": "Connection named TEST-CONNECTION state changed to provisioning",
- "resource": {
- "uuid": "dab9fc84-cc95-4cb4-abe3-ca39361285a9",
- "type": "IP_VC",
- "name": "TEST-CONNECTION",
- "state": "PROVISIONING"
}, - "auth": {
- "type": "user",
- "id": 123456,
- "name": "test user",
- "email": "testuser@test.com"
}
}
}
This API provides capability to search cloud events from a filtered query
object (CloudEventFilters) | |||||||||||
| |||||||||||
object (PaginationRequest) Pagination request information | |||||||||||
| |||||||||||
Array of objects (CloudEventFilters) | |||||||||||
Array
|
object (Pagination) Pagination response information | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
Array of objects (CloudEvent) Data returned from the API call. | |||||||||||||||||||||||||||
Array
|
{- "filter": {
- "and": [
- {
- "property": "/type",
- "operator": "IN",
- "values": [
- "equinix.fabric.port.status.*"
]
}, - {
- "property": "/subject",
- "operator": "IN",
- "values": [
- "/fabric/v4/ports/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d*",
- "/fabric/v4/ports/c8bba3be-5132-4669-bb47-7f1a8811359b*"
]
}, - {
- "property": "/time",
- "operator": ">",
- "values": [
- "2018-04-05T17:31:00.000Z"
]
}
]
}, - "pagination": {
- "offset": 0,
- "limit": 20
}
}
{- "pagination": {
- "offset": 20,
- "limit": 10,
- "total": 3,
- "next": null,
- "previous": null
}, - "data": [
- {
- "specversion": "1.0",
- "id": "66c62c1a-f186-4fbd-9792-71a60705518f",
- "time": "2025-03-20T13:13:12Z",
- "type": "equinix.fabric.connection.bgpipv4_session_status.connect",
- "subject": "/fabric/v4/connections/dab9fc84-cc95-4cb4-abe3-ca39361285a9/routingProtocol/e92cdf09-59eb-4131-ade4-49a87dc816dc",
- "datacontenttype": "application/json",
- "severitynumber": 5,
- "severitytext": "INFO",
- "equinixproject": "dadd3ab6-c0af-430c-8216-43d44f08c1c5",
- "authtype": "system",
- "authid": "equinix",
- "data": {
- "message": "Neighbor 100.100.100.102 address session state changed to Connect",
- "auth": {
- "type": "system",
- "id": "equinix"
}
}
}, - {
- "specversion": "1.0",
- "id": "66c62c1a-f186-4fbd-9792-71a60705518f",
- "type": "equinix.fabric.connection.state.provisioning",
- "subject": "/fabric/v4/connections/dab9fc84-cc95-4cb4-abe3-ca39361285a9",
- "time": "2025-03-20T13:13:12Z",
- "datacontenttype": "application/json",
- "severitynumber": 9,
- "severitytext": "INFO",
- "equinixproject": "dadd3ab6-c0af-430c-8216-43d44f08c1c5",
- "authtype": "user",
- "authid": 123456,
- "data": {
- "message": "Connection named TEST-CONNECTION state changed to provisioning",
- "resource": {
- "uuid": "dab9fc84-cc95-4cb4-abe3-ca39361285a9",
- "type": "IP_VC",
- "name": "TEST-CONNECTION",
- "state": "PROVISIONING"
}, - "auth": {
- "type": "user",
- "id": 123456,
- "name": "test user",
- "email": "testuser@test.com"
}
}
}, - {
- "specversion": "1.0",
- "id": "66c62c1a-f186-4fbd-9792-71a60705518f",
- "type": "equinix.fabric.connection.state.provisioned",
- "subject": "/fabric/v4/connections/dab9fc84-cc95-4cb4-abe3-ca39361285a9",
- "time": "2025-03-20T13:13:12Z",
- "datacontenttype": "application/json",
- "severitynumber": 9,
- "severitytext": "INFO",
- "equinixproject": "dadd3ab6-c0af-430c-8216-43d44f08c1c5",
- "authtype": "system",
- "authid": "equinix",
- "data": {
- "message": "Connection named TEST-CONNECTION state changed to provisioned",
- "resource": {
- "uuid": "dab9fc84-cc95-4cb4-abe3-ca39361285a9",
- "type": "IP_VC",
- "name": "TEST-CONNECTION",
- "state": "PROVISIONED"
}, - "auth": {
- "type": "system",
- "id": "equinix"
}
}
}
]
}
The API provides capability to get list of user's advertised routes using search criteria, including optional filtering, pagination and sorting
connectionId required | string (ConnectionId) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Connection Id |
object (ConnectionRouteEntryFilters) | |||||||||||
| |||||||||||
object (PaginationRequest) Pagination request information | |||||||||||
| |||||||||||
Array of objects (ConnectionRouteSortCriteria) | |||||||||||
Array
|
object (Pagination) Pagination response information | |||||||||||||||||||||||
| |||||||||||||||||||||||
Array of objects (ConnectionRouteTableEntry) Data returned from the API call. | |||||||||||||||||||||||
Array
|
{- "filter": {
- "and": [
- {
- "property": "/type",
- "operator": "=",
- "values": [
- "IPv4_BGP_ROUTE"
]
}
]
}, - "pagination": {
- "offset": 0,
- "limit": 20
}, - "sort": [
- {
- "direction": "DESC",
- "property": "/changeLog/createdDateTime"
}
]
}
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 0,
- "next": "string",
- "previous": "string"
}, - "data": [
- {
- "type": "IPv4_BGP_ROUTE",
- "protocolType": "BGP",
- "state": "ACTIVE",
- "age": "PT5M30S",
- "prefix": "192.168.10.0/24",
- "nextHop": "10.10.10.5",
- "MED": 5,
- "localPreference": 200,
- "asPath": [
- "string"
], - "connection": {
- "uuid": "81331c52-04c0-4656-a4a7-18c52669348f",
- "name": "connection_1"
}, - "changeLog": {
- "createdBy": "johnsmith",
- "createdByFullName": "John Smith",
- "createdByEmail": "john.smith@example.com",
- "createdDateTime": "2020-11-06T07:00:00Z",
- "updatedBy": "johnsmith",
- "updatedByFullName": "John Smith",
- "updatedByEmail": "john.smith@example.com",
- "updatedDateTime": "2020-11-06T07:00:00Z",
- "deletedBy": "johnsmith",
- "deletedByFullName": "John Smith",
- "deletedByEmail": "john.smith@example.com",
- "deletedDateTime": "2020-11-06T07:00:00Z"
}
}
]
}
The API provides capability to get list of received routes using search criteria, including optional filtering, pagination and sorting
connectionId required | string (ConnectionId) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Connection Id |
object (ConnectionRouteEntryFilters) | |||||||||||
| |||||||||||
object (PaginationRequest) Pagination request information | |||||||||||
| |||||||||||
Array of objects (ConnectionRouteSortCriteria) | |||||||||||
Array
|
object (Pagination) Pagination response information | |||||||||||||||||||||||
| |||||||||||||||||||||||
Array of objects (ConnectionRouteTableEntry) Data returned from the API call. | |||||||||||||||||||||||
Array
|
{- "filter": {
- "and": [
- {
- "property": "/type",
- "operator": "=",
- "values": [
- "IPv4_BGP_ROUTE"
]
}
]
}, - "pagination": {
- "offset": 0,
- "limit": 20
}, - "sort": [
- {
- "direction": "DESC",
- "property": "/changeLog/createdDateTime"
}
]
}
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 0,
- "next": "string",
- "previous": "string"
}, - "data": [
- {
- "type": "IPv4_BGP_ROUTE",
- "protocolType": "BGP",
- "state": "ACTIVE",
- "age": "PT5M30S",
- "prefix": "192.168.10.0/24",
- "nextHop": "10.10.10.5",
- "MED": 5,
- "localPreference": 200,
- "asPath": [
- "string"
], - "connection": {
- "uuid": "81331c52-04c0-4656-a4a7-18c52669348f",
- "name": "connection_1"
}, - "changeLog": {
- "createdBy": "johnsmith",
- "createdByFullName": "John Smith",
- "createdByEmail": "john.smith@example.com",
- "createdDateTime": "2020-11-06T07:00:00Z",
- "updatedBy": "johnsmith",
- "updatedByFullName": "John Smith",
- "updatedByEmail": "john.smith@example.com",
- "updatedDateTime": "2020-11-06T07:00:00Z",
- "deletedBy": "johnsmith",
- "deletedByFullName": "John Smith",
- "deletedByEmail": "john.smith@example.com",
- "deletedDateTime": "2020-11-06T07:00:00Z"
}
}
]
}
This API provides capability to create user's Cloud Routers
dryRun | boolean Default: false option to verify that API calls will succeed |
type required | string Value: "XF_ROUTER" | ||||||||||||||||||||||||
name required | string Customer-provided Cloud Router name | ||||||||||||||||||||||||
required | object (SimplifiedLocationWithoutIBX) | ||||||||||||||||||||||||
| |||||||||||||||||||||||||
required | object (CloudRouterPostRequestPackage) Fabric Cloud Router Package Type | ||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (Order) | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (SimplifiedAccount) | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Array of objects (SimplifiedNotification) Preferences for notifications on connection configuration or status changes | |||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||
object (marketplaceSubscription) Equinix Fabric Entity for Marketplace Subscription | |||||||||||||||||||||||||
|
href | string <uri> Cloud Routers URI | ||||||||||||||||||||||||
uuid | string <uuid> Equinix-assigned access point identifier | ||||||||||||||||||||||||
name required | string <string> Customer-provided Cloud Router name | ||||||||||||||||||||||||
state | string (CloudRouterAccessPointState) Enum: "PROVISIONED" "PROVISIONING" "DEPROVISIONING" "DEPROVISIONED" "REPROVISIONING" "NOT_PROVISIONED" "NOT_DEPROVISIONED" Access point lifecycle state | ||||||||||||||||||||||||
equinixAsn | integer <int64> Equinix ASN | ||||||||||||||||||||||||
connectionsCount | integer >= 0 Number of connections associated with this Access point | ||||||||||||||||||||||||
object Equinix Fabric Entity for Marketplace Subscription | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (Changelog) Change log | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (CloudRouterChange) Current state of latest CloudRouter change | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
type required | string Value: "XF_ROUTER" | ||||||||||||||||||||||||
required | object (SimplifiedLocationWithoutIBX) | ||||||||||||||||||||||||
| |||||||||||||||||||||||||
required | object (CloudRouterPostRequestPackage) Fabric Cloud Router Package Type | ||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (Order) | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (SimplifiedAccount) | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Array of objects (SimplifiedNotification) Preferences for notifications on connection configuration or status changes | |||||||||||||||||||||||||
Array
|
{- "type": "XF_ROUTER",
- "name": "My-Cloud-Router",
- "location": {
- "metroCode": "SV"
}, - "package": {
- "code": "LAB"
}, - "notifications": [
- {
- "type": "ALL",
- "emails": [
- "test@test.com"
]
}
], - "account": {
- "accountNumber": 272010
}, - "project": {
- "projectId": "995072000433550"
}
}
{- "uuid": "201b7346-a9eb-42fe-ae7a-08148c71928d",
- "state": "PROVISIONED",
- "type": "XF_ROUTER",
- "name": "My-Cloud-Router",
- "equinixAsn": 30000,
- "package": {
- "code": "STANDARD"
}, - "order": {
- "purchaseOrderNumber": "1-129105284100"
}, - "project": {
- "projectId": "12345"
}, - "notifications": [
- {
- "type": "ALL",
- "emails": [
- "abc@abc.com"
]
}
], - "account": {
- "accountNumber": 123
}, - "connectionsCount": 0,
- "changeLog": {
- "createdBy": "abc@xyz.com",
- "createdByFullName": "abc",
- "createdByEmail": "abc@xyz.com",
- "createdDateTime": "2021-09-24T06:59:46Z"
}
}
This API provides capability to retrieve user's Cloud Routers
routerId required | string <uuid> (RouterId) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Cloud Router UUID |
href | string <uri> Cloud Routers URI | ||||||||||||||||||||||||
uuid | string <uuid> Equinix-assigned access point identifier | ||||||||||||||||||||||||
name required | string <string> Customer-provided Cloud Router name | ||||||||||||||||||||||||
state | string (CloudRouterAccessPointState) Enum: "PROVISIONED" "PROVISIONING" "DEPROVISIONING" "DEPROVISIONED" "REPROVISIONING" "NOT_PROVISIONED" "NOT_DEPROVISIONED" Access point lifecycle state | ||||||||||||||||||||||||
equinixAsn | integer <int64> Equinix ASN | ||||||||||||||||||||||||
connectionsCount | integer >= 0 Number of connections associated with this Access point | ||||||||||||||||||||||||
object Equinix Fabric Entity for Marketplace Subscription | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (Changelog) Change log | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (CloudRouterChange) Current state of latest CloudRouter change | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
type required | string Value: "XF_ROUTER" | ||||||||||||||||||||||||
required | object (SimplifiedLocationWithoutIBX) | ||||||||||||||||||||||||
| |||||||||||||||||||||||||
required | object (CloudRouterPostRequestPackage) Fabric Cloud Router Package Type | ||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (Order) | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (SimplifiedAccount) | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Array of objects (SimplifiedNotification) Preferences for notifications on connection configuration or status changes | |||||||||||||||||||||||||
Array
|
{- "uuid": "201b7346-a9eb-42fe-ae7a-08148c71928d",
- "state": "PROVISIONED",
- "type": "XF_ROUTER",
- "name": "My-Cloud-Router",
- "equinixAsn": 30000,
- "package": {
- "code": "STANDARD"
}, - "order": {
- "purchaseOrderNumber": "1-129105284100"
}, - "project": {
- "projectId": "ae708bbb-d669-406a-845a-99b39ff65fd0"
}, - "notifications": [
- {
- "type": "ALL",
- "emails": [
- "abc@abc.com"
]
}
], - "account": {
- "accountNumber": 123
}, - "connectionsCount": 0,
- "changeLog": {
- "createdBy": "abc@xyz.com",
- "createdByFullName": "abc",
- "createdByEmail": "abc@xyz.com",
- "createdDateTime": "2021-09-24T06:59:46Z",
- "updatedBy": "abc@xyz.com",
- "updatedByFullName": "abc",
- "updatedByEmail": "abc@xyz.com",
- "updatedDateTime": "2021-09-24T06:59:46Z",
- "deletedBy": "abc@xyz.com",
- "deletedByFullName": "abc",
- "deletedByEmail": "abc@xyz.com",
- "deletedDateTime": "2021-09-24T06:59:46Z"
}
}
This API provides capability to delete user's Cloud Routers
routerId required | string <uuid> (RouterId) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Cloud Router UUID |
[- {
- "errorCode": "EQ-3040030",
- "errorMessage": "Cannot delete Fabric Cloud Router in transient state",
- "correlationId": "c82ff3bc-de07-47e5-b3ec-53a009d01515",
- "details": "Cannot delete Fabric Cloud Router in transient state."
}
]
This API provides capability to update user's Cloud Routers
routerId required | string <uuid> (RouterId) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Cloud Router UUID |
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 |
href | string <uri> Cloud Routers URI | ||||||||||||||||||||||||
uuid | string <uuid> Equinix-assigned access point identifier | ||||||||||||||||||||||||
name required | string <string> Customer-provided Cloud Router name | ||||||||||||||||||||||||
state | string (CloudRouterAccessPointState) Enum: "PROVISIONED" "PROVISIONING" "DEPROVISIONING" "DEPROVISIONED" "REPROVISIONING" "NOT_PROVISIONED" "NOT_DEPROVISIONED" Access point lifecycle state | ||||||||||||||||||||||||
equinixAsn | integer <int64> Equinix ASN | ||||||||||||||||||||||||
connectionsCount | integer >= 0 Number of connections associated with this Access point | ||||||||||||||||||||||||
object Equinix Fabric Entity for Marketplace Subscription | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (Changelog) Change log | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (CloudRouterChange) Current state of latest CloudRouter change | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
type required | string Value: "XF_ROUTER" | ||||||||||||||||||||||||
required | object (SimplifiedLocationWithoutIBX) | ||||||||||||||||||||||||
| |||||||||||||||||||||||||
required | object (CloudRouterPostRequestPackage) Fabric Cloud Router Package Type | ||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (Order) | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (SimplifiedAccount) | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Array of objects (SimplifiedNotification) Preferences for notifications on connection configuration or status changes | |||||||||||||||||||||||||
Array
|
[- {
- "op": "replace",
- "path": "/package/code",
- "value": "PREMIUM"
}
]
{- "uuid": "201b7346-a9eb-42fe-ae7a-08148c71928d",
- "state": "PROVISIONED",
- "type": "XF_ROUTER",
- "name": "My-Cloud-Router",
- "equinixAsn": 30000,
- "package": {
- "code": "STANDARD"
}, - "order": {
- "purchaseOrderNumber": "1-129105284100"
}, - "project": {
- "projectId": "123456"
}, - "notifications": [
- {
- "type": "ALL",
- "emails": [
- "abc@abc.com"
]
}
], - "account": {
- "accountNumber": 123
}, - "connectionsCount": 0,
- "change": {
- "uuid": "3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
- "type": "ROUTER_UPDATE",
- "status": "REQUESTED",
- "createdDateTime": "2022-04-19T04:20:55.471Z",
- "updatedDateTime": "2022-04-19T04:20:55.471Z"
}, - "changeLog": {
- "createdBy": "abc@xyz.com",
- "createdByFullName": "abc",
- "createdByEmail": "abc@xyz.com",
- "createdDateTime": "2021-09-24T06:59:46Z",
- "updatedBy": "abc@xyz.com",
- "updatedByFullName": "abc",
- "updatedByEmail": "abc@xyz.com",
- "updatedDateTime": "2021-09-24T06:59:46Z",
- "deletedBy": "abc@xyz.com",
- "deletedByFullName": "abc",
- "deletedByEmail": "abc@xyz.com",
- "deletedDateTime": "2021-09-24T06:59:46Z"
}
}
This API provides capability to fetch action status
routerId required | string <uuid> (RouterId_1) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Router UUID |
state | string (ActionState) Enum: "SUCCEEDED" "FAILED" "PENDING" Action state |
type required | string (CloudRouterActionType) Enum: "BGP_SESSION_STATUS_UPDATE" "ROUTE_TABLE_ENTRY_UPDATE" "RECEIVED_ROUTE_ENTRY_UPDATE" "ADVERTISED_ROUTE_ENTRY_UPDATE" Cloud router action type | ||||||||||||||||||||||||
uuid required | string <uuid> | ||||||||||||||||||||||||
description | string | ||||||||||||||||||||||||
state required | string (CloudRouterActionState) Enum: "SUCCEEDED" "FAILED" "PENDING" Cloud router action state | ||||||||||||||||||||||||
required | object (Changelog) Change log | ||||||||||||||||||||||||
| |||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||
object (RouterActionsConnection) Connection object for router actions | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (Operation) Operation object for router actions | |||||||||||||||||||||||||
|
{- "type": "ROUTE_TABLE_ENTRY_UPDATE",
- "uuid": "37c10edc-ba2e-4240-a850-8a48f9c47d00",
- "state": "PENDING",
- "changeLog": {
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}
This API provides capability to refresh route table and bgp session summary information
routerId required | string <uuid> (RouterId_1) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Router UUID |
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 | |||
|
{- "type": "ROUTE_TABLE_ENTRY_UPDATE"
}
{- "type": "ROUTE_TABLE_ENTRY_UPDATE",
- "uuid": "37c10edc-ba2e-4240-a850-8a48f9c47d00",
- "state": "PENDING",
- "changeLog": {
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}
This API provides capability to refresh route table and bgp session summary information
routerId required | string <uuid> (RouterId_1) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Router UUID |
object (CloudRouterActionsSearchFilters) | |||||||||||
| |||||||||||
object (PaginationRequest) Pagination request information | |||||||||||
| |||||||||||
Array of objects (CloudRouterActionsSearchSortCriteria) | |||||||||||
Array
|
object (Pagination) Pagination response information | |||||||||||||||||
| |||||||||||||||||
Array of objects (CloudRouterActionResponse) Data returned from the API call. | |||||||||||||||||
Array
|
{- "filter": {
- "and": [
- {
- "property": "/type",
- "operator": "=",
- "values": [
- "ROUTE_TABLE_ENTRY_UPDATE"
]
}
]
}, - "pagination": {
- "offset": 0,
- "limit": 20
}, - "sort": [
- {
- "direction": "DESC",
- "property": "/changeLog/createdDateTime"
}
]
}
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 0,
- "next": "string",
- "previous": "string"
}, - "data": [
- {
- "type": "BGP_SESSION_STATUS_UPDATE",
- "uuid": "557400f8-d360-11e9-bb65-2a2ae2dbcce4",
- "description": "description",
- "state": "SUCCEEDED",
- "changeLog": {
- "createdBy": "johnsmith",
- "createdByFullName": "John Smith",
- "createdByEmail": "john.smith@example.com",
- "createdDateTime": "2020-11-06T07:00:00Z",
- "updatedBy": "johnsmith",
- "updatedByFullName": "John Smith",
- "updatedByEmail": "john.smith@example.com",
- "updatedDateTime": "2020-11-06T07:00:00Z",
- "deletedBy": "johnsmith",
- "deletedByFullName": "John Smith",
- "deletedByEmail": "john.smith@example.com",
- "deletedDateTime": "2020-11-06T07:00:00Z"
}, - "connection": {
- "uuid": "557400f8-d360-11e9-bb65-2a2ae2dbcce4"
}, - "operation": {
- "bgpIpv4RoutesCount": 6,
- "bgpIpv6RoutesCount": 6
}
}
]
}
This API provides capability to fetch action status
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 |
state | string (ActionState) Enum: "SUCCEEDED" "FAILED" "PENDING" Action state |
type required | string (CloudRouterActionType) Enum: "BGP_SESSION_STATUS_UPDATE" "ROUTE_TABLE_ENTRY_UPDATE" "RECEIVED_ROUTE_ENTRY_UPDATE" "ADVERTISED_ROUTE_ENTRY_UPDATE" Cloud router action type | ||||||||||||||||||||||||
uuid required | string <uuid> | ||||||||||||||||||||||||
description | string | ||||||||||||||||||||||||
state required | string (CloudRouterActionState) Enum: "SUCCEEDED" "FAILED" "PENDING" Cloud router action state | ||||||||||||||||||||||||
required | object (Changelog) Change log | ||||||||||||||||||||||||
| |||||||||||||||||||||||||
href | string | ||||||||||||||||||||||||
object (RouterActionsConnection) Connection object for router actions | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (Operation) Operation object for router actions | |||||||||||||||||||||||||
|
{- "type": "ROUTE_TABLE_ENTRY_UPDATE",
- "uuid": "37c10edc-ba2e-4240-a850-8a48f9c47d00",
- "state": "PENDING",
- "changeLog": {
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}
This API provides capability to fetch all commands
routerId required | string <uuid> (RouterId_1) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Router UUID |
object (Pagination) Pagination response information | |||||||||||||||||||||
| |||||||||||||||||||||
Array of objects (CloudRouterCommand) | |||||||||||||||||||||
Array
|
{- "pagination": {
- "offset": 20,
- "limit": 20,
- "total": 100,
- "next": "/search?offset=40&limit=20",
- "previous": "/search?offset=0&limit=20"
}, - "data": {
- "type": "PING_COMMAND",
- "uuid": "37c10edc-ba2e-4240-a850-8a48f9c47d00",
- "name": "ping-test-1",
- "description": "Testing FCR-SV-1",
- "state": "SUCCEEDED",
- "project": {
- "projectId": "b11d4cb5-978a-418a-8b13-bf19abb97938"
}, - "request": {
- "destination": "8.8.8.8",
- "sourceConnection": {
- "uuid": "1da3778c-6aa3-4e47-b2fe-83a0773dde18"
}, - "timeout": 5,
- "dataBytes": 100,
- "count": 5,
- "interval": 1000
}, - "response": {
- "output": "PING 8.8.8.8 (8.8.8.8): 100 data bytes\n108 bytes from 8.8.8.8: icmp_seq=0 ttl=117 time=9.839 ms\n108 bytes from 8.8.8.8: icmp_seq=1 ttl=117 time=16.051 ms\n108 bytes from 8.8.8.8: icmp_seq=2 ttl=117 time=9.271 ms\n108 bytes from 8.8.8.8: icmp_seq=3 ttl=117 time=26.771 ms \n--- 8.8.8.8 ping statistics ---\n4 packets transmitted, 4 packets received, 0.0% packet loss\nround-trip min/avg/max/stddev = 9.271/15.483/26.771/7.039 ms",
- "outputStructuredPing": {
- "destinationIp": "8.8.8.8",
- "destinationName": "8.8.8.8",
- "dataBytes": 100,
- "packetsTransmitted": 4,
- "packetsReceived": 4,
- "packetsLossPercent": 0,
- "rttMin": 9.271,
- "rttAvg": 15.483,
- "rttMax": 26.771,
- "rttStdDev": 7.039,
- "responses": [
- {
- "bytes": 100,
- "ip": "8.8.8.8",
- "icmpSeq": 0,
- "ttl": 117,
- "time": 9.839
}, - {
- "bytes": 100,
- "ip": "8.8.8.8",
- "icmpSeq": 1,
- "ttl": 117,
- "time": 16.051
}, - {
- "bytes": 100,
- "ip": "8.8.8.8",
- "icmpSeq": 2,
- "ttl": 117,
- "time": 9.271
}, - {
- "bytes": 100,
- "ip": "8.8.8.8",
- "icmpSeq": 3,
- "ttl": 117,
- "time": 26.771
}
]
}
}, - "changeLog": {
- "createdBy": "testuser",
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}
}
This API provides capability to initiate Command
routerId required | string <uuid> (RouterId_1) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Router UUID |
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) | ||||||||||||||||
| |||||||||||||||||
required | object (CloudRouterCommandRequest) Fabric Cloud Router Command Request | ||||||||||||||||
|
{- "type": "PING_COMMAND",
- "name": "ping-test-1",
- "description": "Testing FCR-SV-1",
- "project": {
- "projectId": "b11d4cb5-978a-418a-8b13-bf19abb97938"
}, - "request": {
- "destination": "8.8.8.8",
- "sourceConnection": {
- "uuid": "1da3778c-6aa3-4e47-b2fe-83a0773dde18"
}, - "timeout": 2,
- "dataBytes": 100
}
}
{- "type": "PING_COMMAND",
- "uuid": "37c10edc-ba2e-4240-a850-8a48f9c47d00",
- "name": "ping-test-1",
- "description": "Testing FCR-SV-1",
- "state": "PENDING",
- "project": {
- "projectId": "b11d4cb5-978a-418a-8b13-bf19abb97938"
}, - "request": {
- "destination": "8.8.8.8",
- "sourceConnection": {
- "uuid": "1da3778c-6aa3-4e47-b2fe-83a0773dde18"
}, - "timeout": 2,
- "dataBytes": 100,
- "count": 5,
- "interval": 1000
}, - "changeLog": {
- "createdBy": "testuser",
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}
This API provides capability to search commands
routerId required | string <uuid> (RouterId_1) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Router UUID |
object (CloudRouterCommandSearchFilters) | |||||||||||
| |||||||||||
object (PaginationRequest) Pagination request information | |||||||||||
| |||||||||||
Array of objects (CloudRouterCommandSearchSortCriteria) | |||||||||||
Array
|
object (Pagination) Pagination response information | |||||||||||||||||||||
| |||||||||||||||||||||
Array of objects (CloudRouterCommand) Data returned from the API call. | |||||||||||||||||||||
Array
|
{- "filter": {
- "and": [
- {
- "property": "/state",
- "operator": "=",
- "values": [
- "SUCCEEDED"
]
}
]
}, - "pagination": {
- "offset": 0,
- "limit": 20
}, - "sort": [
- {
- "direction": "DESC",
- "property": "/changeLog/createdDateTime"
}
]
}
{- "pagination": {
- "offset": 20,
- "limit": 20,
- "total": 100,
- "next": "/search?offset=40&limit=20",
- "previous": "/search?offset=0&limit=20"
}, - "data": {
- "type": "PING_COMMAND",
- "uuid": "37c10edc-ba2e-4240-a850-8a48f9c47d00",
- "name": "ping-test-1",
- "description": "Testing FCR-SV-1",
- "state": "SUCCEEDED",
- "project": {
- "projectId": "b11d4cb5-978a-418a-8b13-bf19abb97938"
}, - "request": {
- "destination": "8.8.8.8",
- "sourceConnection": {
- "uuid": "1da3778c-6aa3-4e47-b2fe-83a0773dde18"
}, - "timeout": 2,
- "dataBytes": 100,
- "count": 5,
- "interval": 1000
}, - "response": {
- "output": "PING 8.8.8.8 (8.8.8.8): 100 data bytes\n108 bytes from 8.8.8.8: icmp_seq=0 ttl=117 time=9.839 ms\n108 bytes from 8.8.8.8: icmp_seq=1 ttl=117 time=16.051 ms\n108 bytes from 8.8.8.8: icmp_seq=2 ttl=117 time=9.271 ms\n108 bytes from 8.8.8.8: icmp_seq=3 ttl=117 time=26.771 ms \n--- 8.8.8.8 ping statistics ---\n4 packets transmitted, 4 packets received, 0.0% packet loss\nround-trip min/avg/max/stddev = 9.271/15.483/26.771/7.039 ms",
- "outputStructuredPing": {
- "destinationIp": "8.8.8.8",
- "destinationName": "8.8.8.8",
- "dataBytes": 100,
- "packetsTransmitted": 4,
- "packetsReceived": 4,
- "packetsLossPercent": 0,
- "rttMin": 9.271,
- "rttAvg": 15.483,
- "rttMax": 26.771,
- "rttStdDev": 7.039,
- "responses": [
- {
- "bytes": 100,
- "ip": "8.8.8.8",
- "icmpSeq": 0,
- "ttl": 117,
- "time": 9.839
}, - {
- "bytes": 100,
- "ip": "8.8.8.8",
- "icmpSeq": 1,
- "ttl": 117,
- "time": 16.051
}, - {
- "bytes": 100,
- "ip": "8.8.8.8",
- "icmpSeq": 2,
- "ttl": 117,
- "time": 9.271
}, - {
- "bytes": 100,
- "ip": "8.8.8.8",
- "icmpSeq": 3,
- "ttl": 117,
- "time": 26.771
}
]
}
}, - "changeLog": {
- "createdBy": "testuser",
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}
}
This API provides capability to fetch command using command Id
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 |
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 (CloudRouterCommandRequest) Fabric Cloud Router Command Request | |||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||
CloudRouterCommandPingResponse (object) or CloudRouterCommandTracerouteResponse (object) (CloudRouterCommandResponse) | |||||||||||||||||||||||||||||||||||||||||||||
One of
| |||||||||||||||||||||||||||||||||||||||||||||
object (Changelog) Change log | |||||||||||||||||||||||||||||||||||||||||||||
|
{- "type": "PING_COMMAND",
- "uuid": "37c10edc-ba2e-4240-a850-8a48f9c47d00",
- "name": "ping-test-1",
- "description": "Testing FCR-SV-1",
- "state": "SUCCEEDED",
- "project": {
- "projectId": "b11d4cb5-978a-418a-8b13-bf19abb97938"
}, - "request": {
- "destination": "8.8.8.8",
- "sourceConnection": {
- "uuid": "1da3778c-6aa3-4e47-b2fe-83a0773dde18"
}, - "timeout": 2,
- "dataBytes": 100,
- "count": 5,
- "interval": 1000
}, - "response": {
- "output": "PING 8.8.8.8 (8.8.8.8): 100 data bytes\n108 bytes from 8.8.8.8: icmp_seq=0 ttl=117 time=9.839 ms\n108 bytes from 8.8.8.8: icmp_seq=1 ttl=117 time=16.051 ms\n108 bytes from 8.8.8.8: icmp_seq=2 ttl=117 time=9.271 ms\n108 bytes from 8.8.8.8: icmp_seq=3 ttl=117 time=26.771 ms \n--- 8.8.8.8 ping statistics ---\n4 packets transmitted, 4 packets received, 0.0% packet loss\nround-trip min/avg/max/stddev = 9.271/15.483/26.771/7.039 ms",
- "outputStructuredPing": {
- "destinationIp": "8.8.8.8",
- "destinationName": "8.8.8.8",
- "dataBytes": 100,
- "packetsTransmitted": 4,
- "packetsReceived": 4,
- "packetsLossPercent": 0,
- "rttMin": 9.271,
- "rttAvg": 15.483,
- "rttMax": 26.771,
- "rttStdDev": 7.039,
- "responses": [
- {
- "bytes": 100,
- "ip": "8.8.8.8",
- "icmpSeq": 0,
- "ttl": 117,
- "time": 9.839
}, - {
- "bytes": 100,
- "ip": "8.8.8.8",
- "icmpSeq": 1,
- "ttl": 117,
- "time": 16.051
}, - {
- "bytes": 100,
- "ip": "8.8.8.8",
- "icmpSeq": 2,
- "ttl": 117,
- "time": 9.271
}, - {
- "bytes": 100,
- "ip": "8.8.8.8",
- "icmpSeq": 3,
- "ttl": 117,
- "time": 26.771
}
]
}
}, - "changeLog": {
- "createdBy": "testuser",
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}
This API provides capability to delete command based on command Id
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 |
[- {
- "errorCode": "EQ-3043023",
- "errorMessage": "Cannot delete Command in pending state",
- "correlationId": "c82ff3bc-de07-47e5-b3ec-53a009d01515",
- "details": "Cannot delete Fabric Cloud Router in transient state."
}
]
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
routerId required | string <uuid> (RouterId_1) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Router UUID |
object (RouteTableEntryFilters) | |||||||||||
| |||||||||||
object (PaginationRequest) Pagination request information | |||||||||||
| |||||||||||
Array of objects (RouteTableEntrySortCriteria) | |||||||||||
Array
|
object (Pagination) Pagination response information | |||||||||||||||||||||||
| |||||||||||||||||||||||
Array of objects (RouteTableEntry) Data returned from the API call. | |||||||||||||||||||||||
Array
|
{- "filter": {
- "and": [
- {
- "property": "/nextHop",
- "operator": "=",
- "values": [
- "67.2223.179.193"
]
}
]
}, - "pagination": {
- "offset": 0,
- "limit": 20
}, - "sort": [
- {
- "direction": "DESC",
- "property": "/changeLog/createdDateTime"
}
]
}
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 0,
- "next": "string",
- "previous": "string"
}, - "data": [
- {
- "type": "IPv4_BGP_ROUTE",
- "protocolType": "BGP",
- "state": "ACTIVE",
- "age": "PT5M30S",
- "prefix": "192.168.10.0/24",
- "nextHop": "10.10.10.5",
- "MED": 5,
- "localPreference": 200,
- "asPath": [
- "string"
], - "connection": {
- "uuid": "81331c52-04c0-4656-a4a7-18c52669348f",
- "name": "connection_1"
}, - "changeLog": {
- "createdBy": "johnsmith",
- "createdByFullName": "John Smith",
- "createdByEmail": "john.smith@example.com",
- "createdDateTime": "2020-11-06T07:00:00Z",
- "updatedBy": "johnsmith",
- "updatedByFullName": "John Smith",
- "updatedByEmail": "john.smith@example.com",
- "updatedDateTime": "2020-11-06T07:00:00Z",
- "deletedBy": "johnsmith",
- "deletedByFullName": "John Smith",
- "deletedByEmail": "john.smith@example.com",
- "deletedDateTime": "2020-11-06T07:00:00Z"
}
}
]
}
The API provides capability to get list of user's Cloud Routers using search criteria, including optional filtering, pagination and sorting
object (CloudRouterFilters) | |||||||||||
| |||||||||||
object (PaginationRequest) Pagination request information | |||||||||||
| |||||||||||
Array of objects (CloudRouterSortCriteria) | |||||||||||
Array
|
object (Pagination) Pagination response information | |||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
Array of objects (CloudRouter) Data returned from the API call. | |||||||||||||||||||||||||||||||||
Array
|
{- "filter": {
- "and": [
- {
- "property": "/state",
- "operator": "=",
- "values": [
- "ACTIVE"
]
}
]
}, - "pagination": {
- "offset": 0,
- "limit": 20
}, - "sort": [
- {
- "direction": "DESC",
- "property": "/changeLog/createdDateTime"
}
]
}
{- "pagination": {
- "offset": 20,
- "limit": 20,
- "total": 100,
- "next": "/search?offset=40&limit=20",
- "previous": "/search?offset=0&limit=20"
}, - "data": [
- {
- "uuid": "201b7346-a9eb-42fe-ae7a-08148c71928d",
- "state": "PROVISIONED",
- "type": "XF_ROUTER",
- "name": "My-Cloud-Router",
- "equinixAsn": 30000,
- "package": {
- "code": "STANDARD"
}, - "order": {
- "purchaseOrderNumber": "1-129105284100"
}, - "project": {
- "projectId": "123456"
}, - "notifications": [
- {
- "type": "ALL",
- "emails": [
- "abc@abc.com"
]
}
], - "account": {
- "accountNumber": 123
}, - "connectionsCount": 0,
- "changeLog": {
- "createdBy": "abc@xyz.com",
- "createdByFullName": "abc",
- "createdByEmail": "abc@xyz.com",
- "createdDateTime": "2021-09-24T06:59:46Z",
- "updatedBy": "abc@xyz.com",
- "updatedByFullName": "abc",
- "updatedByEmail": "abc@xyz.com",
- "updatedDateTime": "2021-09-24T06:59:46Z",
- "deletedBy": "abc@xyz.com",
- "deletedByFullName": "abc",
- "deletedByEmail": "abc@xyz.com",
- "deletedDateTime": "2021-09-24T06:59:46Z"
}
}
]
}
This API provides capability to retrieve user's Cloud Routers Packages
offset | integer Example: offset=1 offset |
limit | integer Example: limit=10 number of records to fetch |
object (Pagination) Pagination response information | |||||||||||||||||||||||
| |||||||||||||||||||||||
Array of objects (CloudRouterPackage) Data returned from the API call. | |||||||||||||||||||||||
Array
|
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 4
}, - "data": [
- {
- "type": "ROUTER_PACKAGE",
- "code": "LAB",
- "description": "string",
- "totalIPv4RoutesMax": 50,
- "totalIPv6RoutesMax": 50,
- "routeFilterSupported": true,
- "vcCountMax": 10,
- "crCountMax": 3,
- "vcBandwidthMax": 50,
- "changeLog": {
- "createdDateTime": "2022-02-10T00:14:47Z",
- "updatedDateTime": "2022-02-10T00:14:47Z"
}
}, - {
- "type": "ROUTER_PACKAGE",
- "code": "STANDARD",
- "description": "string",
- "totalIPv4RoutesMax": 1000,
- "totalIPv6RoutesMax": 100,
- "routeFilterSupported": true,
- "vcCountMax": 10,
- "crCountMax": 3,
- "vcBandwidthMax": 10000,
- "changeLog": {
- "createdDateTime": "2023-02-10T00:14:47Z",
- "updatedDateTime": "2023-02-10T00:14:47Z"
}
}, - {
- "type": "ROUTER_PACKAGE",
- "code": "ADVANCED",
- "description": "string",
- "totalIPv4RoutesMax": 4000,
- "totalIPv6RoutesMax": 250,
- "routeFilterSupported": true,
- "vcCountMax": 99999,
- "crCountMax": 3,
- "vcBandwidthMax": 50000,
- "changeLog": {
- "createdDateTime": "2023-02-10T00:14:47Z",
- "updatedDateTime": "2023-02-10T00:14:47Z"
}
}, - {
- "type": "ROUTER_PACKAGE",
- "code": "PREMIUM",
- "description": "string",
- "totalIPv4RoutesMax": 10000,
- "totalIPv6RoutesMax": 500,
- "routeFilterSupported": true,
- "vcCountMax": 10,
- "crCountMax": 3,
- "vcBandwidthMax": 50000,
- "changeLog": {
- "createdDateTime": "2023-02-10T00:14:47Z",
- "updatedDateTime": "2023-02-10T00:14:47Z"
}
}
]
}
This API provides capability to retrieve user's Cloud Routers Package Details
routerPackageCode required | string (RouterPackageCode) Enum: "LAB" "BASIC" "STANDARD" "ADVANCED" "PREMIUM" Equinix-assigned Cloud Router package identifier |
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 | |||||
|
{- "type": "ROUTER_PACKAGE",
- "code": "LAB",
- "description": "string",
- "totalIPv4RoutesMax": 50,
- "totalIPv6RoutesMax": 50,
- "routeFilterSupported": true,
- "vcCountMax": 10,
- "crCountMax": 3,
- "vcBandwidthMax": 50,
- "changeLog": {
- "createdDateTime": "2020-11-06T07:00:00Z",
- "updatedDateTime": "2020-11-06T07:00:00Z"
}
}
This API provides capability to create user's virtual connection
dryRun | boolean Default: false option to verify that API calls will succeed |
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" Connection type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name required | string Customer-provided connection name | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Order) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | Array of objects (SimplifiedNotification) Preferences for notifications on connection configuration or status changes | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bandwidth required | integer [ 0 .. 100000 ] Connection bandwidth in Mbps | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
geoScope | string (GeoScopeType) Enum: "CANADA" "CONUS" "JAPAN" Geographic boundary types | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (ConnectionRedundancy) Connection redundancy configuration | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (ConnectionSideAdditionalInfo) Connection additional information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (marketplaceSubscription) Equinix Fabric Entity for Marketplace Subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (EndCustomer) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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" Connection type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
uuid | string Equinix-assigned connection identifier | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name required | string Customer-provided connection name | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string Customer-provided connection description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
state | string (ConnectionState) Enum: "ACTIVE" "CANCELLED" "DEPROVISIONED" "DEPROVISIONING" "DRAFT" "FAILED" "PENDING" "PROVISIONED" "PROVISIONING" "REPROVISIONING" "" Connection status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Change) Current state of latest connection change | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (ConnectionOperation) Connection type-specific operational data | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Order) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (SimplifiedNotification) Preferences for notifications on connection configuration or status changes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (SimplifiedAccount) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Changelog) Change log | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bandwidth required | integer [ 0 .. 10000 ] Connection bandwidth in Mbps | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
geoScope | string (GeoScopeType) Enum: "CANADA" "CONUS" "JAPAN" Geographic boundary types | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (ConnectionRedundancy) Connection redundancy configuration | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isRemote | boolean Connection property derived from access point locations | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
direction | string (ConnectionDirection) Enum: "INTERNAL" "INCOMING" "OUTGOING" Connection directionality from the requester point of view | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | object (ConnectionSide) Connection configuration object for each side of multi-segment connection | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | object (ConnectionSide) Connection configuration object for each side of multi-segment connection | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (marketplaceSubscription) Equinix Fabric Entity for Marketplace Subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (ConnectionSideAdditionalInfo) Connection additional information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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" Connection type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
uuid | string Equinix-assigned connection identifier | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name required | string Customer-provided connection name | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string Customer-provided connection description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
state | string (ConnectionState) Enum: "ACTIVE" "CANCELLED" "DEPROVISIONED" "DEPROVISIONING" "DRAFT" "FAILED" "PENDING" "PROVISIONED" "PROVISIONING" "REPROVISIONING" "" Connection status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Change) Current state of latest connection change | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (ConnectionOperation) Connection type-specific operational data | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Order) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (SimplifiedNotification) Preferences for notifications on connection configuration or status changes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (SimplifiedAccount) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Changelog) Change log | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bandwidth required | integer [ 0 .. 10000 ] Connection bandwidth in Mbps | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
geoScope | string (GeoScopeType) Enum: "CANADA" "CONUS" "JAPAN" Geographic boundary types | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (ConnectionRedundancy) Connection redundancy configuration | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isRemote | boolean Connection property derived from access point locations | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
direction | string (ConnectionDirection) Enum: "INTERNAL" "INCOMING" "OUTGOING" Connection directionality from the requester point of view | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | object (ConnectionSide) Connection configuration object for each side of multi-segment connection | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | object (ConnectionSide) Connection configuration object for each side of multi-segment connection | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (marketplaceSubscription) Equinix Fabric Entity for Marketplace Subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (ConnectionSideAdditionalInfo) Connection additional information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
{- "type": "EVPL_VC",
- "name": "My-Layer2-Connection-3",
- "bandwidth": 1000,
- "redundancy": {
- "priority": "PRIMARY"
}, - "aSide": {
- "accessPoint": {
- "type": "COLO",
- "port": {
- "uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee063"
}, - "linkProtocol": {
- "type": "DOT1Q",
- "vlanTag": 1001
}
}
}, - "order": {
- "purchaseOrderNumber": "po1234"
}, - "zSide": {
- "accessPoint": {
- "type": "COLO",
- "port": {
- "uuid": "a00cef6f-8e35-4794-9ff9-665e084e4e6d"
}, - "linkProtocol": {
- "type": "DOT1Q",
- "vlanTag": 1001
}
}
}, - "notifications": [
- {
- "type": "ALL",
- "emails": [
- "test@test.com"
]
}
]
}
{- "type": "EVPL_VC",
- "name": "Colo to AWS Connection",
- "bandwidth": 50,
- "redundancy": {
- "priority": "PRIMARY"
}, - "aSide": {
- "accessPoint": {
- "type": "COLO",
- "port": {
- "uuid": "2a4fb415-5a7f-436f-bae6-02f5e403deec"
}, - "linkProtocol": {
- "type": "DOT1Q",
- "vlanTag": 1137
}
}
}, - "zSide": {
- "accessPoint": {
- "type": "SP",
- "profile": {
- "type": "L2_PROFILE",
- "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f5"
}, - "sellerRegion": "us-west-1",
- "authenticationKey": "xxx-xxx-xxx"
}
}, - "project": {
- "projectId": "a347a370-39b5-427f-c330-7471a9abd9"
}, - "order": {
- "purchaseOrderNumber": "1-129105284100"
}, - "notifications": [
- {
- "type": "ALL",
- "emails": [
- "test@test.com"
]
}
]
}
The API provides capability to get user's virtual connection details (Service Tokens, Access Points, Link Protocols, etc) by it's connection ID (UUID)
connectionId required | string (ConnectionId) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Connection Id |
direction | string (ConnectionDirection) Enum: "INTERNAL" "INCOMING" "OUTGOING" Connection Direction |
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" Connection type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
uuid | string Equinix-assigned connection identifier | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name required | string Customer-provided connection name | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string Customer-provided connection description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
state | string (ConnectionState) Enum: "ACTIVE" "CANCELLED" "DEPROVISIONED" "DEPROVISIONING" "DRAFT" "FAILED" "PENDING" "PROVISIONED" "PROVISIONING" "REPROVISIONING" "" Connection status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Change) Current state of latest connection change | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (ConnectionOperation) Connection type-specific operational data | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Order) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (SimplifiedNotification) Preferences for notifications on connection configuration or status changes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (SimplifiedAccount) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Changelog) Change log | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bandwidth required | integer [ 0 .. 10000 ] Connection bandwidth in Mbps | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
geoScope | string (GeoScopeType) Enum: "CANADA" "CONUS" "JAPAN" Geographic boundary types | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (ConnectionRedundancy) Connection redundancy configuration | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isRemote | boolean Connection property derived from access point locations | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
direction | string (ConnectionDirection) Enum: "INTERNAL" "INCOMING" "OUTGOING" Connection directionality from the requester point of view | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | object (ConnectionSide) Connection configuration object for each side of multi-segment connection | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | object (ConnectionSide) Connection configuration object for each side of multi-segment connection | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (marketplaceSubscription) Equinix Fabric Entity for Marketplace Subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (ConnectionSideAdditionalInfo) Connection additional information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
{- "type": "EVPL_VC",
- "uuid": "462ad0bb-7fe2-41b1-8d1a-c62494e0c7e3",
- "name": "E2E-CON-280122031843987",
- "state": "DEPROVISIONED",
- "operation": {
- "providerStatus": "FAILED",
- "equinixStatus": "DEPROVISIONED"
}, - "order": {
- "purchaseOrderNumber": "PO608540135268"
}, - "notifications": [
- {
- "type": "ALL",
- "emails": [
- "fake@mail.com"
]
}
], - "account": {
- "accountNumber": 270001,
- "orgId": 91997,
- "globalOrgId": "0016u000003JZ4sAAG"
}, - "changeLog": {
- "createdBy": "testBuyer",
- "createdDateTime": "2022-01-28T03:18:48.908Z"
}, - "bandwidth": 50,
- "redundancy": {
- "group": "50ba51bb-085d-4084-ac38-c31860ca5f4d",
- "priority": "PRIMARY"
}, - "isRemote": false,
- "direction": "OUTGOING",
- "aSide": {
- "accessPoint": {
- "type": "COLO",
- "port": {
- "uuid": "c791f8cb-594b-94b0-8ce0-306a5c00a4ee",
- "name": "testBuyer-SV5-NL-Dot1q-BO-PRI-10G-NK-83"
}, - "linkProtocol": {
- "type": "DOT1Q",
- "vlanTag": 2628
}
}
}, - "zSide": {
- "accessPoint": {
- "type": "SP",
- "profile": {
- "type": "L2_PROFILE",
- "name": "Google Cloud Partner Interconnect Zone 1",
- "uuid": "063f4b0f-2d5b-4db7-95da-d9eddfc92602"
}, - "linkProtocol": {
- "type": "DOT1Q"
}, - "sellerRegion": "us-west1",
- "authenticationKey": "xx-xxx-xx-xxxxx/xxx/x"
}
}
}
Delete Connection by ID
connectionId required | string (VirtualCircuitId) Connection UUID |
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" Connection type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
uuid | string Equinix-assigned connection identifier | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name required | string Customer-provided connection name | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string Customer-provided connection description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
state | string (ConnectionState) Enum: "ACTIVE" "CANCELLED" "DEPROVISIONED" "DEPROVISIONING" "DRAFT" "FAILED" "PENDING" "PROVISIONED" "PROVISIONING" "REPROVISIONING" "" Connection status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Change) Current state of latest connection change | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (ConnectionOperation) Connection type-specific operational data | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Order) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (SimplifiedNotification) Preferences for notifications on connection configuration or status changes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (SimplifiedAccount) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Changelog) Change log | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bandwidth required | integer [ 0 .. 10000 ] Connection bandwidth in Mbps | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
geoScope | string (GeoScopeType) Enum: "CANADA" "CONUS" "JAPAN" Geographic boundary types | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (ConnectionRedundancy) Connection redundancy configuration | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isRemote | boolean Connection property derived from access point locations | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
direction | string (ConnectionDirection) Enum: "INTERNAL" "INCOMING" "OUTGOING" Connection directionality from the requester point of view | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | object (ConnectionSide) Connection configuration object for each side of multi-segment connection | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | object (ConnectionSide) Connection configuration object for each side of multi-segment connection | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (marketplaceSubscription) Equinix Fabric Entity for Marketplace Subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (ConnectionSideAdditionalInfo) Connection additional information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
{- "type": "EVPL_VC",
- "uuid": "3a58dd05-f46d-4b1d-a154-2e85c396ea62",
- "name": "My-Layer2-Connection",
- "order": {
- "purchaseOrderNumber": "1-129105284100",
- "billingTier": "Up to 200 MB /*Proposal*/"
}, - "bandwidth": 100,
- "aSide": {
- "accessPoint": {
- "type": "COLO",
- "port": {
- "type": "XF_PORT",
- "uuid": "a00cef6f-8e35-4794-9ff9-665e084e4e6d"
}, - "linkProtocol": {
- "type": "DOT1Q",
- "vlanTag": 1001
},
}
}, - "zSide": {
- "accessPoint": {
- "type": "SP",
- "profile": {
- "type": "L2_PROFILE",
- "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f5"
}, - "port": {
- "type": "XF_PORT",
- "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
}, - "linkProtocol": {
- "type": "QINQ",
- "vlanSTag": 1002,
- "vlanCTag": 1001
},
}
}, - "notifications": [
- {
- "type": "ALL",
- "emails": [
- "test@equinix.com",
- "test1@equinix.com"
]
}
], - "operation": {
- "equinixStatus": "DEPROVISIONING",
- "providerStatus": "DEPROVISIONING"
}, - "changeLog": {
- "createdDateTime": "2020-05-21T10:30:00Z",
- "updatedDateTime": "2020-05-21T10:30:00Z",
- "deletedDateTime": "2020-05-21T10:30:00Z",
- "createdBy": 232216,
- "updatedBy": 344339,
- "deletedBy": 232216
}
}
Update Connection by ID
connectionId required | string (ConnectionId) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Connection Id |
dryRun | boolean Default: false option to verify that API calls will succeed |
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 |
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" Connection type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
uuid | string Equinix-assigned connection identifier | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name required | string Customer-provided connection name | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string Customer-provided connection description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
state | string (ConnectionState) Enum: "ACTIVE" "CANCELLED" "DEPROVISIONED" "DEPROVISIONING" "DRAFT" "FAILED" "PENDING" "PROVISIONED" "PROVISIONING" "REPROVISIONING" "" Connection status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Change) Current state of latest connection change | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (ConnectionOperation) Connection type-specific operational data | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Order) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (SimplifiedNotification) Preferences for notifications on connection configuration or status changes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (SimplifiedAccount) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Changelog) Change log | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bandwidth required | integer [ 0 .. 10000 ] Connection bandwidth in Mbps | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
geoScope | string (GeoScopeType) Enum: "CANADA" "CONUS" "JAPAN" Geographic boundary types | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (ConnectionRedundancy) Connection redundancy configuration | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
isRemote | boolean Connection property derived from access point locations | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
direction | string (ConnectionDirection) Enum: "INTERNAL" "INCOMING" "OUTGOING" Connection directionality from the requester point of view | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | object (ConnectionSide) Connection configuration object for each side of multi-segment connection | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
required | object (ConnectionSide) Connection configuration object for each side of multi-segment connection | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (marketplaceSubscription) Equinix Fabric Entity for Marketplace Subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (ConnectionSideAdditionalInfo) Connection additional information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
[- {
- "op": "replace",
- "path": "/name",
- "value": "Conn-Name-2"
}
]
{- "type": "EVPL_VC",
- "uuid": "3a58dd05-f46d-4b1d-a154-2e85c396ea62",
- "name": "My-Layer2-Connection-2",
- "bandwidth": 1000,
- "direction": "OUTGOING",
- "isRemote": true,
- "redundancy": {
- "group": "66c10a60-789e-4b25-b85c-7eb225a4c344",
- "priority": "PRIMARY"
}, - "aSide": {
- "accessPoint": {
- "type": "COLO",
- "port": {
- "uuid": "a00cef6f-8e35-4794-9ff9-665e084e4e6d"
}, - "linkProtocol": {
- "type": "DOT1Q",
- "vlanTag": 1001
}
}
}, - "zSide": {
- "accessPoint": {
- "type": "SP",
- "profile": {
- "uuid": "22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c",
- "type": "L2_PROFILE"
}, - "linkProtocol": {
- "type": "DOT1Q",
- "vlanTag": 1001
}
}
}, - "operation": {
- "providerStatus": "PROVISIONED",
- "equinixStatus": "PROVISIONED"
}, - "change": {
- "type": "CONNECTION_UPDATE",
- "status": "APPROVED",
- "createdDateTime": "2021-12-12T06:00:01.183Z",
- "data": {
- "op": "replace",
- "path": "/aSide/accessPoint/port/uuid",
- "value": "c791f8cb-58f9-8f90-8ce0-306a5c00a4ee"
}
}, - "changeLog": {
- "createdDateTime": "2020-04-21T10:30:00Z"
}, - "account": {
- "accountNumber": 270001,
- "orgId": 91997,
- "globalOrgId": "3453453cccc"
}
}
This API provides capability to accept/reject user's virtual connection
connectionId required | string (ConnectionId) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Connection Id |
type required | string (Actions) Enum: "CONNECTION_CREATION_ACCEPTANCE" "CONNECTION_CREATION_REJECTION" "CONNECTION_UPDATE_ACCEPTANCE" "CONNECTION_UPDATE_REJECTION" "CONNECTION_DELETION_ACCEPTANCE" "CONNECTION_REJECTION_ACCEPTANCE" "CONNECTION_UPDATE_REQUEST" "MIGRATION_EVPL_VC" "CONNECTION_PROVIDER_STATUS_REQUEST" "CONNECTION_PROVIDER_BANDWIDTH_REQUEST" "ACCEPT_HOSTED_CONNECTION" "CANCEL_EVPL_VC_DRAFT_ORDERS" Connection action type | ||||||||||||||||
description | string Connection rejection reason detail | ||||||||||||||||
object (ConnectionAcceptanceData) Connection acceptance data | |||||||||||||||||
|
{- "type": "CONNECTION_CREATION_ACCEPTANCE",
- "data": {
- "zSide": {
- "accessPoint": {
- "type": "COLO",
- "port": {
- "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
}, - "linkProtocol": {
- "type": "QINQ",
- "vlanSTag": 1002,
- "vlanCTag": 1001
}
}
}
}
}
{- "type": "CONNECTION_CREATION_ACCEPTANCE",
- "uuid": "3a58dd05-f46d-4b1d-a154-2e85c396ea62",
- "data": {
- "zSide": {
- "accessPoint": {
- "type": "SP",
- "profile": {
- "uuid": "22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c",
- "type": "L2_PROFILE"
}, - "linkProtocol": {
- "type": "DOT1Q",
- "vlanTag": 1001
}
}
}
}, - "changeLog": {
- "createdDateTime": "2020-04-21T10:30:00Z",
- "updatedDateTime": "2020-05-21T10:30:00Z"
}
}
The API provides capability to get list of user's virtual connections using search criteria, including optional filtering, pagination and sorting
object (Expression) | |||||||||||
| |||||||||||
object (PaginationRequest) Pagination request information | |||||||||||
| |||||||||||
Array of objects (SortCriteria) | |||||||||||
Array
|
object (Pagination) Pagination response information | |||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||
Array of objects (SortCriteriaResponse) | |||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Connection) | |||||||||||||||||||||||||||||||||||||||||||||
Array
|
{- "filter": {
- "and": [
- {
- "property": "/direction",
- "operator": "=",
- "values": [
- "OUTGOING"
]
}
]
}, - "pagination": {
- "limit": 25,
- "offset": 0,
- "total": 0
}, - "sort": [
- {
- "property": "/changeLog/updatedDateTime",
- "direction": "DESC"
}
]
}
[- {
- "type": "EVPL_VC",
- "uuid": "3a58dd05-f46d-4b1d-a154-2e85c396ea62",
- "name": "My-Layer2-Connection",
- "bandwidth": 1000,
- "direction": "OUTGOING",
- "isRemote": true,
- "redundancy": {
- "priority": "PRIMARY",
- "group": "7cf39156-9dec-40f7-a254-9bb401342e83"
}, - "aSide": {
- "accessPoint": {
- "type": "COLO",
- "uuid": "b840a1db-5639-639f-97e0-328a5c00a874",
- "name": "exmapple-access-point-name-aside",
- "port": {
- "uuid": "a00cef6f-8e35-4794-9ff9-665e084e4e6d"
}
}, - "linkProtocol": {
- "type": "DOT1Q",
- "vlanTag": 1001
}
}, - "zSide": {
- "accessPoint": {
- "type": "SP",
- "uuid": "b840a1db-5639-639f-97e0-328a5c00a875",
- "name": "exmapple-access-point-name-zside",
- "profile": {
- "uuid": "22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c"
}, - "location": {
- "metroCode": "MX",
- "metroName": "Mexico City",
- "sellerRegion": "us-west-1"
}
}
}, - "routingProtocols": [
- {
- "type": "EBGP",
- "seqId": "03f7294b-42ce-42b6-9cc8-1e1b46d8183a",
- "state": "ACTIVE",
- "customerAsn": 65500,
- "providerAsn": 65000,
- "bgpAuthKey": "testAuthKey",
- "ipv4": {
- "customerPeerIp": "169.254.255.2/30",
- "providerPeerIp": "169.254.255.1/30"
}
}
], - "operation": {
- "providerStatus": "PROVISIONING",
- "equinixStatus": "PROVISIONED"
}, - "changeLog": {
- "createdDateTime": "2020-05-21T10:30:00Z",
- "updatedDateTime": "2020-05-21T10:30:00Z"
}, - "project": {
- "projectId": "2c10d60e-29c1-4721-ad1a-b531f4e04717"
}
}
]
This API provides capability to validate by auth key
object (ValidateRequest_filter) Filters | |||||||||||
|
Array of objects (ConnectionSideAdditionalInfo) Additional information | |||||||||||
Array
| |||||||||||
Array of objects (ValidateConnectionResponse) Connection response data | |||||||||||
Array
|
{- "filter": {
- "and": [
- {
- "property": "/zSide/accessPoint/authenticationKey",
- "operator": "=",
- "values": [
- "xxx-xxx-xxx"
]
}, - {
- "property": "/zSide/accessPoint/profile/uuid",
- "operator": "=",
- "values": [
- "xxx-xxx-xxx"
]
}, - {
- "property": "/zSide/accessPoint/sellerRegion",
- "operator": "=",
- "values": [
- "San Jose 2"
]
}
]
}
}
{- "additionalInfo": [
- {
- "key": "message",
- "value": "Authorization key provided is valid"
}
]
}
The deployment API is used to creates new deployment topologies. It allows users to define the properties of the deployment, including Fabric and CSP providers.
type required | string | ||||||||||||||||||||||||
name required | string | ||||||||||||||||||||||||
description | string | ||||||||||||||||||||||||
object (Deployment_topology) | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
required | Array of FabricProvider (object) or AWSProvider (object) or GCPProvider (object) (OrchestratorProviders) | ||||||||||||||||||||||||
Array One of
| |||||||||||||||||||||||||
required | object (Project) | ||||||||||||||||||||||||
| |||||||||||||||||||||||||
required | object (SimplifiedAccount) | ||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (Order) | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Array of objects (SimplifiedNotification) Preferences for notifications on deployement status changes | |||||||||||||||||||||||||
Array
|
href | string | ||||||||
uuid | string <uuid> | ||||||||
type | string | ||||||||
name | string | ||||||||
description | string | ||||||||
state | string | ||||||||
object (Deployment_topology) | |||||||||
| |||||||||
Array of FabricProviderResponse (object) or AWSProviderResponse (object) or GCPProviderResponse (object) (ProviderResponse) | |||||||||
Array One of
| |||||||||
Array of objects (SimplifiedNotification) Preferences for notifications on deployement status changes | |||||||||
Array
|
{- "type": "TOPOLOGY_DEPLOYMENT",
- "name": "MCN-Deployment",
- "description": "FCR and AWS DGW Deployment in DC",
- "topology": {
- "uuid": "3d4cfd38-5f56-4f71-b3e4-5f44631f1b2a"
}, - "providers": [
- {
- "type": "FABRIC_PROVIDER",
- "resources": [
- {
- "type": "XF_ROUTER",
- "name": "router-1",
- "location": {
- "metroCode": "DC"
}, - "package": {
- "code": "LAB"
}, - "deploymentProperties": {
- "elementId": "13fc5d30-036d-11f0-96a3-5336ee83f43f"
}
}, - {
- "type": "IP_VC",
- "bandwidth": 50,
- "name": "My connection to router",
- "redundancy": {
- "priority": "PRIMARY"
}, - "aSide": {
- "accessPoint": {
- "type": "CLOUD_ROUTER"
}
}, - "zSide": {
- "accessPoint": {
- "type": "SP",
- "profile": {
- "type": "L2_PROFILE",
- "uuid": "22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c"
}, - "location": {
- "metroCode": "DC"
}, - "sellerRegion": "us-east-1",
- "authenticationKey": 12345678923
}
}, - "deploymentProperties": {
- "elementId": "adbad8be-10d7-42d5-ab85-066d1c8a8259",
- "dependsOn": [
- "13fc5d30-036d-11f0-96a3-5336ee83f43f"
]
}
}, - {
- "type": "BGP",
- "bgpIpv4": {
- "equinixip": "192.168.100.1/30",
- "customerip": "192.168.100.2",
- "enabled": true,
- "bgpAuthKey": "xxxxxxx",
- "customerAsn": 65333
}, - "asOverrideEnabled": true,
- "deploymentProperties": {
- "elementId": "3184e34a-69ba-4821-aa54-1e66a8a6672e",
- "dependsOn": [
- "adbad8be-10d7-42d5-ab85-066d1c8a8259"
]
}
}
]
}, - {
- "type": "AWS_PROVIDER",
- "resources": [
- {
- "type": "PERMISSION",
- "roleArn": "arn:aws:iam::<account-id>:role/<role-name>",
- "region": "us-east-1",
- "deploymentProperties": {
- "elementId": "c2a3d2ec-265a-41af-b72d-fded5a371f48",
- "dependsOn": [
- "adbad8be-10d7-42d5-ab85-066d1c8a8259"
]
}
}, - {
- "type": "DIRECT_CONNECT",
- "uuid": "c3af0941-b4e1-45d3-b961-8fc50768fcfb",
- "deploymentProperties": {
- "elementId": "c2a3d2ec-265a-41af-b72d-fded5a371f46",
- "dependsOn": [
- "adbad8be-10d7-42d5-ab85-066d1c8a8259",
- "c2a3d2ec-265a-41af-b72d-fded5a371f48"
]
}
}, - {
- "type": "VIRTUAL_PRIVATE_GATEWAY",
- "required": "true/false",
- "vpcId": "c0c68cc5-6e7f-43d3-a322-afdac89038d7",
- "subnetId": "c3af0941-b4e1-45d3-b961-8fc50768fcfb",
- "deploymentProperties": {
- "elementId": "c2a3d2ec-265a-41af-b72d-fded5a371f45",
- "dependsOn": [
- "adbad8be-10d7-42d5-ab85-066d1c8a8259",
- "c2a3d2ec-265a-41af-b72d-fded5a371f48"
]
}
}
]
}
], - "project": {
- "projectId": "ad444dd7-1144-47db-bacc-bab4d313222d"
}, - "account": {
- "accountNumber": 346346456
}, - "order": {
- "purchaseNumber": "PO345346534563"
}, - "notifications": [
- {
- "type": "ALL",
- "emails": [
- "test@test.com"
]
}
]
}
{- "type": "TOPOLOGY_DEPLOYMENT",
- "uuid": "8c9dfc8d-b32b-44a4-aa2e-e3dcc3c7fdac",
- "name": "MCN-Deployment",
- "state": "PENDING",
- "description": "FCR and AWS DGW Deployment in DC",
- "topology": {
- "uuid": "3d4cfd38-5f56-4f71-b3e4-5f44631f1b2a"
}, - "providers": [
- {
- "type": "FABRIC_PROVIDER",
- "resources": [
- {
- "type": "XF_ROUTER",
- "uuid": "1479d681-a7f5-4ea9-9495-9f54c4ca2ec4",
- "deploymentProperties": {
- "elementId": "13fc5d30-036d-11f0-96a3-5336ee83f43f"
}
}, - {
- "type": "IP_VC",
- "uuid": "21d5251c-8142-45b7-b566-76ae345d81ee",
- "bandwidth": 50,
- "state": "PROVISIONING",
- "name": "My connection to router",
- "redundancy": {
- "priority": "PRIMARY"
}, - "aSide": {
- "accessPoint": {
- "type": "CLOUD_ROUTER"
}
}, - "zSide": {
- "accessPoint": {
- "type": "SP",
- "profile": {
- "type": "L2_PROFILE",
- "uuid": "22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c"
}, - "location": {
- "metroCode": "DC"
}, - "sellerRegion": "us-east-1",
- "authenticationKey": 12345678923
}
}, - "deploymentProperties": {
- "elementId": "adbad8be-10d7-42d5-ab85-066d1c8a8259",
- "dependsOn": [
- "13fc5d30-036d-11f0-96a3-5336ee83f43f"
]
}
}, - {
- "type": "BGP",
- "bgpIpv4": {
- "equinixip": "192.168.100.1/30",
- "customerip": "192.168.100.2",
- "enabled": true,
- "bgpAuthKey": "xxxxxxx",
- "customerAsn": 65333
}, - "asOverrideEnabled": true,
- "deploymentProperties": {
- "elementId": "3184e34a-69ba-4821-aa54-1e66a8a6672e",
- "dependsOn": [
- "e40def8d-b067-4a94-8a67-e6caa5fa41b3"
]
}
}
]
}, - {
- "type": "AWS_PROVIDER",
- "resources": [
- {
- "type": "PERMISSION",
- "roleArn": "arn:aws:iam::<account-id>:role/<role-name>",
- "region": "us-east-1",
- "deploymentProperties": {
- "elementId": "c2a3d2ec-265a-41af-b72d-fded5a371f48",
- "dependsOn": [
- "adbad8be-10d7-42d5-ab85-066d1c8a8259"
]
}
}, - {
- "type": "DIRECT_CONNECT",
- "uuid": "c3af0941-b4e1-45d3-b961-8fc50768fcfb",
- "deploymentProperties": {
- "elementId": "c2a3d2ec-265a-41af-b72d-fded5a371f46",
- "dependsOn": [
- "adbad8be-10d7-42d5-ab85-066d1c8a8259",
- "c2a3d2ec-265a-41af-b72d-fded5a371f48"
]
}
}, - {
- "type": "VIRTUAL_PRIVATE_GATEWAY",
- "required": true,
- "vpcId": "c0c68cc5-6e7f-43d3-a322-afdac89038d7",
- "subnetId": "c3af0941-b4e1-45d3-b961-8fc50768fcfb",
- "deploymentProperties": {
- "elementId": "c2a3d2ec-265a-41af-b72d-fded5a371f45",
- "dependsOn": [
- "adbad8be-10d7-42d5-ab85-066d1c8a8259",
- "c2a3d2ec-265a-41af-b72d-fded5a371f48"
]
}
}
]
}
], - "project": {
- "projectId": "ad444dd7-1144-47db-bacc-bab4d313222d"
}, - "account": {
- "accountNumber": 346346456
}, - "order": {
- "purchaseNumber": "PO345346534563"
}, - "notifications": [
- {
- "type": "ALL",
- "emails": [
- "test@test.com"
]
}
]
}
This API provides capability to retrieve user's deployment details.
deploymentId required | string <uuid> (DeploymentId) Example: 6658cc3b-18e0-437c-b972-62b51a419a1e Deployment UUID |
href | string | ||||||||
uuid | string <uuid> | ||||||||
type | string | ||||||||
name | string | ||||||||
description | string | ||||||||
state | string | ||||||||
object (Deployment_topology) | |||||||||
| |||||||||
Array of FabricProviderResponse (object) or AWSProviderResponse (object) or GCPProviderResponse (object) (ProviderResponse) | |||||||||
Array One of
| |||||||||
Array of objects (SimplifiedNotification) Preferences for notifications on deployement status changes | |||||||||
Array
|
{- "type": "TOPOLOGY_DEPLOYMENT",
- "uuid": "8c9dfc8d-b32b-44a4-aa2e-e3dcc3c7fdac",
- "name": "MCN-Deployment",
- "state": "PROVISIONED",
- "description": "FCR and AWS DGW Deployment in DC",
- "providers": [
- {
- "type": "FABRIC_PROVIDER",
- "resources": [
- {
- "type": "XF_ROUTER",
- "uuid": "1479d681-a7f5-4ea9-9495-9f54c4ca2ec4",
- "deploymentProperties": {
- "elementId": "13fc5d30-036d-11f0-96a3-5336ee83f43f",
- "dependsOn": [ ]
}
}, - {
- "type": "IP_VC",
- "uuid": "21d5251c-8142-45b7-b566-76ae345d81ee",
- "bandwidth": 50,
- "state": "PROVISIONING",
- "name": "My connection to router",
- "redundancy": {
- "priority": "PRIMARY"
}, - "aSide": {
- "accessPoint": {
- "type": "CLOUD_ROUTER"
}
}, - "zSide": {
- "accessPoint": {
- "type": "SP",
- "profile": {
- "type": "L2_PROFILE",
- "uuid": "22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c"
}, - "location": {
- "metroCode": "DC"
}, - "sellerRegion": "us-east-1",
- "authenticationKey": 12345678923
}
}, - "deploymentProperties": {
- "elementId": "adbad8be-10d7-42d5-ab85-066d1c8a8259",
- "dependsOn": [
- "13fc5d30-036d-11f0-96a3-5336ee83f43f"
]
}
}, - {
- "type": "BGP",
- "bgpIpv4": {
- "equinixip": "192.168.100.1/30",
- "customerip": "192.168.100.2",
- "enabled": true,
- "bgpAuthKey": "xxxxxxx",
- "customerAsn": 65333
}, - "asOverrideEnabled": true,
- "deploymentProperties": {
- "elementId": "3184e34a-69ba-4821-aa54-1e66a8a6672e",
- "dependsOn": [
- "e40def8d-b067-4a94-8a67-e6caa5fa41b3"
]
}
}
]
}, - {
- "type": "AWS_PROVIDER",
- "resources": [
- {
- "type": "PERMISSION",
- "roleArn": "arn:aws:iam::<account-id>:role/<role-name>",
- "region": "us-east-1",
- "deploymentProperties": {
- "elementId": "c2a3d2ec-265a-41af-b72d-fded5a371f48",
- "dependsOn": [
- "adbad8be-10d7-42d5-ab85-066d1c8a8259"
]
}
}, - {
- "type": "DIRECT_CONNECT",
- "uuid": "c3af0941-b4e1-45d3-b961-8fc50768fcfb",
- "deploymentProperties": {
- "elementId": "c2a3d2ec-265a-41af-b72d-fded5a371f46",
- "dependsOn": [
- "adbad8be-10d7-42d5-ab85-066d1c8a8259",
- "c2a3d2ec-265a-41af-b72d-fded5a371f48"
]
}
}, - {
- "type": "VIRTUAL_PRIVATE_GATEWAY",
- "required": true,
- "vpcId": "c0c68cc5-6e7f-43d3-a322-afdac89038d7",
- "subnetId": "c3af0941-b4e1-45d3-b961-8fc50768fcfb",
- "deploymentProperties": {
- "elementId": "c2a3d2ec-265a-41af-b72d-fded5a371f45",
- "dependsOn": [
- "adbad8be-10d7-42d5-ab85-066d1c8a8259",
- "c2a3d2ec-265a-41af-b72d-fded5a371f48"
]
}
}
]
}
], - "project": {
- "projectId": "ad444dd7-1144-47db-bacc-bab4d313222d"
}, - "account": {
- "accountNumber": 346346456
}, - "order": {
- "purchaseNumber": "PO345346534563"
}, - "notifications": [
- {
- "type": "ALL",
- "emails": [
- "test@test.com"
]
}
]
}
This API provides capability to delete user's deployment
deploymentId required | string <uuid> (DeploymentId) Example: 6658cc3b-18e0-437c-b972-62b51a419a1e Deployment UUID |
href | string | ||||||||
uuid | string <uuid> | ||||||||
type | string | ||||||||
name | string | ||||||||
description | string | ||||||||
state | string | ||||||||
object (Deployment_topology) | |||||||||
| |||||||||
Array of FabricProviderResponse (object) or AWSProviderResponse (object) or GCPProviderResponse (object) (ProviderResponse) | |||||||||
Array One of
| |||||||||
Array of objects (SimplifiedNotification) Preferences for notifications on deployement status changes | |||||||||
Array
|
{- "href": "/fabric/v4/deployments/d3d51d91-7688-446b-aa08-d1cb6a5ca393",
- "uuid": "d3d51d91-7688-446b-aa08-d1cb6a5ca393",
- "type": "TOPOLOGY_DEPLOYMENT",
- "name": "MCN-Deployment",
- "description": "FCR and AWS DG Deployment in DC",
- "state": "NOT_STARTED",
- "topology": {
- "uuid": "3d4cfd38-5f56-4f71-b3e4-5f44631f1b2a"
}, - "providers": [
- {
- "type": "FABRIC_PROVIDER",
- "resources": [
- {
- "type": "XF_ROUTER",
- "uuid": "3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
- "state": "DEPLOYED",
- "name": "router-1",
- "location": {
- "region": "AMER, APAC, EMEA",
- "metroName": "Amsterdam",
- "metroCode": "AM"
}, - "package": {
- "type": "ROUTER_PACKAGE",
- "code": "LAB"
}, - "deploymentProperties": {
- "elementId": "13fc5d30-036d-11f0-96a3-5336ee83f43f",
- "dependsOn": [
- "686fd746-78b6-42fb-8496-be6887814430"
]
}
}
]
}
], - "notifications": [
- {
- "type": "BANDWIDTH_ALERT",
- "sendInterval": "string",
- "emails": [
- "user@example.com"
], - "registeredUsers": [
- "string"
]
}
]
}
The deployment action is used to deploy, dry run or destroy a deployment. The request body must contain the type of action to be performed and the connection details. The response will contain the status of the action.
deploymentId required | string <uuid> (DeploymentId) Example: 6658cc3b-18e0-437c-b972-62b51a419a1e Deployment UUID |
type required | string (DeploymentActionType) Enum: "DEPLOY" "DRY_RUN" "DESTROY" Deployment action type | ||||||||
required | Array of objects (ActionRequest) | ||||||||
Array
|
{- "type": "DEPLOY",
- "data": [
- {
- "type": "PERMISSION",
- "roleArn": "arn:aws:iam::<account-id>:role/<role-name>",
- "region": "us-east-1",
- "deploymentProperties": {
- "elementId": "c2a3d2ec-265a-41af-b72d-fded5a371f48",
- "dependsOn": [
- "adbad8be-10d7-42d5-ab85-066d1c8a8259"
]
}
}
]
}
{- "type": "ROUTE_TABLE_ENTRY_UPDATE",
- "uuid": "37c10edc-ba2e-4240-a850-8a48f9c47d00",
- "state": "PENDING",
- "changeLog": {
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}
The API provides capability to get list of user's deployment using search criteria.
object (DeploymentExpression) | |||||||||||||||||||||
|
Array of objects (DeploymentResponse) | |||||||||||||||||||
Array
|
{- "filter": {
- "and": [
- {
- "property": "/project/projectId",
- "operator": "=",
- "values": [
- "7a1228ee-91f7-462f-8f87-c8c01849bd47"
]
}
], - "or": [
- {
- "property": "/project/projectId",
- "operator": "=",
- "values": [
- "7a1228ee-91f7-462f-8f87-c8c01849bd47"
]
}
]
}
}
{- "data": [
- {
- "href": "/fabric/v4/deployments/d3d51d91-7688-446b-aa08-d1cb6a5ca393",
- "uuid": "d3d51d91-7688-446b-aa08-d1cb6a5ca393",
- "type": "TOPOLOGY_DEPLOYMENT",
- "name": "MCN-Deployment",
- "description": "FCR and AWS DG Deployment in DC",
- "state": "NOT_STARTED",
- "topology": {
- "uuid": "3d4cfd38-5f56-4f71-b3e4-5f44631f1b2a"
}, - "providers": [
- {
- "type": "FABRIC_PROVIDER",
- "resources": [
- {
- "type": "XF_ROUTER",
- "uuid": "3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
- "state": "DEPLOYED",
- "name": "router-1",
- "location": {
- "region": "AMER, APAC, EMEA",
- "metroName": "Amsterdam",
- "metroCode": "AM"
}, - "package": {
- "type": "ROUTER_PACKAGE",
- "code": "LAB"
}, - "deploymentProperties": {
- "elementId": "13fc5d30-036d-11f0-96a3-5336ee83f43f",
- "dependsOn": [
- "686fd746-78b6-42fb-8496-be6887814430"
]
}
}
]
}
], - "notifications": [
- {
- "type": "BANDWIDTH_ALERT",
- "sendInterval": "string",
- "emails": [
- "user@example.com"
], - "registeredUsers": [
- "string"
]
}
]
}
]
}
The API provides capability to get list of user's provider resources using search criteria, including optional filtering
object (ProviderExpression) | |||||||||||||||||||||
|
type | string (ProviderType) Enum: "AWS_PROVIDER" "GCP_PROVIDER" Deployment action type | ||||||||
Array of objects (ProvidersSearchResponse) | |||||||||
Array
|
{- "filter": {
- "and": [
- {
- "property": "/providers/type",
- "operator": "=",
- "values": [
- "AWS_PROVIDER"
]
}, - {
- "property": "/providers/oidcCredentials/roleArn",
- "operator": "=",
- "values": [
- "arn:aws:iam::<account-id>:role/<role-name>"
]
}, - {
- "property": "/providers/oidcCredentials/region",
- "operator": "=",
- "values": [
- "us-east-1"
]
}, - {
- "property": "/providers/resources/type",
- "operator": "=",
- "values": [
- "DIRECT_CONNECT",
- "VPC",
- "SUBNET"
]
}
]
}
}
{- "type": "AWS_PROVIDER",
- "data": [
- {
- "type": "VPC",
- "name": "my_aws_vpc",
- "id": "vpc-09ac9040cd1a54aa7",
- "state": "Available"
}
]
}
This API provides capability to retrieve Metrics of an asset id
asset required | string (MetricAssetType) Enum: "ports" "connections" "routers" asset |
assetId required | string <uuid> (AssetId) Example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 asset UUID |
fromDateTime | string <date-time> (StartDateTime) Example: fromDateTime=2024-07-11T18:06:21Z Start date and time |
toDateTime | string <date-time> (EndDateTime) Example: toDateTime=2024-07-11T18:06:21Z End date and time |
offset | integer (Offset) Default: 0 Example: offset=0 offset |
limit | integer (Limit) Default: 20 Example: limit=20 limit |
object (Pagination) Pagination response information | |||||||||||||
| |||||||||||||
Array of objects (Metric) Data returned from the API call. | |||||||||||||
Array
|
{- "pagination": {
- "offset": 0,
- "limit": 10,
- "total": 2,
- "next": null,
- "previous": null
}, - "data": [
- {
- "type": "GAUGE",
- "name": "equinix.fabric.port.bandwidth_rx.usage",
- "unit": "bit/s",
- "resource": {
- "uuid": "0689734d-25c6-40d1-a9ff-3e4edea07a72"
}, - "summary": {
- "mean": 102.15384615384616,
- "max": 107
}, - "datapoints": [
- {
- "endDateTime": "2025-05-14T13:57:56.000Z",
- "value": 107
}, - {
- "endDateTime": "2025-05-14T14:02:48.000Z",
- "value": 97
}, - {
- "endDateTime": "2025-05-14T14:07:58.000Z",
- "value": 105
}, - {
- "endDateTime": "2025-05-14T14:12:36.000Z",
- "value": 102
}, - {
- "endDateTime": "2025-05-14T14:18:00.000Z",
- "value": 96
}, - {
- "endDateTime": "2025-05-14T14:23:03.000Z",
- "value": 106
}, - {
- "endDateTime": "2025-05-14T14:27:59.000Z",
- "value": 104
}, - {
- "endDateTime": "2025-05-14T14:32:56.000Z",
- "value": 104
}, - {
- "endDateTime": "2025-05-14T14:37:51.000Z",
- "value": 103
}, - {
- "endDateTime": "2025-05-14T14:42:59.000Z",
- "value": 100
}, - {
- "endDateTime": "2025-05-14T14:47:58.000Z",
- "value": 105
}, - {
- "endDateTime": "2025-05-14T14:53:08.000Z",
- "value": 94
}, - {
- "endDateTime": "2025-05-14T14:57:46.000Z",
- "value": 105
}
]
}, - {
- "type": "GAUGE",
- "name": "equinix.fabric.port.bandwidth_tx.usage",
- "unit": "bit/s",
- "resource": {
- "uuid": "0689734d-25c6-40d1-a9ff-3e4edea07a72"
}, - "summary": {
- "mean": 255.92307692307693,
- "max": 295
}, - "datapoints": [
- {
- "endDateTime": "2025-05-14T13:57:56.000Z",
- "value": 259
}, - {
- "endDateTime": "2025-05-14T14:02:48.000Z",
- "value": 234
}, - {
- "endDateTime": "2025-05-14T14:07:58.000Z",
- "value": 242
}, - {
- "endDateTime": "2025-05-14T14:12:36.000Z",
- "value": 280
}, - {
- "endDateTime": "2025-05-14T14:18:00.000Z",
- "value": 243
}, - {
- "endDateTime": "2025-05-14T14:23:03.000Z",
- "value": 262
}, - {
- "endDateTime": "2025-05-14T14:27:59.000Z",
- "value": 247
}, - {
- "endDateTime": "2025-05-14T14:32:56.000Z",
- "value": 295
}, - {
- "endDateTime": "2025-05-14T14:37:51.000Z",
- "value": 284
}, - {
- "endDateTime": "2025-05-14T14:42:59.000Z",
- "value": 227
}, - {
- "endDateTime": "2025-05-14T14:47:58.000Z",
- "value": 260
}, - {
- "endDateTime": "2025-05-14T14:53:08.000Z",
- "value": 251
}, - {
- "endDateTime": "2025-05-14T14:57:46.000Z",
- "value": 243
}
]
}
]
}
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.
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 |
object (Pagination) Pagination response information | |||||||||||||||||||||||
| |||||||||||||||||||||||
Array of objects (Metro) List of Fabric Metros. | |||||||||||||||||||||||
Array
|
{- "pagination": {
- "offset": 0,
- "limit": 75,
- "total": 1
}, - "data": [
- {
- "type": "XF_METRO",
- "code": "AM",
- "name": "Amsterdam",
- "region": "EMEA",
- "equinixAsn": 60000,
- "localVCBandwidthMax": 10000,
- "geoCoordinates": {
- "latitude": 52.30049,
- "longitude": 4.942603
}, - "connectedMetros": [
- {
- "code": "MX",
- "avgLatency": 132,
- "remoteVCBandwidthMax": 10000
}, - {
- "code": "HH",
- "avgLatency": 8.62,
- "remoteVCBandwidthMax": 10000
}, - {
- "code": "SL",
- "avgLatency": 229,
- "remoteVCBandwidthMax": 10000
}, - {
- "code": "SO",
- "avgLatency": 36.3,
- "remoteVCBandwidthMax": 50000
}, - {
- "code": "IL",
- "avgLatency": 44.8,
- "remoteVCBandwidthMax": 50000
}, - {
- "code": "LS",
- "avgLatency": 36.6,
- "remoteVCBandwidthMax": 50000
}, - {
- "code": "BA",
- "avgLatency": 32.6,
- "remoteVCBandwidthMax": 50000
}, - {
- "code": "BL",
- "avgLatency": 3.28,
- "remoteVCBandwidthMax": 50000
}, - {
- "code": "GV",
- "avgLatency": 15.3,
- "remoteVCBandwidthMax": 50000
}, - {
- "code": "LD",
- "avgLatency": 5.85,
- "remoteVCBandwidthMax": 50000
}
], - "services": [
- {
- "type": "ETHERNET_IP_SERVICE"
}, - {
- "type": "TIME_SERVICE"
}
]
}
]
}
GET Metros retrieves all Equinix Fabric metros, as well as latency data between each metro location.
metroCode required | string (MetroCode) Metro Code |
href | string The Canonical URL at which the resource resides. | ||||||||
type | string Indicator of a Fabric Metro | ||||||||
code | string Code Assigned to an Equinix IBX data center in a specified metropolitan area. | ||||||||
region | string Board geographic area in which the data center is located | ||||||||
name | string Name of the region in which the data center is located. | ||||||||
equinixAsn | integer <int64> Autonomous system number (ASN) for a specified Fabric metro. The ASN is a unique identifier that carries the network routing protocol and exchanges that data with other internal systems via border gateway protocol. | ||||||||
localVCBandwidthMax | integer <int64> This field holds Max Connection speed with in the metro | ||||||||
object (GeoCoordinates) Geographic location data of Fabric Metro | |||||||||
| |||||||||
Array of objects (ConnectedMetro) | |||||||||
Array
| |||||||||
Array of objects (services) | |||||||||
Array
| |||||||||
geoScopes | Array of strings (GeoScopeType) Items Enum: "CANADA" "CONUS" "JAPAN" List of supported geographic boundaries of a Fabric Metro. |
{- "type": "XF_METRO",
- "code": "AM",
- "region": "EMEA",
- "name": "Amsterdam",
- "equinixAsn": 60000,
- "localVCBandwidthMax": 50000,
- "geoCoordinates": {
- "latitude": 52.30049,
- "longitude": 4.942603
}, - "connectedMetros": [
- {
- "code": "MX",
- "avgLatency": 132,
- "remoteVCBandwidthMax": 50000
}, - {
- "code": "HH",
- "avgLatency": 8.62,
- "remoteVCBandwidthMax": 50000
}, - {
- "code": "SL",
- "avgLatency": 229,
- "remoteVCBandwidthMax": 50000
}, - {
- "code": "SO",
- "avgLatency": 36.3,
- "remoteVCBandwidthMax": 10000
}, - {
- "code": "IL",
- "avgLatency": 44.8,
- "remoteVCBandwidthMax": 10000
}, - {
- "code": "LS",
- "avgLatency": 36.6,
- "remoteVCBandwidthMax": 10000
}, - {
- "code": "BA",
- "avgLatency": 32.6,
- "remoteVCBandwidthMax": 10000
}, - {
- "code": "BL",
- "avgLatency": 3.28,
- "remoteVCBandwidthMax": 10000
}, - {
- "code": "GV",
- "avgLatency": 15.3,
- "remoteVCBandwidthMax": 10000
}, - {
- "code": "LD",
- "avgLatency": 5.85,
- "remoteVCBandwidthMax": 10000
}
], - "services": [
- {
- "type": "ETHERNET_IP_SERVICE"
}, - {
- "type": "TIME_SERVICE"
}
]
}
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.
name | string port name to be provided if specific port(s) to be retrieved |
object (Pagination) Pagination response information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Port) GET All User Port Across Fabric Metros | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
|
{- "pagination": {
- "offset": 0,
- "limit": 5,
- "total": 1
}, - "data": [
- {
- "type": "XF_PORT",
- "uuid": "e91484bb-4f65-4ab3-8f77-500dec2f855d",
- "name": "test-AT1-Dot1q-L-Secondary-108608",
- "state": "ACTIVE",
- "bandwidth": 10000,
- "usedBandwidth": 0,
- "availableBandwidth": 20000,
- "physicalPortSpeed": 10000,
- "redundancy": {
- "priority": "SECONDARY"
}, - "location": {
- "ibx": "AT1",
- "metroCode": "AT",
- "metroName": "Atlanta",
- "region": "AMER"
}, - "device": {
- "name": "dev-m7a2.lab",
- "redundancy": {
- "group": "1",
- "priority": "SECONDARY"
}
}, - "encapsulation": {
- "type": "DOT1Q",
- "tagProtocolId": 33024
}, - "lagEnabled": true,
- "package": {
- "code": "STANDARD",
- "type": "MSP"
}, - "settings": {
- "buyout": false,
- "placeVcOrderPermission": true,
- "viewPortPermission": true
}, - "physicalPorts": [
- {
- "state": "ACTIVE",
- "type": "XF_PHYSICAL_PORT",
- "id": 6967,
- "bandwidth": 10000,
- "tether": {
- "crossConnectId": "100179-A",
- "patchPanel": "PP:956:66107",
- "patchPanelPortA": "5",
- "patchPanelPortB": "42"
}, - "operation": {
- "operationalStatus": "UP"
}
}, - {
- "state": "ACTIVE",
- "type": "XF_PHYSICAL_PORT",
- "id": 6968,
- "bandwidth": 10000,
- "tether": {
- "crossConnectId": "100179-A",
- "patchPanel": "PP:8118:1586",
- "patchPanelPortA": "92",
- "patchPanelPortB": "24"
}, - "operation": {
- "operationalStatus": "UP"
}, - "demarcationPoint": {
- "ibx": "AT1",
- "patchPanel": "PP:8118:1586",
- "patchPanelName": "PP:8118:1586",
- "patchPanelPortA": "92",
- "patchPanelPortB": "24"
}
}
], - "operation": {
- "operationalStatus": "UP",
- "opStatusChangedAt": "2021-06-14T17:21:25.586Z",
- "connectionCount": 0,
- "evplVcCount": 0,
- "fgVcCount": 0,
- "accessVcCount": 0
}, - "account": {
- "accountNumber": 100179,
- "accountName": "L2",
- "globalCustId": "007700000090982RG8",
- "orgId": 100179,
- "organizationName": "Cust_Org_100179"
}, - "order": {
- "purchaseOrder": {
- "startDate": "2020-06-14T17:21:25.586Z",
- "endDate": "2020-06-15T17:21:25.586Z",
- "type": "NEW"
}, - "orderNumber": "1-222078525611"
}, - "changeLog": {
- "createdDateTime": "2020-06-14T17:21:25.586Z"
}, - "project": {
- "projectId": "8f23b36f-db8f-44c8-a6e5-606e1b485931"
}
}
]
}
Creates Equinix Fabric? Port.
type required | string (PortType) Enum: "XF_PORT" "IX_PORT" "IA_PORT" Type of Port | ||||||||||||||||||||||||||||||||||
id | integer Equinix assigned response attribute for Port Id | ||||||||||||||||||||||||||||||||||
uuid | string <uuid> Equinix assigned response attribute for port identifier | ||||||||||||||||||||||||||||||||||
name | string Equinix assigned response attribute for Port name | ||||||||||||||||||||||||||||||||||
description | string Equinix assigned response attribute for Port description | ||||||||||||||||||||||||||||||||||
physicalPortsSpeed required | integer >= 0 Physical Ports Speed in Mbps | ||||||||||||||||||||||||||||||||||
connectionsCount | integer >= 0 Equinix assigned response attribute for Connection count | ||||||||||||||||||||||||||||||||||
physicalPortsType required | string Enum: "1000BASE_LX" "10GBASE_LR" "100GBASE_LR4" "10GBASE_ER" "1000BASE_SX" Physical Ports Type | ||||||||||||||||||||||||||||||||||
physicalPortsCount | integer | ||||||||||||||||||||||||||||||||||
connectivitySourceType required | string Enum: "COLO" "BMMR" "REMOTE" Port connectivity type | ||||||||||||||||||||||||||||||||||
bmmrType | string Enum: "SELF" "EQUINIX" | ||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
state | string (PortState) Enum: "PENDING" "PROVISIONING" "REPROVISIONING" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED" Port lifecycle state | ||||||||||||||||||||||||||||||||||
object (PortOrder) | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
object Operational specifications for ports. | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
required | object (SimplifiedAccount) | ||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
object (PortChange) Current state of latest port change | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
object (Changelog) Change log | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
serviceType | string Deprecated Enum: "EPL" "MSP" Port service Type | ||||||||||||||||||||||||||||||||||
bandwidth | integer >= 0 Deprecated Equinix assigned response attribute for Port bandwidth in Mbps | ||||||||||||||||||||||||||||||||||
availableBandwidth | integer >= 0 Equinix assigned response attribute for Port available bandwidth in Mbps | ||||||||||||||||||||||||||||||||||
usedBandwidth | integer >= 0 Equinix assigned response attribute for Port used bandwidth in Mbps | ||||||||||||||||||||||||||||||||||
required | object (SimplifiedLocation) | ||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
object (PortDevice) Port device | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
object (PortInterface) Port interface | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
demarcationPointIbx | string A-side/Equinix ibx | ||||||||||||||||||||||||||||||||||
tetherIbx | string z-side/Equinix ibx | ||||||||||||||||||||||||||||||||||
object (PortDemarcationPoint) Customer physical Port | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
object (PortRedundancy) Port redundancy configuration | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
required | object (PortEncapsulation) Port encapsulation configuration | ||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
lagEnabled | boolean If LAG enabled | ||||||||||||||||||||||||||||||||||
object Port Lag | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
asn | integer Port ASN | ||||||||||||||||||||||||||||||||||
object (Package) Package settings for port | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
required | object (PortSettings) Port configuration settings | ||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
physicalPortQuantity | integer Number of physical ports | ||||||||||||||||||||||||||||||||||
Array of objects (PortNotification) Notification preferences | |||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||
Array of objects (PortAdditionalInfo) Port additional information | |||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||
object (EndCustomer) | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
Array of objects (PhysicalPort) Physical ports that implement this port | |||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||
Array of objects (PortLoa) Port Loas | |||||||||||||||||||||||||||||||||||
Array
|
href | string <uri> Equinix assigned response attribute for an absolute URL that is the subject of the link's context. | ||||||||||||||||||||||||||||||||||
type | string (PortType) Enum: "XF_PORT" "IX_PORT" "IA_PORT" Type of Port | ||||||||||||||||||||||||||||||||||
id | integer Equinix assigned response attribute for Port Id | ||||||||||||||||||||||||||||||||||
uuid | string <uuid> Equinix assigned response attribute for port identifier | ||||||||||||||||||||||||||||||||||
name | string Equinix assigned response attribute for Port name | ||||||||||||||||||||||||||||||||||
description | string Equinix assigned response attribute for Port description | ||||||||||||||||||||||||||||||||||
physicalPortsSpeed | integer >= 0 Physical Ports Speed in Mbps | ||||||||||||||||||||||||||||||||||
connectionsCount | integer >= 0 Equinix assigned response attribute for Connection count | ||||||||||||||||||||||||||||||||||
physicalPortsType | string Enum: "1000BASE_LX" "10GBASE_LR" "100GBASE_LR4" "10GBASE_ER" "1000BASE_SX" Physical Ports Type | ||||||||||||||||||||||||||||||||||
physicalPortsCount | integer | ||||||||||||||||||||||||||||||||||
connectivitySourceType | string Enum: "COLO" "BMMR" "REMOTE" Port connectivity type | ||||||||||||||||||||||||||||||||||
bmmrType | string Enum: "SELF" "EQUINIX" | ||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
state | string (PortState) Enum: "PENDING" "PROVISIONING" "REPROVISIONING" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED" Port lifecycle state | ||||||||||||||||||||||||||||||||||
object (PortOrder) | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
object Operational specifications for ports. | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
object (SimplifiedAccount) | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
object (PortChange) Current state of latest port change | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
object (Changelog) Change log | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
serviceType | string Deprecated Enum: "EPL" "MSP" Port service Type | ||||||||||||||||||||||||||||||||||
bandwidth | integer >= 0 Deprecated Equinix assigned response attribute for Port bandwidth in Mbps | ||||||||||||||||||||||||||||||||||
availableBandwidth | integer >= 0 Equinix assigned response attribute for Port available bandwidth in Mbps | ||||||||||||||||||||||||||||||||||
usedBandwidth | integer >= 0 Equinix assigned response attribute for Port used bandwidth in Mbps | ||||||||||||||||||||||||||||||||||
object (SimplifiedLocation) | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
object (PortDevice) Port device | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
object (PortInterface) Port interface | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
demarcationPointIbx | string A-side/Equinix ibx | ||||||||||||||||||||||||||||||||||
tetherIbx | string z-side/Equinix ibx | ||||||||||||||||||||||||||||||||||
object (PortDemarcationPoint) Customer physical Port | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
object (PortRedundancy) Port redundancy configuration | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
object (PortEncapsulation) Port encapsulation configuration | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
lagEnabled | boolean If LAG enabled | ||||||||||||||||||||||||||||||||||
object Port Lag | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
asn | integer Port ASN | ||||||||||||||||||||||||||||||||||
object (Package) Package settings for port | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
object (PortSettings) Port configuration settings | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
physicalPortQuantity | integer Number of physical ports | ||||||||||||||||||||||||||||||||||
Array of objects (PortNotification) Notification preferences | |||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||
Array of objects (PortAdditionalInfo) Port additional information | |||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||
object (EndCustomer) | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
Array of objects (PhysicalPort) Physical ports that implement this port | |||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||
Array of objects (PortLoa) Port Loas | |||||||||||||||||||||||||||||||||||
Array
|
{- "type": "XF_PORT",
- "physicalPortsSpeed": 1000,
- "physicalPortsType": "1000BASE_LX",
- "connectivitySourceType": "COLO",
- "location": {
- "metroCode": "GV"
}, - "demarcationPointIbx": "GV1",
- "package": {
- "code": "STANDARD"
}, - "lagEnabled": false,
- "encapsulation": {
- "type": "DOT1Q",
- "tagProtocolId": 33024
}, - "project": {
- "projectId": "8f23b36f-db8f-44c8-a6e5-606e1b485931'"
}, - "account": {
- "accountNumber": 270848
}, - "notifications": [
- {
- "registeredUsers": [
- "jaguarsuser-port-order"
], - "type": "TECHNICAL"
}
], - "order": {
- "purchaseOrder": {
- "number": 156576,
- "amount": 10,
- "startDate": "2018-06-11T22:25:52.206Z",
- "endDate": "2018-07-11T22:25:52.206Z",
- "type": "NEW"
}, - "signature": {
- "signatory": "DELEGATE",
- "delegate": {
- "firstName": "John",
- "lastName": "Doe",
- "email": "john.doe@company.com"
}
}
}, - "physicalPorts": [
- {
- "demarcationPoint": {
- "ibx": "GV1",
- "cabinetUniqueSpaceId": "Demarc",
- "cageUniqueSpaceId": "GV1:01:002174",
- "patchPanel": "CP:Demarc:1259684",
- "connectorType": "SC"
}
}
]
}
{- "type": "XF_PORT",
- "uuid": "0f6bdb36-e130-4924-b038-ee1785fad166",
- "state": "PENDING",
- "physicalPortsType": "10GBASE_L",
- "physicalPortsSpeed": 10000,
- "physicalPortsCount": 1,
- "location": {
- "metroCode": "AM"
}, - "demarcationPointIbx": "AM1",
- "redundancy": {
- "group": 1,
- "priority": "PRIMARY"
}, - "lagEnabled": false,
- "encapsulation": {
- "type": "DOT1Q",
- "tagProtocolId": 33024
}, - "package": {
- "code": "STANDARD"
}, - "settings": {
- "sharedPortType": false
}, - "project": {
- "projectId": "8f23b36f-db8f-44c8-a6e5-606e1b485931"
}, - "account": {
- "accountNumber": 1000
}, - "order": {
- "orderNumber": "1-207799950758",
- "signature": {
- "signatory": "DELEGATE",
- "delegate": {
- "email": "testEmail1@equinix.com"
}
}
}, - "notifications": [
- {
- "type": "TECHNICAL",
- "registeredUsers": [
- "jaguarsuser-port-order"
]
}, - {
- "type": "NOTIFICATION",
- "registeredUsers": [
- "jaguarsuser-port-order"
]
}, - {
- "type": "PEERING",
- "registeredUsers": [
- "jaguarsuser-port-order"
]
}, - {
- "type": "ESCALATION",
- "registeredUsers": [
- "jaguarsuser-port-order"
]
}
]
}
Add Physical Ports to Virtual Port. Preview
portId required | string <uuid> (PortUUID) Port UUID |
Array of objects (PhysicalPort) add physical ports to virtual port | |||||||||||||||||||||||||||||||||
Array
|
object (Pagination) Pagination response information | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
Array of objects (PhysicalPort) GET All Physical Ports | |||||||||||||||||||||||||||||||||||
Array
|
{- "data": [
- {
- "type": "XF_PHYSICAL_PORT",
- "demarcationPoint": {
- "ibx": "AM1",
- "cabinetUniqueSpaceId": "AM1:02:032575:0105",
- "cageUniqueSpaceId": "AM1:02:032575",
- "patchPanel": "PP:0105:1260379",
- "patchPanelPortA": 14,
- "patchPanelPortB": 15,
- "connectorType": "LC"
}, - "account": {
- "accountNumber": 17829
}, - "order": {
- "purchaseOrder": {
- "number": 156576,
- "amount": 10,
- "startDate": "2018-06-11T22:25:52.206Z",
- "endDate": "2018-07-11T22:25:52.206Z",
- "type": "NEW"
}, - "signature": {
- "signatory": "DELEGATE",
- "delegate": {
- "firstName": "John",
- "lastName": "Doe",
- "email": "john.doe@company.com"
}
}
}, - "notifications": [
- {
- "registeredUsers": [
- "jaguarsuser-port-order"
], - "type": "NOTIFICATION"
}
]
}, - {
- "type": "XF_PHYSICAL_PORT",
- "account": {
- "accountNumber": 17829
}, - "demarcationPoint": {
- "ibx": "AM1",
- "cabinetUniqueSpaceId": "AM1:02:032575:0105",
- "cageUniqueSpaceId": "AM1:02:032575",
- "patchPanel": "PP:0105:1260379",
- "patchPanelPortA": 16,
- "patchPanelPortB": 17,
- "connectorType": "LC"
}, - "order": {
- "purchaseOrder": {
- "number": 156576,
- "amount": 10,
- "startDate": "2018-06-11T22:25:52.206Z",
- "endDate": "2018-07-11T22:25:52.206Z",
- "type": "NEW"
}, - "signature": {
- "signatory": "DELEGATE",
- "delegate": {
- "firstName": "John",
- "lastName": "Doe",
- "email": "john.doe@company.com"
}
}
}, - "notifications": [
- {
- "registeredUsers": [
- "jaguarsuser-port-order"
], - "type": "NOTIFICATION"
}
]
}
]
}
{- "data": [
- {
- "type": "XF_PHYSICAL_PORT",
- "demarcationPoint": {
- "cabinetUniqueSpaceId": "Demarc",
- "cageUniqueSpaceId": "GV1:01:002174",
- "patchPanel": "CP:Demarc:1259684",
- "patchPanelPortA": "39",
- "patchPanelPortB": "40",
- "connectorType": "SC",
- "ibx": "GV1"
}, - "order": {
- "orderNumber": "1-210210611904"
}, - "notifications": [
- {
- "registeredUsers": [
- "jaguarsuser-port-order"
], - "type": "NOTIFICATION"
}
]
}, - {
- "type": "XF_PHYSICAL_PORT",
- "demarcationPoint": {
- "cabinetUniqueSpaceId": "Demarc",
- "cageUniqueSpaceId": "GV1:01:002174",
- "patchPanel": "CP:Demarc:1259684",
- "patchPanelPortA": "41",
- "patchPanelPortB": "42",
- "connectorType": "SC",
- "ibx": "GV1"
}, - "order": {
- "orderNumber": "1-210210611904"
}, - "notifications": [
- {
- "registeredUsers": [
- "jaguarsuser-port-order"
], - "type": "NOTIFICATION"
}
]
}
]
}
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.
portId required | string <uuid> (PortUUID) Port UUID |
href | string <uri> Equinix assigned response attribute for an absolute URL that is the subject of the link's context. | ||||||||||||||||||||||||||||||||||
type | string (PortType) Enum: "XF_PORT" "IX_PORT" "IA_PORT" Type of Port | ||||||||||||||||||||||||||||||||||
id | integer Equinix assigned response attribute for Port Id | ||||||||||||||||||||||||||||||||||
uuid | string <uuid> Equinix assigned response attribute for port identifier | ||||||||||||||||||||||||||||||||||
name | string Equinix assigned response attribute for Port name | ||||||||||||||||||||||||||||||||||
description | string Equinix assigned response attribute for Port description | ||||||||||||||||||||||||||||||||||
physicalPortsSpeed | integer >= 0 Physical Ports Speed in Mbps | ||||||||||||||||||||||||||||||||||
connectionsCount | integer >= 0 Equinix assigned response attribute for Connection count | ||||||||||||||||||||||||||||||||||
physicalPortsType | string Enum: "1000BASE_LX" "10GBASE_LR" "100GBASE_LR4" "10GBASE_ER" "1000BASE_SX" Physical Ports Type | ||||||||||||||||||||||||||||||||||
physicalPortsCount | integer | ||||||||||||||||||||||||||||||||||
connectivitySourceType | string Enum: "COLO" "BMMR" "REMOTE" Port connectivity type | ||||||||||||||||||||||||||||||||||
bmmrType | string Enum: "SELF" "EQUINIX" | ||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
state | string (PortState) Enum: "PENDING" "PROVISIONING" "REPROVISIONING" "PROVISIONED" "ACTIVE" "DEPROVISIONING" "DEPROVISIONED" "INACTIVE" "FAILED" "ADDED" "DELETED" "TO_BE_ADDED" "TO_BE_DELETED" Port lifecycle state | ||||||||||||||||||||||||||||||||||
object (PortOrder) | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
object Operational specifications for ports. | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
object (SimplifiedAccount) | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
object (PortChange) Current state of latest port change | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
object (Changelog) Change log | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
serviceType | string Deprecated Enum: "EPL" "MSP" Port service Type | ||||||||||||||||||||||||||||||||||
bandwidth | integer >= 0 Deprecated Equinix assigned response attribute for Port bandwidth in Mbps | ||||||||||||||||||||||||||||||||||
availableBandwidth | integer >= 0 Equinix assigned response attribute for Port available bandwidth in Mbps | ||||||||||||||||||||||||||||||||||
usedBandwidth | integer >= 0 Equinix assigned response attribute for Port used bandwidth in Mbps | ||||||||||||||||||||||||||||||||||
object (SimplifiedLocation) | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
object (PortDevice) Port device | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
object (PortInterface) Port interface | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
demarcationPointIbx | string A-side/Equinix ibx | ||||||||||||||||||||||||||||||||||
tetherIbx | string z-side/Equinix ibx | ||||||||||||||||||||||||||||||||||
object (PortDemarcationPoint) Customer physical Port | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
object (PortRedundancy) Port redundancy configuration | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
object (PortEncapsulation) Port encapsulation configuration | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
lagEnabled | boolean If LAG enabled | ||||||||||||||||||||||||||||||||||
object Port Lag | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
asn | integer Port ASN | ||||||||||||||||||||||||||||||||||
object (Package) Package settings for port | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
object (PortSettings) Port configuration settings | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
physicalPortQuantity | integer Number of physical ports | ||||||||||||||||||||||||||||||||||
Array of objects (PortNotification) Notification preferences | |||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||
Array of objects (PortAdditionalInfo) Port additional information | |||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||
object (EndCustomer) | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||
Array of objects (PhysicalPort) Physical ports that implement this port | |||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||
Array of objects (PortLoa) Port Loas | |||||||||||||||||||||||||||||||||||
Array
|
{- "type": "XF_PORT",
- "uuid": "e91484bb-4f65-4ab3-8f77-500dec2f855d",
- "name": "test-AT1-Dot1q-L-Secondary-108608",
- "state": "ACTIVE",
- "bandwidth": 10000,
- "usedBandwidth": 0,
- "availableBandwidth": 20000,
- "physicalPortsSpeed": 10000,
- "physicalPortsType": "1000BASE_LX",
- "connectivitySourceType": "COLO",
- "redundancy": {
- "group": "1",
- "priority": "Secondary"
}, - "location": {
- "ibx": "AT1",
- "metroCode": "AT",
- "metroName": "Atlanta",
- "region": "AMER"
}, - "device": {
- "name": "dev-m7a2.lab",
- "redundancy": {
- "group": "1",
- "priority": "Secondary"
}
}, - "encapsulation": {
- "type": "DOT1Q",
- "tagProtocolId": 33024
}, - "lagEnabled": true,
- "package": {
- "code": "STANDARD",
- "type": "MSP"
}, - "settings": {
- "buyout": false,
- "placeVcOrderPermission": true,
- "viewPortPermission": true
}, - "physicalPorts": [
- {
- "state": "PROVISIONED",
- "type": "XF_PHYSICAL_PORT",
- "id": 6967,
- "bandwidth": 10000,
- "tether": {
- "crossConnectId": "100179-A",
- "patchPanel": "PP:8118:1586",
- "patchPanelPortA": "92",
- "patchPanelPortB": "24"
}, - "demarcationPoint": {
- "ibx": "AT1",
- "patchPanel": "PP:8118:1586",
- "patchPanelName": "PP:8118:1586",
- "patchPanelPortA": "92",
- "patchPanelPortB": "24"
}
}, - {
- "state": "PROVISIONED",
- "type": "XF_PHYSICAL_PORT",
- "id": 6968,
- "bandwidth": 10000,
- "tether": {
- "crossConnectId": "100179-A",
- "patchPanel": "PP:8118:1586",
- "patchPanelPortA": "92",
- "patchPanelPortB": "24"
}
}
], - "operation": {
- "operationalStatus": "UP",
- "opStatusChangedAt": "2021-06-14T17:21:25.586Z",
- "connectionCount": 0,
- "evplVcCount": 0,
- "fgVcCount": 0,
- "accessVcCount": 0
}, - "account": {
- "accountNumber": 100179,
- "accountName": "L2",
- "globalCustId": "007700000090982RG8",
- "orgId": 100179,
- "organizationName": "Cust_Org_100179"
}, - "changeLog": {
- "createdDateTime": "2018-06-14T17:21:25.587Z"
}, - "project": {
- "projectId": "8f23b36f-db8f-44c8-a6e5-606e1b485931"
}
}
The API provides capability to delete a single port
portId required | string <uuid> (PortUUID) Port UUID |
{- "type": "XF_PORT",
- "uuid": "e91484bb-4f65-4ab3-8f77-500dec2f855d",
- "name": "test-AT1-Dot1q-L-Secondary-108608",
- "state": "DEPROVISIONING",
- "bandwidth": 10000,
- "usedBandwidth": 0,
- "availableBandwidth": 20000,
- "redundancy": {
- "group": "C91484bb-4f65-4ab3-8f77-500dec2f855C",
- "priority": "PRIMARY"
}, - "location": {
- "ibx": "AT1",
- "metroCode": "AT",
- "metroName": "Atlanta",
- "region": "AMER"
}, - "device": {
- "name": "dev-m7a2.lab",
- "redundancy": {
- "group": "C91484bb-4f65-4ab3-8f77-500dec2f855C",
- "priority": "PRIMARY"
}
}, - "encapsulation": {
- "type": "DOT1Q",
- "tagProtocolId": 33024
}, - "lagEnabled": true,
- "settings": {
- "buyout": false,
- "placeVcOrderPermission": true,
- "viewPortPermission": true
}, - "physicalPorts": [
- {
- "state": "DEPROVISIONING",
- "type": "XF_PHYSICAL_PORT",
- "bandwidth": 10000,
- "tether": {
- "crossConnectId": "100179-A",
- "patchPanel": "PP:8118:1586",
- "patchPanelPortA": "92",
- "patchPanelPortB": "24"
}, - "demarcationPoint": {
- "ibx": "AT1",
- "patchPanel": "PP:8118:1586",
- "patchPanelName": "PP:8118:1586",
- "patchPanelPortA": "92",
- "patchPanelPortB": "24"
}
}
], - "account": {
- "accountNumber": 100179,
- "accountName": "L2 account",
- "globalCustId": "007700000090982RG8",
- "orgId": 100179,
- "organizationName": "Cust_Org_100179"
}, - "changeLog": {
- "createdDateTime": "2018-06-14T17:21:25.587Z"
}
}
Update Port by UUID
portId required | string <uuid> (PortUUID) Port UUID |
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 |
[- {
- "op": "replace",
- "path": "/name",
- "value": "1234-ibx-port"
}
]
{- "pagination": {
- "offset": 0,
- "limit": 5,
- "total": 1
}, - "data": [
- {
- "type": "XF_PORT",
- "uuid": "e91484bb-4f65-4ab3-8f77-500dec2f855d",
- "name": "test-AT1-Dot1q-L-Secondary-108608",
- "state": "ACTIVE",
- "bandwidth": 10000,
- "usedBandwidth": 0,
- "availableBandwidth": 20000,
- "physicalPortSpeed": 10000,
- "redundancy": {
- "priority": "SECONDARY"
}, - "location": {
- "ibx": "AT1",
- "metroCode": "AT",
- "metroName": "Atlanta",
- "region": "AMER"
}, - "device": {
- "name": "dev-m7a2.lab",
- "redundancy": {
- "group": "1",
- "priority": "SECONDARY"
}
}, - "encapsulation": {
- "type": "DOT1Q",
- "tagProtocolId": 33024
}, - "lagEnabled": true,
- "package": {
- "code": "STANDARD",
- "type": "MSP"
}, - "settings": {
- "buyout": false,
- "placeVcOrderPermission": true,
- "viewPortPermission": true
}, - "physicalPorts": [
- {
- "state": "ACTIVE",
- "type": "XF_PHYSICAL_PORT",
- "id": 6967,
- "bandwidth": 10000,
- "tether": {
- "crossConnectId": "100179-A",
- "patchPanel": "PP:956:66107",
- "patchPanelPortA": "5",
- "patchPanelPortB": "42"
}, - "operation": {
- "operationalStatus": "UP"
}
}, - {
- "state": "ACTIVE",
- "type": "XF_PHYSICAL_PORT",
- "id": 6968,
- "bandwidth": 10000,
- "tether": {
- "crossConnectId": "100179-A",
- "patchPanel": "PP:8118:1586",
- "patchPanelPortA": "92",
- "patchPanelPortB": "24"
}, - "operation": {
- "operationalStatus": "UP"
}, - "demarcationPoint": {
- "ibx": "AT1",
- "patchPanel": "PP:8118:1586",
- "patchPanelName": "PP:8118:1586",
- "patchPanelPortA": "92",
- "patchPanelPortB": "24"
}
}
], - "operation": {
- "operationalStatus": "UP",
- "opStatusChangedAt": "2021-06-14T17:21:25.586Z",
- "connectionCount": 0,
- "evplVcCount": 0,
- "fgVcCount": 0,
- "accessVcCount": 0
}, - "account": {
- "accountNumber": 100179,
- "accountName": "L2",
- "globalCustId": "007700000090982RG8",
- "orgId": 100179,
- "organizationName": "Cust_Org_100179"
}, - "order": {
- "purchaseOrder": {
- "startDate": "2020-06-14T17:21:25.586Z",
- "endDate": "2020-06-15T17:21:25.586Z",
- "type": "NEW"
}, - "orderNumber": "1-222078525611"
}, - "changeLog": {
- "createdDateTime": "2020-06-14T17:21:25.586Z"
}, - "project": {
- "projectId": "8f23b36f-db8f-44c8-a6e5-606e1b485931"
}
}
]
}
The API provides capability to retrieve Vlans for a Port.
portUuid required | string <uuid> (PortUUID) Port UUID |
object (Pagination) Pagination response information | |||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
Array of objects (LinkProtocolResponse) | |||||||||||||||||||||||||||||||||
Array
|
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 5
}, - "data": [
- {
- "type": "QINQ",
- "uuid": "52d61263-fb0a-459d-a086-bc7fd6bd7384",
- "state": "RESERVED",
- "vlanSTag": 1000,
- "vlanCTag": 500,
- "asset": {
- "uuid": "cd67f685-41b0-1b07-6de0-320a5c00abee"
}, - "changeLog": {
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}, - {
- "type": "QINQ",
- "uuid": "8c589394-b0eb-4057-97dc-3bdb4f8ff6db",
- "state": "RESERVED",
- "vlanSTag": 1000,
- "vlanCTag": 500,
- "serviceToken": {
- "uuid": "fc4fb78a-6b89-462d-a233-e75ef61a603f"
}, - "changeLog": {
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}, - {
- "type": "QINQ",
- "uuid": "7f1da56d-e1ff-4b25-b542-883c7004e971",
- "state": "RESERVED",
- "vlanSTag": 1000,
- "vlanCTag": 500,
- "serviceToken": {
- "uuid": "90f1af0e-134b-40d6-a007-e62cd6866373",
- "bandwidth": 1000
}, - "changeLog": {
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}, - {
- "type": "QINQ",
- "uuid": "7c968801-e03b-4530-8424-aa5ecc4339e2",
- "state": "RESERVED",
- "vlanSTag": 1000,
- "vlanCTag": 500,
- "asset": {
- "uuid": "2ac4e14f-6120-4705-886e-d37f1d0c6a65"
}, - "changeLog": {
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}, - {
- "type": "QINQ",
- "uuid": "db812bba-94b8-43e6-8d9c-850f04350c3d",
- "state": "RESERVED",
- "vlanSTag": 1001,
- "vlanCTag": 1001,
- "asset": {
- "uuid": "3268d105-e57b-4b2b-8a0a-2e3e42312d95"
}, - "changeLog": {
- "createdDateTime": "2020-05-21T10:30:00Z",
- "updatedDateTime": "2020-05-21T10:30:00Z"
}
}
]
}
The API provides capability to get list of user's virtual ports using search criteria, including optional filtering, pagination and sorting
object (PortExpression) | |||||||||||
| |||||||||||
object (PaginationRequest) Pagination request information | |||||||||||
| |||||||||||
Array of objects (PortSortCriteria) | |||||||||||
Array
|
object (Pagination) Pagination response information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Port) GET All User Port Across Fabric Metros | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
|
{- "filter": {
- "or": [
- {
- "and": [
- {
- "operator": "=",
- "property": "/project/projectId",
- "values": [
- "30ad25e2-53dc-11ed-bdc3-0242ac120002"
]
}, - {
- "operator": "=",
- "property": "/state",
- "values": [
- "ACTIVE"
]
}, - {
- "operator": "=",
- "property": "/settings/productCode",
- "values": [
- "CX"
]
}
]
}
]
}, - "pagination": {
- "limit": 25,
- "offset": 0,
- "total": 0
}, - "sort": [
- {
- "property": "/device/name",
- "direction": "DESC"
}
]
}
{- "pagination": {
- "offset": 0,
- "limit": 5,
- "total": 1
}, - "data": [
- {
- "type": "XF_PORT",
- "uuid": "e91484bb-4f65-4ab3-8f77-500dec2f855d",
- "name": "test-AT1-Dot1q-L-Secondary-108608",
- "state": "ACTIVE",
- "bandwidth": 10000,
- "usedBandwidth": 0,
- "availableBandwidth": 20000,
- "physicalPortSpeed": 10000,
- "redundancy": {
- "priority": "SECONDARY"
}, - "location": {
- "ibx": "AT1",
- "metroCode": "AT",
- "metroName": "Atlanta",
- "region": "AMER"
}, - "device": {
- "name": "dev-m7a2.lab",
- "redundancy": {
- "group": "1",
- "priority": "SECONDARY"
}
}, - "encapsulation": {
- "type": "DOT1Q",
- "tagProtocolId": 33024
}, - "lagEnabled": true,
- "package": {
- "code": "STANDARD",
- "type": "MSP"
}, - "settings": {
- "buyout": false,
- "placeVcOrderPermission": true,
- "viewPortPermission": true
}, - "physicalPorts": [
- {
- "state": "ACTIVE",
- "type": "XF_PHYSICAL_PORT",
- "id": 6967,
- "bandwidth": 10000,
- "tether": {
- "crossConnectId": "100179-A",
- "patchPanel": "PP:956:66107",
- "patchPanelPortA": "5",
- "patchPanelPortB": "42"
}, - "operation": {
- "operationalStatus": "UP"
}
}, - {
- "state": "ACTIVE",
- "type": "XF_PHYSICAL_PORT",
- "id": 6968,
- "bandwidth": 10000,
- "tether": {
- "crossConnectId": "100179-A",
- "patchPanel": "PP:8118:1586",
- "patchPanelPortA": "92",
- "patchPanelPortB": "24"
}, - "operation": {
- "operationalStatus": "UP"
}, - "demarcationPoint": {
- "ibx": "AT1",
- "patchPanel": "PP:8118:1586",
- "patchPanelName": "PP:8118:1586",
- "patchPanelPortA": "92",
- "patchPanelPortB": "24"
}
}
], - "operation": {
- "operationalStatus": "UP",
- "opStatusChangedAt": "2021-06-14T17:21:25.586Z",
- "connectionCount": 0,
- "evplVcCount": 0,
- "fgVcCount": 0,
- "accessVcCount": 0
}, - "account": {
- "accountNumber": 100179,
- "accountName": "L2",
- "globalCustId": "007700000090982RG8",
- "orgId": 100179,
- "organizationName": "Cust_Org_100179"
}, - "order": {
- "purchaseOrder": {
- "startDate": "2020-06-14T17:21:25.586Z",
- "endDate": "2020-06-15T17:21:25.586Z",
- "type": "NEW"
}, - "orderNumber": "1-222078525611"
}, - "changeLog": {
- "createdDateTime": "2020-06-14T17:21:25.586Z"
}, - "project": {
- "projectId": "8f23b36f-db8f-44c8-a6e5-606e1b485931"
}
}
]
}
The API provides capability to create Precision Time service
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 | ||||||||||||||||||
| |||||||||||||||||||
required | Array of objects (fabricConnectionUuid) | ||||||||||||||||||
Array
| |||||||||||||||||||
required | object (ipv4) EPT service network information | ||||||||||||||||||
| |||||||||||||||||||
Array of objects (ntpAdvanceConfiguration) NTP Advanced configuration - MD5 Authentication. | |||||||||||||||||||
Array
| |||||||||||||||||||
object (ptpAdvanceConfiguration) PTP Advanced Configuration. | |||||||||||||||||||
| |||||||||||||||||||
object (Project) | |||||||||||||||||||
| |||||||||||||||||||
object (precisionTimeOrder) Precision Time Order | |||||||||||||||||||
|
{- "type": "NTP",
- "name": "EPT-NTP-Service",
- "connections": [
- {
- "uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0"
}
], - "package": {
- "code": "NTP_STANDARD"
}, - "ipv4": {
- "primary": "192.168.0.2",
- "secondary": "192.168.0.3",
- "networkMask": "255.255.255.255",
- "defaultGateway": "192.167.0.1"
}
}
{- "type": "NTP",
- "uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee011",
- "name": "EPT-NTP-Service",
- "state": "PROVISIONING",
- "connections": [
- {
- "type": "EVPL_VC",
- "uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0",
- "aSide": {
- "accessPoint": {
- "type": "COLO",
- "location": {
- "metroCode": "NY",
- "ibx": "NY1"
}
}
}, - "zSide": {
- "accessPoint": {
- "type": "SP",
}
}
}
], - "package": {
- "code": "NTP_STANDARD"
}, - "ipv4": {
- "primary": "192.168.0.2",
- "secondary": "192.168.0.3",
- "networkMask": "255.255.255.255",
- "defaultGateway": "192.167.0.1"
}, - "account": {
- "accountNumber": 123456
}, - "changeLog": {
- "createdByEmail": "abc@xyz.com",
- "createdDateTime": "2024-08-24T06:50:46Z",
- "updatedByEmail": "abc@xyz.com",
- "updatedDateTime": "2024-08-24T06:51:46Z"
}
}
The API provides capability to get Precision Time Service details
serviceId required | string <uuid> (ServiceId) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Service UUID |
href required | string <uri> Precision Time Service URI. | ||||||||||||||||||||||||
type required | string Enum: "NTP" "PTP" Precision Time Service type refers to the corresponding protocol. | ||||||||||||||||||||||||
name | string Precision Time Service Name. | ||||||||||||||||||||||||
uuid required | string <uuid> Precision Time Service UUID. | ||||||||||||||||||||||||
state required | string Enum: "CANCELLED" "CANCELLING" "CONFIGURING" "CONFIGURING_FAILED" "DRAFT" "DEPROVISIONING" "DEPROVISIONING_FAILED" "DEPROVISIONED" "PROVISIONED" "PROVISIONING" "PROVISIONING_FAILED" "REPROVISIONING" "REPROVISIONING_FAILED" Precision Time Service Status. | ||||||||||||||||||||||||
required | object (precisionTimePackagePostResponse) | ||||||||||||||||||||||||
| |||||||||||||||||||||||||
Array of objects (fabricConnectionResponse) [ 1 .. 2 ] items unique Fabric Connections associated with Precision Time Service. | |||||||||||||||||||||||||
Array ([ 1 .. 2 ] items)
| |||||||||||||||||||||||||
object (ipv4) EPT service network information | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Array of objects (ntpAdvanceConfiguration) NTP Advanced configuration - MD5 Authentication. | |||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||
object (ptpAdvanceConfiguration) PTP Advanced Configuration. | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (SimplifiedAccount) | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (precisionTimeOrder) Precision Time Order | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (precisionTimePrice) Precision Time Price | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
object (Changelog) Change log | |||||||||||||||||||||||||
|
{- "type": "NTP",
- "uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee011",
- "name": "EPT-NTP-Service",
- "state": "PROVISIONED",
- "connections": [
- {
- "type": "EVPL_VC",
- "uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0",
- "aSide": {
- "accessPoint": {
- "type": "COLO",
- "location": {
- "metroCode": "NY",
- "ibx": "NY1"
}
}
}, - "zSide": {
- "accessPoint": {
- "type": "SP",
}
}
}
], - "package": {
- "code": "NTP_STANDARD"
}, - "ipv4": {
- "primary": "192.168.0.2",
- "secondary": "192.168.0.3",
- "networkMask": "255.255.255.255",
- "defaultGateway": "192.167.0.1"
}, - "order": {
- "orderNumber": "1-129105284100"
}, - "account": {
- "accountNumber": 123456
}, - "changeLog": {
- "createdByEmail": "abc@xyz.com",
- "createdDateTime": "2024-08-24T06:50:46Z",
- "updatedByEmail": "abc@xyz.com",
- "updatedDateTime": "2024-08-24T06:51:46Z"
}
}
The API provides capability to Configure/Fulfill the Precision Time Service.
serviceId required | string <uuid> (ServiceId) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Service UUID |
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 | ||||||||||||||||||
| |||||||||||||||||||
required | Array of objects (fabricConnectionUuid) | ||||||||||||||||||
Array
| |||||||||||||||||||
required | object (ipv4) EPT service network information | ||||||||||||||||||
| |||||||||||||||||||
Array of objects (ntpAdvanceConfiguration) NTP Advanced configuration - MD5 Authentication. | |||||||||||||||||||
Array
| |||||||||||||||||||
object (ptpAdvanceConfiguration) PTP Advanced Configuration. | |||||||||||||||||||
| |||||||||||||||||||
object (Project) | |||||||||||||||||||
| |||||||||||||||||||
object (precisionTimeOrder) Precision Time Order | |||||||||||||||||||
|
{- "type": "NTP",
- "name": "EPT-Standard-Service",
- "connections": [
- {
- "uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0"
}
], - "package": {
- "code": "NTP_STANDARD"
}, - "ipv4": {
- "primary": "192.168.0.2",
- "secondary": "192.168.0.3",
- "networkMask": "255.255.255.255",
- "defaultGateway": "192.167.0.1"
}
}
{- "type": "NTP",
- "uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee011",
- "name": "EPT-NTP-Service",
- "state": "PROVISIONING",
- "connections": [
- {
- "type": "EVPL_VC",
- "uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0",
- "aSide": {
- "accessPoint": {
- "type": "COLO",
- "location": {
- "metroCode": "NY",
- "ibx": "NY1"
}
}
}, - "zSide": {
- "accessPoint": {
- "type": "SP",
}
}
}
], - "package": {
- "code": "NTP_STANDARD"
}, - "ipv4": {
- "primary": "192.168.0.2",
- "secondary": "192.168.0.3",
- "networkMask": "255.255.255.255",
- "defaultGateway": "192.167.0.1"
}, - "account": {
- "accountNumber": 123456
}, - "order": {
- "orderNumber": "1-129105284100"
}, - "changeLog": {
- "createdByEmail": "abc@xyz.com",
- "createdDateTime": "2024-08-24T06:50:46Z",
- "updatedByEmail": "abc@xyz.com",
- "updatedDateTime": "2024-08-24T06:51:46Z"
}
}
The API provides capability to delete Precision Time Service by service id.
serviceId required | string <uuid> (ServiceId) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Service UUID |
{- "type": "NTP",
- "uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee011",
- "name": "EPT-NTP-Service",
- "state": "DEPROVISIONING",
- "connections": [
- {
- "type": "EVPL_VC",
- "uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0",
- "aSide": {
- "accessPoint": {
- "type": "COLO",
- "location": {
- "metroCode": "NY",
- "ibx": "NY1"
}
}
}, - "zSide": {
- "accessPoint": {
- "type": "SP",
}
}
}
], - "package": {
- "code": "NTP_STANDARD"
}, - "ipv4": {
- "primary": "192.168.0.2",
- "secondary": "192.168.0.3",
- "networkMask": "255.255.255.255",
- "defaultGateway": "192.167.0.1"
}, - "account": {
- "accountNumber": 123456
}, - "order": {
- "orderNumber": "1-216720438646"
}, - "changeLog": {
- "createdByEmail": "abc@xyz.com",
- "createdDateTime": "2024-08-24T06:50:46Z",
- "updatedByEmail": "abc@xyz.com",
- "updatedDateTime": "2024-08-24T06:51:46Z",
- "deletedByEmail": "abc@xyz.com",
- "deletedDateTime": "2024-08-24T06:52:46Z"
}
}
The API provides capability to update Precision Time Service by service id.
serviceId required | string <uuid> (ServiceId) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Service UUID |
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 |
[- {
- "op": "replace",
- "path": "/name",
- "value": "Updated-Service-Name"
}
]
{- "type": "NTP",
- "uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee011",
- "name": "EPT-NTP-Service",
- "state": "REPROVISIONING",
- "connections": [
- {
- "type": "EVPL_VC",
- "uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0",
- "aSide": {
- "accessPoint": {
- "type": "COLO",
- "location": {
- "metroCode": "NY",
- "ibx": "NY1"
}
}
}, - "zSide": {
- "accessPoint": {
- "type": "SP",
}
}
}
], - "package": {
- "code": "NTP_STANDARD"
}, - "ipv4": {
- "primary": "192.168.0.2",
- "secondary": "192.168.0.3",
- "networkMask": "255.255.255.255",
- "defaultGateway": "192.167.0.1"
}, - "account": {
- "accountNumber": 123456
}, - "order": {
- "orderNumber": "1-129105284100"
}, - "changeLog": {
- "createdByEmail": "abc@xyz.com",
- "createdDateTime": "2024-08-24T06:50:46Z",
- "updatedByEmail": "abc@xyz.com",
- "updatedDateTime": "2024-08-24T06:51:46Z"
}
}
The API provides capability to get list of user's Time Services using search criteria, including optional filtering, pagination and sorting
object (TimeServiceFilters) | |||||||||||
| |||||||||||
object (PaginationRequest) Pagination request information | |||||||||||
| |||||||||||
Array of objects (TimeServiceSortCriteria) | |||||||||||
Array
|
object (Pagination) Pagination response information | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
Array of objects (precisionTimeServiceResponse) Data returned from the API call. | |||||||||||||||||||||||||||||||
Array
|
{- "filter": {
- "and": [
- {
- "property": "/state",
- "operator": "=",
- "values": [
- "PROVISIONED"
]
}, - {
- "property": "/project/projectId",
- "operator": "=",
- "values": [
- "995072000433550"
]
}
]
}, - "pagination": {
- "offset": 0,
- "limit": 20
}, - "sort": [
- {
- "direction": "DESC",
- "property": "/changeLog/createdDateTime"
}
]
}
{- "pagination": {
- "offset": 20,
- "limit": 20,
- "total": 100,
- "next": "/search?offset=40&limit=20",
- "previous": "/search?offset=0&limit=20"
}, - "data": [
- {
- "type": "NTP",
- "uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee011",
- "name": "EPT-NTP-STD-Service",
- "state": "PROVISIONING",
- "connections": [
- {
- "type": "EVPL_VC",
- "uuid": "06dbb0e3-e55d-4090-8aff-fc5654abaad0",
- "aSide": {
- "accessPoint": {
- "type": "COLO",
- "location": {
- "metroCode": "NY",
- "ibx": "NY1"
}
}
}, - "zSide": {
- "accessPoint": {
- "type": "SP",
}
}
}
], - "package": {
- "code": "NTP_STANDARD"
}, - "ipv4": {
- "primary": "192.168.0.2",
- "secondary": "192.168.0.3",
- "networkMask": "255.255.255.255",
- "defaultGateway": "192.167.0.1"
}, - "account": {
- "accountNumber": 123456
}, - "changeLog": {
- "createdByEmail": "abc@xyz.com",
- "createdDateTime": "2024-08-24T06:50:46Z",
- "updatedByEmail": "abc@xyz.com",
- "updatedDateTime": "2024-08-24T06:51:46Z"
}
}
]
}
The API provides capability to get prevision timing service's details
serviceId required | string <uuid> (ServiceId) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Service UUID |
object (Pagination) Pagination response information | |||||||||||
| |||||||||||
Array of objects (connectionLink) Data returned from the API call | |||||||||||
Array
|
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 2
}, - "data": [
- {
- "type": "EVPL_VC",
- "uuid": "92dc376a-a932-43aa-a6a2-c806dedbd784"
}, - {
- "type": "EVPL_VC",
- "uuid": "42dc376a-a932-43aa-a6a2-d806dedbd783"
}
]
}
The API provides capability to get timing service's packages
object (Pagination) Pagination response information | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Array of objects (precisionTimePackageRespose) Data returned from the API call | |||||||||||||||||||||||||
Array
|
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 4
}, - "data": [
- {
- "type": "TIME_SERVICE_PACKAGE",
- "code": "NTP_STANDARD",
- "bandwidth": 1,
- "clientsPerSecondMax": 1000,
- "accuracySlaUnit": "microseconds",
- "accuracySla": -1,
- "accuracySlaMin": 1,
- "accuracySlaMax": 100,
- "redundancySupported": false,
- "multiSubnetSupported": false,
- "changeLog": {
- "createdDateTime": "2023-05-16T07:50:49.749Z",
- "updatedDateTime": "2023-05-17T07:50:49.749Z"
}
}, - {
- "type": "TIME_SERVICE_PACKAGE",
- "code": "NTP_ENTERPRISE",
- "bandwidth": 5,
- "clientsPerSecondMax": 2000,
- "accuracySlaUnit": "microseconds",
- "accuracySla": -1,
- "accuracySlaMin": 1,
- "accuracySlaMax": 100,
- "redundancySupported": false,
- "multiSubnetSupported": true,
- "changeLog": {
- "createdDateTime": "2023-05-16T07:50:49.749Z",
- "updatedDateTime": "2023-05-17T07:50:49.749Z"
}
}, - {
- "type": "TIME_SERVICE_PACKAGE",
- "code": "PTP_STANDARD",
- "bandwidth": 5,
- "clientsPerSecondMax": 20,
- "accuracySlaUnit": "microseconds",
- "accuracySla": 50,
- "accuracySlaMin": 1,
- "accuracySlaMax": 10,
- "redundancySupported": false,
- "multiSubnetSupported": true,
- "changeLog": {
- "createdDateTime": "2023-05-16T07:50:49.749Z",
- "updatedDateTime": "2023-05-17T07:50:49.749Z"
}
}, - {
- "type": "TIME_SERVICE_PACKAGE",
- "code": "PTP_ENTERPRISE",
- "bandwidth": 10,
- "clientsPerSecondMax": 100,
- "accuracySlaUnit": "microseconds",
- "accuracySla": 50,
- "accuracySlaMin": 1,
- "accuracySlaMax": 10,
- "redundancySupported": false,
- "multiSubnetSupported": true,
- "changeLog": {
- "createdDateTime": "2023-05-16T07:50:49.749Z",
- "updatedDateTime": "2023-05-17T07:50:49.749Z"
}
}
]
}
The API provides capability to get timing service's package by code
packageCode required | string Enum: "NTP_STANDARD" "NTP_ENTERPRISE" "PTP_STANDARD" "PTP_ENTERPRISE" Package Code |
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 | |||||||||||||||||||||||||
|
{- "type": "TIME_SERVICE_PACKAGE",
- "code": "NTP_STANDARD",
- "bandwidth": 10,
- "clientsPerSecondMax": 100,
- "accuracySlaUnit": "microseconds",
- "accuracySla": 50,
- "accuracySlaMin": 1,
- "accuracySlaMax": 10,
- "redundancySupported": true,
- "multiSubnetSupported": true,
- "changeLog": {
- "createdDateTime": "2023-05-16T07:50:49.749Z",
- "updatedDateTime": "2023-05-17T07:50:49.749Z"
}
}
Search prices by search criteria
object (SearchExpression) | |||||||||||
|
Array of objects (Price) | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
object (Pagination) Pagination response information | |||||||||||||||||||||||||||||||
|
{- "filter": {
- "and": [
- {
- "property": "/type",
- "operator": "=",
- "values": [
- "VIRTUAL_CONNECTION_PRODUCT"
]
}, - {
- "property": "/connection/type",
- "operator": "=",
- "values": [
- "EVPL_VC"
]
}, - {
- "property": "/connection/bandwidth",
- "operator": "IN",
- "values": [
- "100"
]
}, - {
- "property": "/connection/aSide/accessPoint/type",
- "operator": "=",
- "values": [
- "COLO"
]
}, - {
- "property": "/connection/aSide/accessPoint/location/metroCode",
- "operator": "=",
- "values": [
- "CH"
]
}, - {
- "property": "/connection/aSide/accessPoint/port/settings/buyout",
- "operator": "=",
- "values": [
- "false"
]
}, - {
- "property": "/connection/zSide/accessPoint/location/metroCode",
- "operator": "=",
- "values": [
- "CH"
]
}, - {
- "property": "/connection/zSide/accessPoint/type",
- "operator": "=",
- "values": [
- "COLO"
]
}
]
}
}
{- "pagination": {
- "offset": 0,
- "limit": 1,
- "total": 1
}, - "data": [
- {
- "type": "VIRTUAL_CONNECTION_PRODUCT",
- "code": "ECX00015.PROD",
- "name": "Equinix Fabric Virtual Connection Product",
- "description": "Equinix Fabric Virtual Connection",
- "account": {
- "accountNumber": 200001
}, - "charges": [
- {
- "type": "MONTHLY_RECURRING",
- "price": 500
}
], - "currency": "USD",
- "connection": {
- "type": "EVPL_VC",
- "bandwidth": 100,
- "aSide": {
- "accessPoint": {
- "type": "COLO",
- "location": {
- "metroCode": "CH"
}, - "port": {
- "settings": {
- "buyout": false
}
}
}
}, - "zSide": {
- "accessPoint": {
- "type": "SP",
- "location": {
- "metroCode": "CH"
}, - "profile": {
- "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f2"
}
}
}
}
}
]
}
This API provides capability to get all Route Aggregations Rules for Fabric
routeAggregationId required | string (RouteAggregationId) Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Aggregations Id |
offset | integer Example: offset=1 offset |
limit | integer Example: limit=10 number of records to fetch |
object (Pagination) Pagination response information | |||||||||||||||||||
| |||||||||||||||||||
Array of objects (RouteAggregationRulesData) List of Route Aggregation Rules | |||||||||||||||||||
Array
|
{- "pagination": {
- "offset": 0,
- "limit": 32,
- "total": 2,
- "next": null,
- "previous": null
}, - "data": [
- {
- "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
- "uuid": "65b025ef-022b-4180-85cf-82cfc1ab655b",
- "name": "Private-subnet-aggregation-2",
- "description": "Test rule",
- "prefix": "192.168.10.0/24",
- "state": "PROVISIONED",
- "change": {
- "type": "IPv4_BGP_PREFIX_AGGREGATION_RULE_CREATION",
- "uuid": "9397f111-19aa-489c-b3c7-349c86818f2d"
}, - "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}, - {
- "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
- "uuid": "ea48337b-fe04-4164-a3f0-48d81abf575b",
- "name": "Private-subnet-aggregation-2",
- "description": "Test rule",
- "prefix": "192.168.20.0/24",
- "state": "PROVISIONED",
- "change": {
- "type": "IPv4_BGP_PREFIX_AGGREGATION_RULE_CREATION",
- "uuid": "9397f111-19aa-489c-b3c7-349c86818f2d"
}, - "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}
]
}
This API provides capability to create a Route Aggregation Rule
routeAggregationId required | string (RouteAggregationId) Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Aggregations Id |
name | string |
description | string Customer-provided Route Aggregation Rule description |
prefix required | string |
{- "name": "Private-subnet-aggregation",
- "description": "Test rule",
- "prefix": "192.168.0.0/24"
}
{- "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
- "uuid": "9890d520-1579-4489-8003-154b34b8f403",
- "name": "Private-subnet-aggregation",
- "state": "PROVISIONING",
- "description": "Test rule",
- "change": {
- "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE_CREATION",
- "uuid": "ff9653dc-88c5-47b5-b552-8a08d2f73f7e"
}, - "prefix": "192.168.0.0/24",
- "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z",
- "updatedBy": "testuser",
- "updatedByEmail": "testuser@equinix.com",
- "updatedByFullName": "testuser testuser",
- "updatedDateTime": "2020-05-21T10:30:00Z"
}
}
This API provides capability to view a Route Aggregation Rule by UUID
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 |
{- "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
- "uuid": "9890d520-1579-4489-8003-154b34b8f403",
- "name": "Private-subnet-aggregation",
- "state": "PROVISIONING",
- "description": "Test rule",
- "change": {
- "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE_CREATION",
- "uuid": "ff9653dc-88c5-47b5-b552-8a08d2f73f7e"
}, - "prefix": "192.168.0.0/24",
- "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z",
- "updatedBy": "testuser",
- "updatedByEmail": "testuser@equinix.com",
- "updatedByFullName": "testuser testuser",
- "updatedDateTime": "2020-05-21T10:30:00Z"
}
}
This API provides capability to replace a Route Aggregation Rule completely
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 |
name | string |
description | string Customer-provided Route Aggregation Rule description |
prefix required | string |
{- "name": "Private-subnet-aggregation-update",
- "description": "Test rule",
- "prefix": "192.168.0.0/24"
}
{- "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
- "uuid": "9890d520-1579-4489-8003-154b34b8f403",
- "name": "Private-subnet-aggregation-update",
- "description": "Test rule",
- "state": "REPROVISIONING",
- "change": {
- "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE_UPDATE",
- "uuid": "a25ca469-721a-4614-89a9-cdef287aa628"
}, - "prefix": "192.168.0.0/24",
- "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z",
- "updatedBy": "testuser1",
- "updatedByEmail": "testuser@equinix.com",
- "updatedByFullName": "testuser testuser",
- "updatedDateTime": "2020-05-21T10:30:00Z"
}
}
This API provides capability to delete a Route aggregation Rule
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 |
{- "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
- "uuid": "9890d520-1579-4489-8003-154b34b8f403",
- "name": "Private-subnet-aggregation",
- "description": "Test rule",
- "state": "DEPROVISIONING",
- "change": {
- "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE_DELETION",
- "uuid": "e8528788-14d3-4a7b-a740-99b702067485"
}, - "prefix": "192.168.0.0/24",
- "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z",
- "updatedBy": "testuser1",
- "updatedByEmail": "testuser@equinix.com",
- "updatedByFullName": "testuser testuser",
- "updatedDateTime": "2020-05-21T10:30:00Z",
- "deletedBy": "testuser1",
- "deletedByEmail": "testuser@equinix.com",
- "deletedByFullName": "testuser testuser",
- "deletedDateTime": "2020-05-21T10:30:00Z"
}
}
This API provides capability to partially update a Route Aggregation Rule
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 |
op required | string Handy shortcut for operation name |
path required | string path to change |
value required | object new value for updated parameter |
[- {
- "op": "replace",
- "path": "/name",
- "value": "test-route-aggregation-name-patch"
}
]
{- "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
- "uuid": "9890d520-1579-4489-8003-154b34b8f403",
- "name": "Private-subnet-aggregation-update",
- "description": "Test rule",
- "state": "REPROVISIONING",
- "change": {
- "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE_UPDATE",
- "uuid": "a25ca469-721a-4614-89a9-cdef287aa628"
}, - "prefix": "192.168.0.0/24",
- "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z",
- "updatedBy": "testuser1",
- "updatedByEmail": "testuser@equinix.com",
- "updatedByFullName": "testuser testuser",
- "updatedDateTime": "2020-05-21T10:30:00Z"
}
}
This API provides capability to retrieve all of a Route Aggregation Rule's Changes
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 |
offset | integer Example: offset=1 offset |
limit | integer Example: limit=10 number of records to fetch |
object (Pagination) Pagination response information | |||||||||||||||||||
| |||||||||||||||||||
Array of objects (RouteAggregationRulesChangeData) | |||||||||||||||||||
Array
|
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 3,
- "next": null,
- "previous": null
}, - "data": [
- {
- "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE_CREATION",
- "uuid": "ff9653dc-88c5-47b5-b552-8a08d2f73f7e",
- "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": {
- "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
- "name": "Private-subnet-aggregation",
- "description": "Test rule",
- "prefix": "192.168.0.0/25"
}
}
]
}
This API provides capability to retrieve a specific Route Aggregation Rule's Changes
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 |
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 |
{- "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE_CREATION",
- "uuid": "ff9653dc-88c5-47b5-b552-8a08d2f73f7e",
- "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": {
- "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
- "name": "Private-subnet-aggregation",
- "description": "Test rule",
- "prefix": "192.168.0.0/25"
}
}
This API provides capability to create bulk route aggregation rules
routeAggregationId required | string (RouteAggregationId) Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Aggregations Id |
Array of objects (RouteAggregationRulesBase) Route Aggregation Rule configuration | |||||||
Array
|
{- "data": [
- {
- "name": "Private-subnet-Aggregation",
- "description": "string",
- "prefix": "192.168.0.0/24"
}
]
}
{- "pagination": {
- "offset": 0,
- "limit": 32,
- "total": 2,
- "next": null,
- "previous": null
}, - "data": [
- {
- "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
- "uuid": "65b025ef-022b-4180-85cf-82cfc1ab655b",
- "name": "Private-subnet-aggregation-2",
- "description": "Test rule",
- "prefix": "192.168.10.0/24",
- "state": "PROVISIONING",
- "change": {
- "type": "IPv4_BGP_PREFIX_AGGREGATION_RULE_CREATION",
- "uuid": "9397f111-19aa-489c-b3c7-349c86818f2d"
}, - "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}, - {
- "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
- "uuid": "ea48337b-fe04-4164-a3f0-48d81abf575b",
- "name": "Private-subnet-aggregation-2",
- "description": "Test rule",
- "prefix": "192.168.20.0/24",
- "state": "PROVISIONING",
- "change": {
- "type": "IPv4_BGP_PREFIX_AGGREGATION_RULE_CREATION",
- "uuid": "9397f111-19aa-489c-b3c7-349c86818f2d"
}, - "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}
]
}
This API provides capability to view all Route Aggregations attached to a Connection
connectionId required | string (ConnectionId) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Connection Id |
object (Pagination) Pagination response information | |||||||||||
| |||||||||||
Array of objects (ConnectionRouteAggregationData) List of Route Aggregations attached to a Connection | |||||||||||
Array
|
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 4,
- "next": null,
- "previous": null
}, - "data": [
- {
- "type": "BGP_IPv4_PREFIX_AGGREGATION",
- "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
- "attachmentStatus": "DETACHING"
}, - {
- "type": "BGP_IPv6_PREFIX_AGGREGATION",
- "uuid": "52f7791a-fe90-49bc-8807-18b3d6eda566",
- "attachmentStatus": "ATTACHED"
}, - {
- "type": "BGP_IPv4_PREFIX_AGGREGATION",
- "uuid": "8b67bf1c-7afa-4a9e-98c3-d5ab17da6652",
- "attachmentStatus": "ATTACHED"
}, - {
- "type": "BGP_IPv6_PREFIX_AGGREGATION",
- "uuid": "65d74639-8f48-4e10-9684-45d364645e97",
- "attachmentStatus": "ATTACHED"
}
]
}
This API provides capability to view a specific Route Aggregation attached to a Connection
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 |
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" |
{- "type": "BGP_IPv4_PREFIX_AGGREGATION",
- "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
- "attachmentStatus": "ATTACHING"
}
This API provides capability to attach a Route Aggregation to a Connection
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 |
{- "type": "BGP_IPv4_PREFIX_AGGREGATION",
- "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
- "attachmentStatus": "ATTACHING"
}
This API provides capability to detach a Route Aggregation from a Connection
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 |
{- "type": "BGP_IPv4_PREFIX_AGGREGATION",
- "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
- "attachmentStatus": "DETACHING"
}
This API provides capability to create a Route Aggregation
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) | ||
|
{- "type": "BGP_IPv4_PREFIX_AGGREGATION",
- "name": "My-route-aggregation-v4",
- "description": "Test aggregation",
- "project": {
- "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}
}
{- "type": "BGP_IPv4_PREFIX_AGGREGATION",
- "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
- "name": "My-prefix-aggregation-v4",
- "description": "Test aggregation",
- "state": "PROVISIONING",
- "change": {
- "type": "BGP_IPv4_PREFIX_AGGREGATION_CREATION",
- "uuid": "04af0d37-9160-43d8-97ef-9da9786996a3"
}, - "rulesCount": 0,
- "connectionsCount": 0,
- "project": {
- "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}, - "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}
This API provides capability to view a Route Aggregation by UUID
routeAggregationId required | string (RouteAggregationId) Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Aggregations Id |
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 | |||||||||||||||||||||||||
|
{- "type": "BGP_IPv4_PREFIX_AGGREGATION",
- "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
- "name": "My-prefix-aggregation-v4",
- "description": "Test aggregation",
- "state": "PROVISIONING",
- "change": {
- "type": "BGP_IPv4_PREFIX_AGGREGATION_CREATION",
- "uuid": "04af0d37-9160-43d8-97ef-9da9786996a3"
}, - "rulesCount": 0,
- "connectionsCount": 0,
- "project": {
- "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}, - "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}
This API provides capability to delete a Route Aggregation
routeAggregationId required | string (RouteAggregationId) Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Aggregations Id |
{- "type": "BGP_IPv4_PREFIX_AGGREGATION",
- "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
- "name": "My-prefix-aggregation-v4",
- "description": "Test Aggregation",
- "state": "DEPROVISIONING",
- "change": {
- "type": "BGP_IPv4_PREFIX_AGGREGATION_DELETION",
- "uuid": "c2ec84c5-6de6-4f5c-b506-3ce218630c31"
}, - "connectionsCount": 0,
- "rulesCount": 0,
- "project": {
- "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}, - "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z",
- "updatedBy": "testuser1",
- "updatedByEmail": "testuser@equinix.com",
- "updatedByFullName": "testuser testuser",
- "updatedDateTime": "2020-05-21T10:30:00Z",
- "deletedBy": "testuser1",
- "deletedByEmail": "testuser@equinix.com",
- "deletedByFullName": "testuser testuser",
- "deletedDateTime": "2020-05-21T10:30:00Z"
}
}
This API provides capability to partially update a Route Aggregation
routeAggregationId required | string (RouteAggregationId) Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Aggregations Id |
op required | string Handy shortcut for operation name |
path required | string path to change |
value required | object new value for updated parameter |
[- {
- "op": "replace",
- "path": "/name",
- "value": "My-route-aggregation-v4-updated"
}
]
{- "type": "BGP_IPv4_PREFIX_AGGREGATION",
- "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
- "name": "My-prefix-aggregation-v4-updated",
- "description": "Test aggregation",
- "state": "REPROVISIONING",
- "change": {
- "type": "BGP_IPv4_PREFIX_AGGREGATION_UPDATE",
- "uuid": "04af0d37-9160-43d8-97ef-9da9786996a3"
}, - "connectionsCount": 1,
- "rulesCount": 0,
- "project": {
- "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}, - "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}
This API provides capability to retrieve all of a Route Aggregation's Changes
routeAggregationId required | string (RouteAggregationId) Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Aggregations Id |
offset | integer Example: offset=1 offset |
limit | integer Example: limit=10 number of records to fetch |
object (Pagination) Pagination response information | |||||||||||||||||||||
| |||||||||||||||||||||
Array of objects (RouteAggregationChangeData) | |||||||||||||||||||||
Array
|
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 4,
- "next": null,
- "previous": null
}, - "data": [
- {
- "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": {
- "type": "BGP_IPv4_PREFIX_AGGREGATION",
- "name": "My-route-aggregation-v4",
- "description": "Test Aggregation",
- "project": {
- "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}
}
}, - {
- "type": "BGP_IPv4_PREFIX_AGGREGATION_UPDATE",
- "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": [
- {
- "op": "replace",
- "path": "/name",
- "value": "My-route-aggregations-v4-updated",
- "previousValue": "My-route-aggregations-v4"
}
]
}
]
}
This API provides capability to retrieve a specific Route Aggregation's Changes
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 |
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 |
{- "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": {
- "type": "BGP_IPv4_PREFIX_AGGREGATION",
- "name": "My-route-aggregation-v4",
- "description": "Test aggregation",
- "project": {
- "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}
}
}
This API provides capability to view all Connections using the Route Aggregation
routeAggregationId required | string (RouteAggregationId) Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Aggregations Id |
object (Pagination) Pagination response information | |||||||||||
| |||||||||||
Array of objects (RouteAggregationConnectionsData) List of Connections using a Route Aggregation | |||||||||||
Array
|
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1,
- "next": null,
- "previous": null
}, - "data": {
- "type": "IP_VC",
- "name": "test-connection",
- "uuid": "05de355a-6c9d-4636-8d7d-7b7595821c15"
}
}
This API provides capability to search Route Aggregations
object (RouteAggregationsSearchBase_filter) | |||||||||||
| |||||||||||
object (Pagination) Pagination response information | |||||||||||
| |||||||||||
Array of objects (RouteAggregationSortItem) | |||||||||||
Array
|
object (Pagination) Pagination response information | |||||||||||||||||||||||
| |||||||||||||||||||||||
Array of objects (RouteAggregationsData) List of Route Aggregations | |||||||||||||||||||||||
Array
|
{- "filter": {
- "and": [
- {
- "property": "/type",
- "operator": "=",
- "values": [
- "BGP_IPv4_PREFIX_AGGREGATION"
]
}, - {
- "property": "/name",
- "operator": "like",
- "values": [
- "%Route_Aggregation_Demo%"
]
}, - {
- "property": "/project/projectId",
- "operator": "=",
- "values": [
- "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
]
}
]
}, - "pagination": {
- "offset": 1,
- "limit": 2,
- "total": 10
}, - "sort": [
- {
- "property": "/changeLog/updatedDateTime",
- "direction": "DESC"
}
]
}
{- "pagination": {
- "offset": 1,
- "limit": 2,
- "total": 10,
- "next": "/routeAggregations?offset=3&limit=2",
- "previous": "/routeAggregations?offset=0&limit=2"
}, - "data": [
- {
- "type": "BGP_IPv4_PREFIX_AGGREGATION",
- "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
- "name": "My_Route_Aggregation_Demo_1",
- "description": "Test aggregation",
- "state": "PROVISIONING",
- "connectionsCount": 1,
- "rulesCount": 0,
- "project": {
- "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}, - "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}, - {
- "type": "BGP_IPv4_PREFIX_AGGREGATION",
- "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
- "name": "My_Route_Aggregation_Demo_2",
- "description": "Test aggregation",
- "state": "PROVISIONING",
- "connectionsCount": 0,
- "rulesCount": 0,
- "project": {
- "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}, - "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}
]
}
This API provides capability to get all Route Filters Rules for Fabric
routeFilterId required | string (RouteFilterId) Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Filters Id |
offset | integer Example: offset=1 offset |
limit | integer Example: limit=10 number of records to fetch |
object (Pagination) Pagination response information | |||||||||||||||||||||||
| |||||||||||||||||||||||
Array of objects (RouteFilterRulesData) List of Route Filter Rules | |||||||||||||||||||||||
Array
|
{- "pagination": {
- "offset": 0,
- "limit": 32,
- "total": 2,
- "next": null,
- "previous": null
}, - "data": [
- {
- "type": "BGP_IPv4_PREFIX_FILTER_RULE",
- "uuid": "65b025ef-022b-4180-85cf-82cfc1ab655b",
- "name": "Private-subnet-filter-2",
- "description": "Test rule",
- "prefixMatch": "exact",
- "action": "PERMIT",
- "prefix": "192.168.10.0/24",
- "state": "PROVISIONED",
- "change": {
- "type": "IPv4_BGP_PREFIX_FILTER_RULE_CREATION",
- "uuid": "9397f111-19aa-489c-b3c7-349c86818f2d"
}, - "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}, - {
- "type": "BGP_IPv4_PREFIX_FILTER_RULE",
- "uuid": "ea48337b-fe04-4164-a3f0-48d81abf575b",
- "name": "Private-subnet-filter-2",
- "description": "Test rule",
- "prefixMatch": "orlonger",
- "action": "PERMIT",
- "prefix": "192.168.20.0/24",
- "state": "PROVISIONED",
- "change": {
- "type": "IPv4_BGP_PREFIX_FILTER_RULE_CREATION",
- "uuid": "9397f111-19aa-489c-b3c7-349c86818f2d"
}, - "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}
]
}
This API provides capability to create a Route Filter Rule
routeFilterId required | string (RouteFilterId) Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Filters Id |
name | string |
description | string Customer-provided Route Filter Rule description |
prefix required | string |
prefixMatch | string Default: "orlonger" |
{- "name": "Private-subnet-filter",
- "description": "Test rule",
- "prefix": "192.168.0.0/24",
- "prefixMatch": "exact"
}
{- "type": "BGP_IPv4_PREFIX_FILTER_RULE",
- "uuid": "9890d520-1579-4489-8003-154b34b8f403",
- "name": "Private-subnet-filter",
- "state": "PROVISIONING",
- "description": "Test rule",
- "change": {
- "type": "BGP_IPv4_PREFIX_FILTER_RULE_CREATION",
- "uuid": "ff9653dc-88c5-47b5-b552-8a08d2f73f7e"
}, - "action": "PERMIT",
- "prefix": "192.168.0.0/24",
- "prefixMatch": "exact",
- "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z",
- "updatedBy": "testuser",
- "updatedByEmail": "testuser@equinix.com",
- "updatedByFullName": "testuser testuser",
- "updatedDateTime": "2020-05-21T10:30:00Z"
}
}
This API provides capability to view a Route Filter Rule by UUID
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 |
{- "type": "BGP_IPv4_PREFIX_FILTER_RULE",
- "uuid": "9890d520-1579-4489-8003-154b34b8f403",
- "name": "Private-subnet-filter",
- "state": "PROVISIONING",
- "description": "Test rule",
- "change": {
- "type": "BGP_IPv4_PREFIX_FILTER_RULE_CREATION",
- "uuid": "ff9653dc-88c5-47b5-b552-8a08d2f73f7e"
}, - "action": "PERMIT",
- "prefix": "192.168.0.0/24",
- "prefixMatch": "exact",
- "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z",
- "updatedBy": "testuser",
- "updatedByEmail": "testuser@equinix.com",
- "updatedByFullName": "testuser testuser",
- "updatedDateTime": "2020-05-21T10:30:00Z"
}
}
This API provides capability to replace a Route Filter Rule completely
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 |
name | string |
description | string Customer-provided Route Filter Rule description |
prefix required | string |
prefixMatch | string Default: "orlonger" |
{- "name": "Private-subnet-filter-update",
- "description": "Test rule",
- "prefix": "192.168.0.0/24",
- "prefixMatch": "exact"
}
{- "type": "BGP_IPv4_PREFIX_FILTER_RULE",
- "uuid": "9890d520-1579-4489-8003-154b34b8f403",
- "name": "Private-subnet-filter-update",
- "description": "Test rule",
- "prefixMatch": "exact",
- "state": "REPROVISIONING",
- "action": "PERMIT",
- "change": {
- "type": "BGP_IPv4_PREFIX_FILTER_RULE_UPDATE",
- "uuid": "a25ca469-721a-4614-89a9-cdef287aa628"
}, - "prefix": "192.168.0.0/24",
- "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z",
- "updatedBy": "testuser1",
- "updatedByEmail": "testuser@equinix.com",
- "updatedByFullName": "testuser testuser",
- "updatedDateTime": "2020-05-21T10:30:00Z"
}
}
This API provides capability to delete a Route Filter Rule
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 |
{- "type": "BGP_IPv4_PREFIX_FILTER_RULE",
- "uuid": "9890d520-1579-4489-8003-154b34b8f403",
- "name": "Private-subnet-filter",
- "description": "Test rule",
- "state": "DEPROVISIONING",
- "change": {
- "type": "BGP_IPv4_PREFIX_FILTER_RULE_DELETION",
- "uuid": "e8528788-14d3-4a7b-a740-99b702067485"
}, - "action": "PERMIT",
- "prefix": "192.168.0.0/24",
- "prefixMatch": "exact",
- "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z",
- "updatedBy": "testuser1",
- "updatedByEmail": "testuser@equinix.com",
- "updatedByFullName": "testuser testuser",
- "updatedDateTime": "2020-05-21T10:30:00Z",
- "deletedBy": "testuser1",
- "deletedByEmail": "testuser@equinix.com",
- "deletedByFullName": "testuser testuser",
- "deletedDateTime": "2020-05-21T10:30:00Z"
}
}
This API provides capability to partially update a Route Filter Rule
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 |
op required | string Handy shortcut for operation name |
path required | string path to change |
value required | object new value for updated parameter |
[- {
- "op": "replace",
- "path": "/name",
- "value": "test-route-filter-name-patch"
}
]
{- "type": "BGP_IPv4_PREFIX_FILTER_RULE",
- "uuid": "9890d520-1579-4489-8003-154b34b8f403",
- "name": "Private-subnet-filter-update",
- "description": "Test rule",
- "prefixMatch": "exact",
- "state": "REPROVISIONING",
- "action": "PERMIT",
- "change": {
- "type": "BGP_IPv4_PREFIX_FILTER_RULE_UPDATE",
- "uuid": "a25ca469-721a-4614-89a9-cdef287aa628"
}, - "prefix": "192.168.0.0/24",
- "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z",
- "updatedBy": "testuser1",
- "updatedByEmail": "testuser@equinix.com",
- "updatedByFullName": "testuser testuser",
- "updatedDateTime": "2020-05-21T10:30:00Z"
}
}
This API provides capability to retrieve all of a Route Filter Rule's Changes
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 |
offset | integer Example: offset=1 offset |
limit | integer Example: limit=10 number of records to fetch |
object (Pagination) Pagination response information | |||||||||||||||||||
| |||||||||||||||||||
Array of objects (RouteFilterRulesChangeData) | |||||||||||||||||||
Array
|
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 3,
- "next": null,
- "previous": null
}, - "data": [
- {
- "type": "BGP_IPv4_PREFIX_FILTER_RULE_CREATION",
- "uuid": "ff9653dc-88c5-47b5-b552-8a08d2f73f7e",
- "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": {
- "type": "BGP_IPv4_PREFIX_FILTER_RULE",
- "name": "Private-subnet-filter",
- "description": "Test rule",
- "prefix": "192.168.0.0/25",
- "prefixMatch": "exact",
- "action": "PERMIT"
}
}, - {
- "type": "BGP_IPv4_PREFIX_FILTER_RULE_UPDATE",
- "uuid": "a40085a4-f0cc-416c-af01-286f7f7ec736",
- "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": [
- {
- "op": "replace",
- "path": "/prefixMatch",
- "value": "orlonger",
- "previousValue": "exact"
}
]
}, - {
- "type": "BGP_IPv4_PREFIX_FILTER_RULE_UPDATE",
- "uuid": "a25ca469-721a-4614-89a9-cdef287aa628",
- "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": [
- {
- "op": "replace",
- "path": "/prefixMatch",
- "value": "exact",
- "previousValue": "orlonger"
}
]
}
]
}
This API provides capability to retrieve a specific Route Filter Rule's Changes
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 |
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 |
{- "type": "BGP_IPv4_PREFIX_FILTER_RULE_CREATION",
- "uuid": "ff9653dc-88c5-47b5-b552-8a08d2f73f7e",
- "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": {
- "type": "BGP_IPv4_PREFIX_FILTER_RULE",
- "name": "Private-subnet-filter",
- "description": "Test rule",
- "prefix": "192.168.0.0/25",
- "prefixMatch": "exact",
- "action": "PERMIT"
}
}
This API provides capability to create bulk route filter rules
routeFilterId required | string (RouteFilterId) Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Filters Id |
Array of objects (RouteFilterRulesBase) Route Filter Rule configuration | |||||||||
Array
|
{- "data": [
- {
- "name": "Private-subnet-filter",
- "description": "string",
- "prefix": "192.168.0.0/24",
- "prefixMatch": "orlonger, exact"
}
]
}
{- "pagination": {
- "offset": 0,
- "limit": 32,
- "total": 2,
- "next": null,
- "previous": null
}, - "data": [
- {
- "type": "BGP_IPv4_PREFIX_FILTER_RULE",
- "uuid": "65b025ef-022b-4180-85cf-82cfc1ab655b",
- "name": "Private-subnet-filter-2",
- "description": "Test rule",
- "prefixMatch": "exact",
- "action": "PERMIT",
- "prefix": "192.168.10.0/24",
- "state": "PROVISIONING",
- "change": {
- "type": "IPv4_BGP_PREFIX_FILTER_RULE_CREATION",
- "uuid": "9397f111-19aa-489c-b3c7-349c86818f2d"
}, - "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}, - {
- "type": "BGP_IPv4_PREFIX_FILTER_RULE",
- "uuid": "ea48337b-fe04-4164-a3f0-48d81abf575b",
- "name": "Private-subnet-filter-2",
- "description": "Test rule",
- "prefixMatch": "orlonger",
- "action": "PERMIT",
- "prefix": "192.168.20.0/24",
- "state": "PROVISIONING",
- "change": {
- "type": "IPv4_BGP_PREFIX_FILTER_RULE_CREATION",
- "uuid": "9397f111-19aa-489c-b3c7-349c86818f2d"
}, - "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}
]
}
This API provides capability to view all Route Filters attached to a Connection
connectionId required | string (ConnectionId) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Connection Id |
object (Pagination) Pagination response information | |||||||||||
| |||||||||||
Array of objects (ConnectionRouteFilterData) List of Route Filters attached to a Connection | |||||||||||
Array
|
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 4,
- "next": null,
- "previous": null
}, - "data": [
- {
- "type": "BGP_IPv4_PREFIX_FILTER",
- "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
- "attachmentStatus": "DETACHING",
- "direction": "INBOUND"
}, - {
- "type": "BGP_IPv6_PREFIX_FILTER",
- "uuid": "52f7791a-fe90-49bc-8807-18b3d6eda566",
- "attachmentStatus": "ATTACHED",
- "direction": "INBOUND"
}, - {
- "type": "BGP_IPv4_PREFIX_FILTER",
- "uuid": "8b67bf1c-7afa-4a9e-98c3-d5ab17da6652",
- "attachmentStatus": "ATTACHED",
- "direction": "OUTBOUND"
}, - {
- "type": "BGP_IPv6_PREFIX_FILTER",
- "uuid": "65d74639-8f48-4e10-9684-45d364645e97",
- "attachmentStatus": "ATTACHED",
- "direction": "OUTBOUND"
}
]
}
This API provides capability to view a specific Route Filter attached to a Connection
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 |
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" |
{- "type": "BGP_IPv4_PREFIX_FILTER",
- "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
- "attachmentStatus": "ATTACHING",
- "direction": "INBOUND"
}
This API provides capability to attach a Route Filter to a Connection
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 |
direction required | string Enum: "INBOUND" "OUTBOUND" Route Filter direction to attach to a connection |
{- "direction": "INBOUND"
}
{- "type": "BGP_IPv4_PREFIX_FILTER",
- "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
- "attachmentStatus": "ATTACHING",
- "direction": "INBOUND"
}
This API provides capability to detach a Route Filter from a Connection
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 |
{- "type": "BGP_IPv4_PREFIX_FILTER",
- "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
- "attachmentStatus": "DETACHING",
- "direction": "INBOUND"
}
This API provides capability to create a Route Filter
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) | ||
|
{- "type": "BGP_IPv4_PREFIX_FILTER",
- "name": "My-route-filter-v4",
- "description": "Test filter",
- "project": {
- "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}, - "notifications": {
- "type": "ALL",
- "emails": [
- "test@equinix.com"
]
}
}
{- "type": "BGP_IPv4_PREFIX_FILTER",
- "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
- "name": "My-prefix-filter-v4",
- "description": "Test filter",
- "state": "PROVISIONING",
- "change": {
- "type": "BGP_IPv4_PREFIX_FILTER_CREATION",
- "uuid": "04af0d37-9160-43d8-97ef-9da9786996a3"
}, - "notMatchedRuleAction": "DENY",
- "connectionsCount": 0,
- "project": {
- "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}, - "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}
This API provides capability to view a Route Filter by UUID
routeFilterId required | string (RouteFilterId) Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Filters Id |
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 | |||||||||||||||||||||||||
|
{- "type": "BGP_IPv4_PREFIX_FILTER",
- "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
- "name": "My-prefix-filter-v4",
- "description": "Test filter",
- "state": "PROVISIONING",
- "change": {
- "type": "BGP_IPv4_PREFIX_FILTER_CREATION",
- "uuid": "04af0d37-9160-43d8-97ef-9da9786996a3"
}, - "notMatchedRuleAction": "DENY",
- "connectionsCount": 0,
- "project": {
- "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}, - "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}
This API provides capability to delete a Route Filter
routeFilterId required | string (RouteFilterId) Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Filters Id |
{- "type": "BGP_IPv4_PREFIX_FILTER",
- "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
- "name": "My-prefix-filter-v4",
- "description": "Test filter",
- "state": "DEPROVISIONING",
- "change": {
- "type": "BGP_IPv4_PREFIX_FILTER_DELETION",
- "uuid": "c2ec84c5-6de6-4f5c-b506-3ce218630c31"
}, - "notMatchedRuleAction": "DENY",
- "connectionsCount": 0,
- "project": {
- "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}, - "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z",
- "updatedBy": "testuser1",
- "updatedByEmail": "testuser@equinix.com",
- "updatedByFullName": "testuser testuser",
- "updatedDateTime": "2020-05-21T10:30:00Z",
- "deletedBy": "testuser1",
- "deletedByEmail": "testuser@equinix.com",
- "deletedByFullName": "testuser testuser",
- "deletedDateTime": "2020-05-21T10:30:00Z"
}
}
This API provides capability to partially update a Route Filter
routeFilterId required | string (RouteFilterId) Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Filters Id |
op required | string Handy shortcut for operation name |
path required | string path to change |
value required | object new value for updated parameter |
[- {
- "op": "replace",
- "path": "/name",
- "value": "My-route-filter-v4-updated"
}
]
{- "type": "BGP_IPv4_PREFIX_FILTER",
- "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
- "name": "My-prefix-filter-v4-updated",
- "description": "Test filter",
- "state": "REPROVISIONING",
- "change": {
- "type": "BGP_IPv4_PREFIX_FILTER_UPDATE",
- "uuid": "04af0d37-9160-43d8-97ef-9da9786996a3"
}, - "notMatchedRuleAction": "DENY",
- "connectionsCount": 1,
- "project": {
- "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}, - "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}
This API provides capability to retrieve all of a Route Filter's Changes
routeFilterId required | string (RouteFilterId) Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Filters Id |
offset | integer Example: offset=1 offset |
limit | integer Example: limit=10 number of records to fetch |
object (Pagination) Pagination response information | |||||||||||||||||||||
| |||||||||||||||||||||
Array of objects (RouteFilterChangeData) | |||||||||||||||||||||
Array
|
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 4,
- "next": null,
- "previous": null
}, - "data": [
- {
- "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": {
- "type": "BGP_IPv4_PREFIX_FILTER",
- "name": "My-route-filter-v4",
- "description": "Test filter",
- "project": {
- "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}
}
}, - {
- "type": "BGP_IPv4_PREFIX_FILTER_UPDATE",
- "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": [
- {
- "op": "replace",
- "path": "/name",
- "value": "My-route-filter-v4-updated",
- "previousValue": "My-route-filter-v4"
}
]
}
]
}
This API provides capability to retrieve a specific Route Filter's Changes
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 |
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 |
{- "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": {
- "type": "BGP_IPv4_PREFIX_FILTER",
- "name": "My-route-filter-v4",
- "description": "Test filter",
- "project": {
- "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}
}
}
This API provides capability to view all Connections using the Route Filter
routeFilterId required | string (RouteFilterId) Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d Route Filters Id |
object (Pagination) Pagination response information | |||||||||||
| |||||||||||
Array of objects (RouteFilterConnectionsData) List of Connections using a Route Filter | |||||||||||
Array
|
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1,
- "next": null,
- "previous": null
}, - "data": {
- "type": "IP_VC",
- "name": "test-connection",
- "uuid": "05de355a-6c9d-4636-8d7d-7b7595821c15"
}
}
This API provides capability to search Route Filters
object (RouteFiltersSearchBase_filter) | |||||||||||
| |||||||||||
object (Pagination) Pagination response information | |||||||||||
| |||||||||||
Array of objects (SortItem) | |||||||||||
Array
|
object (Pagination) Pagination response information | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Array of objects (RouteFiltersData) List of route filters | |||||||||||||||||||||||||
Array
|
{- "filter": {
- "and": [
- {
- "property": "/type",
- "operator": "=",
- "values": [
- "BGP_IPv4_PREFIX_FILTER"
]
}, - {
- "property": "/name",
- "operator": "like",
- "values": [
- "%Route_Filter_Demo%"
]
}, - {
- "property": "/project/projectId",
- "operator": "=",
- "values": [
- "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
]
}
]
}, - "pagination": {
- "offset": 1,
- "limit": 2,
- "total": 10
}, - "sort": [
- {
- "property": "/changeLog/updatedDateTime",
- "direction": "DESC"
}
]
}
{- "pagination": {
- "offset": 1,
- "limit": 2,
- "total": 10,
- "next": "/routeFilters?offset=3&limit=2",
- "previous": "/routeFilters?offset=0&limit=2"
}, - "data": [
- {
- "type": "BGP_IPv4_PREFIX_FILTER",
- "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
- "name": "My_Route_Filter_Demo_1",
- "description": "Test filter",
- "state": "PROVISIONING",
- "notMatchedRuleAction": "DENY",
- "connectionsCount": 1,
- "project": {
- "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}, - "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}, - {
- "type": "BGP_IPv4_PREFIX_FILTER",
- "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
- "name": "My_Route_Filter_Demo_2",
- "description": "Test filter",
- "state": "PROVISIONING",
- "notMatchedRuleAction": "DENY",
- "connectionsCount": 0,
- "project": {
- "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}, - "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}
]
}
This API provides capability to get Routing Protocols for connections
connectionId required | string (ConnectionId) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Connection Id |
offset | integer Example: offset=1 offset |
limit | integer Example: limit=10 number of records to fetch |
object (Pagination) Pagination response information | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
Array of RoutingProtocolBGPData (object) or RoutingProtocolDirectData (object) (RoutingProtocolData) List of Routing Protocols | |||||||||||||||||||||||||||||||
Array One of
|
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 2
}, - "data": [
- {
- "uuid": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
- "state": "PROVISIONING",
- "change": {
- "uuid": "3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
- "type": "ROUTING_PROTOCOL_CREATION"
}, - "changelog": {
- "createdBy": "abc@xyz.com",
- "createdByFullName": "abc",
- "createdByEmail": "abc@xyz.com",
- "createdDateTime": "2021-10-30T07:21:39Z",
- "updatedBy": "abc@xyz.com",
- "updatedByFullName": "abc",
- "updatedByEmail": "abc@xyz.com",
- "updatedDateTime": "2021-10-30T07:21:39Z"
}, - "type": "BGP",
- "bgpIpv4": {
- "customerPeerIp": "192.168.100.2",
- "enabled": true,
- "outboundASPrependCount": 3,
- "inboundMED": 1000,
- "outboundMED": 2000,
- "routesMax": 40,
- "operation": {
- "operationalStatus": "UNKNOWN"
}
}, - "customerAsn": 10000,
- "equinixAsn": 10001,
- "asOverrideEnabled": true
}, - {
- "uuid": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
- "state": "PROVISIONING",
- "change": {
- "uuid": "3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
- "type": "ROUTING_PROTOCOL_CREATION"
}, - "changelog": {
- "createdBy": "abc@xyz.com",
- "createdByFullName": "abc",
- "createdByEmail": "abc@xyz.com",
- "createdDateTime": "2021-10-30T07:21:39Z",
- "updatedBy": "abc@xyz.com",
- "updatedByFullName": "abc",
- "updatedByEmail": "abc@xyz.com",
- "updatedDateTime": "2021-10-30T07:21:39Z"
}, - "type": "DIRECT",
- "directIpv4": {
- "equinixIfaceIp": "192.168.100.1/30"
}
}
]
}
This API provides capability to create Routing Protocol for connections
connectionId required | string (ConnectionId) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Connection Id |
type required | string Enum: "BGP" "DIRECT" Routing protocol type | ||||||||||||||||||||||
name | string | ||||||||||||||||||||||
object (BGPConnectionIpv4) | |||||||||||||||||||||||
| |||||||||||||||||||||||
object (BGPConnectionIpv6) | |||||||||||||||||||||||
| |||||||||||||||||||||||
customerAsn | integer <int64> Customer asn | ||||||||||||||||||||||
equinixAsn | integer <int64> Equinix asn | ||||||||||||||||||||||
bgpAuthKey | string BGP authorization key | ||||||||||||||||||||||
asOverrideEnabled | boolean Enable AS number override | ||||||||||||||||||||||
object (RoutingProtocolBFD) | |||||||||||||||||||||||
|
{- "type": "DIRECT",
- "directIpv4": {
- "equinixIfaceIp": "192.168.100.1/30"
}, - "directIpv6": {
- "equinixIfaceIp": "2001:7a9::34f4:0:f3dd:1/126"
}
}
{- "uuid": "557400f8-d360-11e9-bb65-2a2ae2dbcce4",
- "state": "PROVISIONING",
- "change": {
- "uuid": "3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
- "type": "ROUTING_PROTOCOL_CREATION"
}, - "changelog": {
- "createdBy": "abc@xyz.com",
- "createdByFullName": "abc",
- "createdByEmail": "abc@xyz.com",
- "createdDateTime": "2021-10-30T07:21:39Z",
- "updatedBy": "abc@xyz.com",
- "updatedByFullName": "abc",
- "updatedByEmail": "abc@xyz.com",
- "updatedDateTime": "2021-10-30T07:21:39Z"
}, - "type": "BGP",
- "bgpIpv4": {
- "customerPeerIp": "10.1.1.3",
- "enabled": true,
- "outboundASPrependCount": 3,
- "inboundMED": 1000,
- "outboundMED": 2000,
- "routesMax": 40,
- "operation": {
- "operationalStatus": "UNKNOWN"
}
}, - "customerAsn": 10000,
- "equinixAsn": 10001,
- "asOverrideEnabled": true
}
This API provides capability to create Routing Protocol for connections
connectionId required | string (ConnectionId) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Connection Id |
Array of RoutingProtocolBGPType (object) or RoutingProtocolDirectType (object) (RoutingProtocolBase) Connection routing protocol configuration | |||||||||||||||||||
Array One of
|
{- "data": [
- {
- "type": "DIRECT",
- "directIpv4": {
- "equinixIfaceIp": "192.168.100.1/30"
}, - "directIpv6": {
- "equinixIfaceIp": "2001:7a9::34f4:0:f3dd:1/126"
}
}
]
}
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 2
}, - "data": [
- {
- "uuid": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
- "state": "PROVISIONING",
- "change": {
- "uuid": "3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
- "type": "ROUTING_PROTOCOL_CREATION"
}, - "changelog": {
- "createdBy": "abc@xyz.com",
- "createdByFullName": "abc",
- "createdByEmail": "abc@xyz.com",
- "createdDateTime": "2021-10-30T07:21:39Z",
- "updatedBy": "abc@xyz.com",
- "updatedByFullName": "abc",
- "updatedByEmail": "abc@xyz.com",
- "updatedDateTime": "2021-10-30T07:21:39Z"
}, - "type": "BGP",
- "bgpIpv4": {
- "customerPeerIp": "192.168.100.2",
- "enabled": true,
- "outboundASPrependCount": 3,
- "inboundMED": 1000,
- "outboundMED": 2000,
- "routesMax": 40,
- "operation": {
- "operationalStatus": "UNKNOWN"
}
}, - "customerAsn": 10000,
- "equinixAsn": 10001,
- "asOverrideEnabled": true
}, - {
- "uuid": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
- "state": "PROVISIONING",
- "change": {
- "uuid": "3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
- "type": "ROUTING_PROTOCOL_CREATION"
}, - "changelog": {
- "createdBy": "abc@xyz.com",
- "createdByFullName": "abc",
- "createdByEmail": "abc@xyz.com",
- "createdDateTime": "2021-10-30T07:21:39Z",
- "updatedBy": "abc@xyz.com",
- "updatedByFullName": "abc",
- "updatedByEmail": "abc@xyz.com",
- "updatedDateTime": "2021-10-30T07:21:39Z"
}, - "type": "DIRECT",
- "directIpv4": {
- "equinixIfaceIp": "192.168.100.1/30"
}
}
]
}
This API provides capability to accept/reject user's virtual connection
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 |
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 | |||||||||||||||||||||||||
|
{- "uuid": "557400f8-d360-11e9-bb65-2a2ae2dbcce4",
- "state": "PROVISIONING",
- "change": {
- "uuid": "3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
- "type": "ROUTING_PROTOCOL_CREATION"
}, - "changelog": {
- "createdBy": "abc@xyz.com",
- "createdByFullName": "abc",
- "createdByEmail": "abc@xyz.com",
- "createdDateTime": "2021-10-30T07:21:39Z",
- "updatedBy": "abc@xyz.com",
- "updatedByFullName": "abc",
- "updatedByEmail": "abc@xyz.com",
- "updatedDateTime": "2021-10-30T07:21:39Z"
}, - "type": "BGP",
- "bgpIpv4": {
- "customerPeerIp": "10.1.1.3",
- "enabled": true,
- "outboundASPrependCount": 3,
- "inboundMED": 1000,
- "outboundMED": 2000,
- "routesMax": 40,
- "operation": {
- "operationalStatus": "UNKNOWN"
}
}, - "customerAsn": 10000,
- "equinixAsn": 10001,
- "asOverrideEnabled": true
}
This API provides capability to replace complete Routing Protocols on a virtual connection
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 |
type required | string Enum: "BGP" "DIRECT" Routing protocol type | ||||||||||||||||||||||
name | string | ||||||||||||||||||||||
object (BGPConnectionIpv4) | |||||||||||||||||||||||
| |||||||||||||||||||||||
object (BGPConnectionIpv6) | |||||||||||||||||||||||
| |||||||||||||||||||||||
customerAsn | integer <int64> Customer asn | ||||||||||||||||||||||
equinixAsn | integer <int64> Equinix asn | ||||||||||||||||||||||
bgpAuthKey | string BGP authorization key | ||||||||||||||||||||||
asOverrideEnabled | boolean Enable AS number override | ||||||||||||||||||||||
object (RoutingProtocolBFD) | |||||||||||||||||||||||
|
{- "type": "DIRECT",
- "directIpv4": {
- "equinixIfaceIp": "192.168.100.1/30"
}, - "directIpv6": {
- "equinixIfaceIp": "2001:7a9::34f4:0:f3dd:1/126"
}
}
{- "uuid": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
- "state": "REPROVISIONING",
- "change": {
- "uuid": "3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
- "type": "ROUTING_PROTOCOL_UPDATE"
}, - "changelog": {
- "createdBy": "abc@xyz.com",
- "createdByFullName": "abc",
- "createdByEmail": "abc@xyz.com",
- "createdDateTime": "2021-10-30T07:21:39Z",
- "updatedBy": "abc@xyz.com",
- "updatedByFullName": "abc",
- "updatedByEmail": "abc@xyz.com",
- "updatedDateTime": "2021-10-30T07:21:39Z"
}, - "type": "BGP",
- "bgpIpv4": {
- "customerPeerIp": "10.1.1.3",
- "enabled": true,
- "outboundASPrependCount": 3,
- "inboundMED": 1000,
- "outboundMED": 2000,
- "routesMax": 40,
- "operation": {
- "operationalStatus": "UNKNOWN"
}
}, - "customerAsn": 10000,
- "equinixAsn": 10001,
- "asOverrideEnabled": true
}
This API provides capability to delete Routing Protocols on virtual connection
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 |
{- "uuid": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
- "state": "DEPROVISIONING",
- "change": {
- "uuid": "3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
- "type": "ROUTING_PROTOCOL_DELETION"
}, - "changelog": {
- "createdBy": "abc@xyz.com",
- "createdByFullName": "abc",
- "createdByEmail": "abc@xyz.com",
- "createdDateTime": "2021-10-30T07:21:39Z",
- "updatedBy": "abc@xyz.com",
- "updatedByFullName": "abc",
- "updatedByEmail": "abc@xyz.com",
- "updatedDateTime": "2021-10-30T07:21:39Z",
- "deletedBy": "abc@xyz.com",
- "deletedByFullName": "abc",
- "deletedByEmail": "abc@xyz.com",
- "deletedDateTime": "2021-10-30T07:21:39Z"
}, - "type": "DIRECT",
- "directIpv4": {
- "equinixIfaceIp": "192.168.100.1/30"
}
}
This API provides capability to partially update Routing Protocols on a virtual connection
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 |
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 |
[- {
- "op": "replace",
- "path": "/bgpIpv4/enabled",
- "value": true
}
]
{- "uuid": "c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
- "state": "REPROVISIONING",
- "change": {
- "uuid": "3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
- "type": "ROUTING_PROTOCOL_UPDATE"
}, - "changelog": {
- "createdBy": "abc@xyz.com",
- "createdByFullName": "abc",
- "createdByEmail": "abc@xyz.com",
- "createdDateTime": "2021-10-30T07:21:39Z",
- "updatedBy": "abc@xyz.com",
- "updatedByFullName": "abc",
- "updatedByEmail": "abc@xyz.com",
- "updatedDateTime": "2021-10-30T07:21:39Z"
}, - "type": "BGP",
- "bgpIpv4": {
- "enabled": true,
- "customerPeerIp": "10.1.1.3",
- "outboundASPrependCount": 3,
- "operation": {
- "operationalStatus": "UNKNOWN"
}
}, - "customerAsn": 10000,
- "equinixAsn": 10001
}
This API provides capability to get all BGP actions status
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 |
offset | integer Example: offset=1 offset |
limit | integer Example: limit=10 number of records to fetch |
object (Pagination) Pagination response information | |||||||||||||
| |||||||||||||
Array of objects (BGPActionData) | |||||||||||||
Array
|
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 2
}, - "data": [
- {
- "uuid": "835ed234-1dbb-5634-c320-25d0234dd117",
- "type": "CLEAR_BGPIPV6_INBOUND",
- "description": "soft clear bgp ipv6 inbound session",
- "state": "SUCCEEDED",
- "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:30:00Z",
- "updatedBy": "testuser",
- "updatedByEmail": "testuser@equinix.com",
- "updatedByFullName": "testuser testuser",
- "updatedDateTime": "2020-05-21T10:35:00Z"
}
}, - {
- "uuid": "995ed98b-1db9-6653-c323-19d0234dd999",
- "type": "CLEAR_BGPIPV4_INBOUND",
- "description": "soft clear bgp ipv4 inbound session",
- "state": "FAILED",
- "changeLog": {
- "createdBy": "testuser",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "createdDateTime": "2020-05-21T10:20:00Z",
- "updatedBy": "testuser",
- "updatedByEmail": "testuser@equinix.com",
- "updatedByFullName": "testuser testuser",
- "updatedDateTime": "2020-05-21T10:25:00Z"
}
}
]
}
This API provides capability to clear/reset Routing Protocols BGP session
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 |
type required | string (BGPActions) Enum: "CLEAR_BGPIPV4" "CLEAR_BGPIPV6" "CLEAR_BGPIPV4_INBOUND" "CLEAR_BGPIPV6_INBOUND" "RESET_BGPIPV4" "RESET_BGPIPV6" BGP action type |
{- "type": "CLEAR_BGPIPV4"
}
{- "uuid": "123ed98a-92ba-9951-bb17-17d0234dd096",
- "type": "RESET_BGPIPV4",
- "description": "hard reset bgp ipv4 session",
- "state": "PENDING",
- "changeLog": {
- "createdBy": "adminuser",
- "createdByEmail": "adminuser@equinix.com",
- "createdByFullName": "adminuser adminuser",
- "createdDateTime": "2020-05-21T10:30:00Z"
}
}
This API provides capability to retrieve specific BGP action
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 |
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 | |||||||||||||||||||||||||
|
{- "uuid": "4e5ed00a-3dca-5652-b319-aad0234dd934",
- "type": "CLEAR_BGPIPV6_INBOUND",
- "description": "soft clear bgp ipv6 inbound session",
- "state": "SUCCEEDED",
- "changeLog": {
- "createdBy": "adminuser",
- "createdByEmail": "adminuser@equinix.com",
- "createdByFullName": "adminuser adminuser",
- "createdDateTime": "2020-05-21T10:30:00Z",
- "updatedBy": "adminuser",
- "updatedByEmail": "adminuser@equinix.com",
- "updatedByFullName": "adminuser adminuser",
- "updatedDateTime": "2020-05-21T10:35:00Z"
}
}
This API provides capability to retrieve specific Routing Protocol Change
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 |
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 |
{- "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": {
- "op": "replace",
- "path": "/",
- "value": {
- "type": "BGP",
- "name": "My-BGP-route-1",
- "bgpIpv4": {
- "customerPeerIp": "10.1.1.2",
- "equinixPeerIp": "10.1.1.3",
- "outboundASPrependCount": 3,
- "inboundMED": 1000,
- "outboundMED": 2000,
- "routesMax": 40,
- "operation": {
- "operationalStatus": "UP",
- "opStatusChangedAt": "2021-10-30T07:21:39Z"
}
}, - "bgpIpv6": {
- "customerPeerIp": "2001:db8:c59b::1",
- "equinixPeerIp": "2001:db8:c59b::1",
- "outboundASPrependCount": 3,
- "inboundMED": 1000,
- "outboundMED": 2000,
- "routesMax": 40,
- "operation": {
- "operationalStatus": "UP",
- "opStatusChangedAt": "2021-10-30T07:21:39Z"
}
}, - "customerAsn": 0,
- "equinixAsn": 0,
- "asOverrideEnabled": true,
- "bgpAuthKey": "string",
- "bfd": {
- "enabled": true,
- "interval": "100"
}
}
}
}
This API provides capability to retrieve user's Routing Protocol Changes
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 |
offset | integer Example: offset=1 offset |
limit | integer Example: limit=10 number of records to fetch |
object (Pagination) Pagination response information | |||||||||||||||||||||
| |||||||||||||||||||||
Array of objects (RoutingProtocolChangeData) | |||||||||||||||||||||
Array
|
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1
}, - "data": [
- {
- "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": {
- "op": "replace",
- "path": "/",
- "value": {
- "type": "BGP",
- "name": "My-BGP-route-1",
- "bgpIpv4": {
- "customerPeerIp": "10.1.1.2",
- "equinixPeerIp": "10.1.1.3",
- "outboundASPrependCount": 3,
- "inboundMED": 1000,
- "outboundMED": 2000,
- "routesMax": 40,
- "operation": {
- "operationalStatus": "UP",
- "opStatusChangedAt": "2021-10-30T07:21:39Z"
}
}, - "bgpIpv6": {
- "customerPeerIp": "2001:db8:c59b::1",
- "equinixPeerIp": "2001:db8:c59b::1",
- "outboundASPrependCount": 3,
- "inboundMED": 1000,
- "outboundMED": 2000,
- "routesMax": 40,
- "operation": {
- "operationalStatus": "UP",
- "opStatusChangedAt": "2021-10-30T07:21:39Z"
}
}, - "customerAsn": 0,
- "equinixAsn": 0,
- "bgpAuthKey": "string",
- "asOverrideEnabled": true,
- "bfd": {
- "enabled": true,
- "interval": "100"
}
}
}
}, - {
- "type": "ROUTING_PROTOCOL_CREATION",
- "uuid": "4b17da68-3d6b-436d-9c8f-2105f3b950d9",
- "status": "COMPLETED",
- "createdDateTime": "2020-05-21T10:30:00Z",
- "updatedDateTime": "2020-05-21T10:30:50Z",
- "data": {
- "op": "add",
- "path": "/",
- "value": {
- "type": "BGP",
- "name": "My-BGP-route-1",
- "bgpIpv4": {
- "customerPeerIp": "10.1.1.3",
- "equinixPeerIp": "10.1.1.4",
- "operation": {
- "operationalStatus": "UP",
- "opStatusChangedAt": "2021-10-30T07:21:39Z"
}
}, - "bgpIpv6": {
- "customerPeerIp": "2001:db8:c59b::1",
- "equinixPeerIp": "2001:db8:c59b::1",
- "operation": {
- "operationalStatus": "UP",
- "opStatusChangedAt": "2021-10-30T07:21:39Z"
}
}, - "customerAsn": 0,
- "equinixAsn": 0,
- "bgpAuthKey": "string",
- "bfd": {
- "enabled": true,
- "interval": "100"
}
}
}
}
]
}
This API provides capability to validate all subnets associated with any connection in the given FCR
routerId required | string <uuid> (RouterId) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Cloud Router UUID |
object (ValidateRequest_filter) Filters | |||||||||||
|
Array of objects (ConnectionSideAdditionalInfo) Additional information | |||||
Array
|
{- "filter": {
- "and": [
- {
- "property": "/directIpv4/equinixIfaceIp",
- "operator": "=",
- "values": [
- "10.1.1.1/30"
]
}, - {
- "property": "/connection/uuid",
- "operator": "=",
- "values": [
- "a96f16d3-e504-44a7-a628-4916b5750008"
]
}
]
}
}
{- "additionalInfo": [
- {
- "key": "message",
- "value": "The provided subnet is valid."
}
]
}
The API request returns all Equinix Fabric Service Profiles in accordance with the view point requested.
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 |
Array of objects (ServiceProfile) | |||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||
object (Pagination) Pagination response information | |||||||||||||||||||||||||||||||||||||||||||
|
{- "data": [
- {
- "state": "ACTIVE",
- "account": {
- "organizationName": "testSeller-270010"
}, - "changeLog": {
- "createdBy": "fusiontestseller",
- "createdByFullName": "fusiontestSeller fusiontestSeller",
- "createdByEmail": "fusiontestSeller@equinix.com",
- "createdDateTime": "2022-04-12T19:06:57.940Z",
- "updatedBy": "fusiontestseller",
- "updatedByFullName": "fusiontestSeller fusiontestSeller",
- "updatedByEmail": "fusiontestSeller@equinix.com",
- "updatedDateTime": "2022-04-12T19:11:04.017Z"
}, - "type": "L2_PROFILE",
- "name": "Service Profile 2",
- "uuid": "ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
- "description": "Sample_description",
- "visibility": "PUBLIC",
- "allowedEmails": [
- "test@equinix.com",
- "testagain@equinix.com"
], - "accessPointTypeConfigs": [
- {
- "type": "COLO",
- "uuid": "f20c49cd-b022-4aeb-b3e4-49db4389aff3",
- "supportedBandwidths": [
- 100,
- 500
], - "allowRemoteConnections": false,
- "allowCustomBandwidth": true,
- "allowBandwidthAutoApproval": false,
- "linkProtocolConfig": {
- "encapsulationStrategy": "CTAGED",
- "reuseVlanSTag": false,
- "encapsulation": "DOT1Q"
}, - "enableAutoGenerateServiceKey": false,
- "connectionRedundancyRequired": false,
- "apiConfig": {
- "apiAvailable": false,
- "bandwidthFromApi": false
}, - "connectionLabel": "true1",
- "authenticationKey": {
- "required": false,
- "label": "Service Key"
}
}
], - "marketingInfo": {
- "promotion": true
}, - "metros": [
- {
- "code": "SY",
- "name": "Sydney",
- "ibxs": [
- "SY4"
], - "displayName": "Sydney"
}
], - "selfProfile": true
}
], - "pagination": {
- "offset": 0,
- "limit": 1,
- "total": 52,
- "next": "/serviceProfiles?offset=1&limit=1"
}
}
Create Service Profile creates Equinix Fabric? Service Profile.
object (Project) | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
type required | string (ServiceProfileTypeEnum) Enum: "L2_PROFILE" "L3_PROFILE" "IA_PROFILE" Service profile type | ||||||||||||||||||||||||||||||
name required | string <= 50 characters Customer-assigned service profile name | ||||||||||||||||||||||||||||||
uuid | string <uuid> Equinix-assigned service profile identifier | ||||||||||||||||||||||||||||||
description required | string User-provided service description should be of maximum length 375 | ||||||||||||||||||||||||||||||
Array of objects (SimplifiedNotification) Recipients of notifications on service profile change | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||||||
Array of objects (CustomField) | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
object (MarketingInfo) | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
Array of objects (ServiceProfileAccessPointCOLO) | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
Array of objects (ServiceProfileAccessPointVD) | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
Array of objects (ServiceMetro) Derived response attribute. | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
selfProfile | boolean response attribute indicates whether the profile belongs to the same organization as the api-invoker. | ||||||||||||||||||||||||||||||
projectId | string |
ETag | string response header - identifier for a specific version of a resource. |
state | string (ServiceProfileStateEnum) Enum: "ACTIVE" "PENDING_APPROVAL" "DELETED" "REJECTED" Equinix assigned state. | ||||||||||||||||||||||||||||||
object Seller Account for Service Profile. | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
object Seller Account for Service Profile. | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
href | string <uri> Service Profile URI response attribute | ||||||||||||||||||||||||||||||
type | string (ServiceProfileTypeEnum) Enum: "L2_PROFILE" "L3_PROFILE" "IA_PROFILE" Service profile type | ||||||||||||||||||||||||||||||
name | string <= 50 characters Customer-assigned service profile name | ||||||||||||||||||||||||||||||
uuid | string <uuid> Equinix-assigned service profile identifier | ||||||||||||||||||||||||||||||
description | string User-provided service description should be of maximum length 375 | ||||||||||||||||||||||||||||||
Array of objects (SimplifiedNotification) Recipients of notifications on service profile change | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||||||
Array of objects (CustomField) | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
object (MarketingInfo) | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
Array of objects (ServiceProfileAccessPointCOLO) | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
Array of objects (ServiceProfileAccessPointVD) | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
Array of objects (ServiceMetro) Derived response attribute. | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
selfProfile | boolean response attribute indicates whether the profile belongs to the same organization as the api-invoker. | ||||||||||||||||||||||||||||||
projectId | string |
{- "name": "Service Profile 1",
- "description": "Sample_description",
- "type": "L2_PROFILE",
- "notifications": [
- {
- "emails": [
- "someone@sample.com"
], - "type": "BANDWIDTH_ALERT"
}
], - "visibility": "PUBLIC",
- "allowedEmails": [
- "test@equinix.com",
- "testagain@equinix.com"
], - "ports": [
- {
- "uuid": "c791f8cb-5cc9-cc90-8ce0-306a5c00a4ee",
- "type": "XF_PORT",
- "location": {
- "metroCode": "SY"
}
}
], - "marketingInfo": {
- "promotion": true
}, - "accessPointTypeConfigs": [
- {
- "type": "COLO",
- "connectionRedundancyRequired": false,
- "allowBandwidthAutoApproval": false,
- "allowRemoteConnections": true,
- "connectionLabel": "Service Profile 1",
- "enableAutoGenerateServiceKey": false,
- "bandwidthAlertThreshold": 10,
- "allowCustomBandwidth": true,
- "apiConfig": {
- "apiAvailable": false,
- "equinixManagedVlan": false,
- "bandwidthFromApi": false,
- "integrationId": null,
- "equinixManagedPort": false
}, - "authenticationKey": {
- "required": false,
- "label": "Service Key",
- "description": "XYZ"
}, - "supportedBandwidths": [
- 100,
- 500
]
}
]
}
{- "state": "PENDING_APPROVAL",
- "account": {
- "orgId": 91785,
- "globalOrgId": "0016u000003JZ4tAAG"
}, - "changeLog": {
- "createdDateTime": "2022-04-12T19:06:57.940Z"
}, - "type": "L2_PROFILE",
- "name": "Service Profile 1",
- "uuid": "ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
- "description": "Sample_description",
- "notifications": [
- {
- "type": "BANDWIDTH_ALERT",
- "emails": [
- "someone@sample.com"
]
}, - {
- "type": "CONNECTION_APPROVAL",
- "emails": [
- "someone@sample.com"
]
}, - {
- "type": "PROFILE_LIFECYCLE",
- "emails": [
- "someone@sample.com"
]
}
], - "visibility": "PUBLIC",
- "allowedEmails": [
- "test@equinix.com",
- "testagain@equinix.com"
], - "accessPointTypeConfigs": [
- {
- "type": "COLO",
- "uuid": "f20c49cd-b022-4aeb-b3e4-49db4389aff3",
- "supportedBandwidths": [
- 100,
- 500
], - "allowRemoteConnections": false,
- "allowCustomBandwidth": true,
- "bandwidthAlertThreshold": 10,
- "allowBandwidthAutoApproval": false,
- "linkProtocolConfig": {
- "encapsulationStrategy": "CTAGED",
- "reuseVlanSTag": false,
- "encapsulation": "DOT1Q"
}, - "enableAutoGenerateServiceKey": false,
- "connectionRedundancyRequired": false,
- "apiConfig": {
- "apiAvailable": false,
- "equinixManagedPort": true,
- "equinixManagedVlan": true,
- "allowOverSubscription": false,
- "overSubscriptionLimit": 1,
- "bandwidthFromApi": false
}, - "connectionLabel": "true1",
- "authenticationKey": {
- "required": false,
- "label": "Service Key"
}
}
], - "marketingInfo": {
- "promotion": true
}, - "ports": [
- {
- "type": "XF_PORT",
- "uuid": "c791f8cb-5cc9-cc90-8ce0-306a5c00a4ee",
- "location": {
- "metroCode": "SY"
}
}
], - "metros": [
- {
- "code": "SY",
- "ibxs": [
- "SY4"
]
}
]
}
Search service profiles by search criteria
viewPoint | string Default: "aSide" Enum: "aSide" "zSide" flips view between buyer and seller representation |
ServiceProfileSimpleExpression (object) or ServiceProfileAndFilter (object) (ServiceProfileFilter) | |||||||
Any of
| |||||||
object (PaginationRequest) Pagination request information | |||||||
| |||||||
Array of objects (ServiceProfileSortCriteria) | |||||||
Array
|
Array of objects (ServiceProfile) | |||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||
object (Pagination) Pagination response information | |||||||||||||||||||||||||||||||||||||||||||
|
{- "filter": {
- "property": "/uuid",
- "operator": "=",
- "values": [
- "13100b2d-234f-4425-ab5c-1449d4b806be"
]
}, - "pagination": {
- "offset": 0,
- "limit": 20
}, - "sort": [
- {
- "direction": "DESC",
- "property": "/changeLog/updatedDateTime"
}
]
}
{- "data": [
- {
- "state": "ACTIVE",
- "account": {
- "organizationName": "testSeller-270010"
}, - "changeLog": {
- "createdBy": "fusiontestseller",
- "createdByFullName": "fusiontestSeller fusiontestSeller",
- "createdByEmail": "fusiontestSeller@equinix.com",
- "createdDateTime": "2022-04-12T19:06:57.940Z",
- "updatedBy": "fusiontestseller",
- "updatedByFullName": "fusiontestSeller fusiontestSeller",
- "updatedByEmail": "fusiontestSeller@equinix.com",
- "updatedDateTime": "2022-04-12T19:11:04.017Z"
}, - "type": "L2_PROFILE",
- "name": "Service Profile 2",
- "uuid": "ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
- "description": "Sample_description",
- "visibility": "PUBLIC",
- "allowedEmails": [
- "test@equinix.com",
- "testagain@equinix.com"
], - "accessPointTypeConfigs": [
- {
- "type": "COLO",
- "uuid": "f20c49cd-b022-4aeb-b3e4-49db4389aff3",
- "supportedBandwidths": [
- 100,
- 500
], - "allowRemoteConnections": false,
- "allowCustomBandwidth": true,
- "allowBandwidthAutoApproval": false,
- "linkProtocolConfig": {
- "encapsulationStrategy": "CTAGED",
- "reuseVlanSTag": false,
- "encapsulation": "DOT1Q"
}, - "enableAutoGenerateServiceKey": false,
- "connectionRedundancyRequired": false,
- "apiConfig": {
- "apiAvailable": false,
- "bandwidthFromApi": false
}, - "connectionLabel": "true1",
- "authenticationKey": {
- "required": false,
- "label": "Service Key"
}
}
], - "marketingInfo": {
- "promotion": true
}, - "metros": [
- {
- "code": "SY",
- "name": "Sydney",
- "ibxs": [
- "SY4"
], - "displayName": "Sydney"
}
], - "selfProfile": true
}
], - "pagination": {
- "offset": 0,
- "limit": 1,
- "total": 52,
- "next": "/serviceProfiles?offset=1&limit=1"
}
}
Get service profile by UUID. View Point parameter if set to zSide will give seller's view of the profile otherwise buyer's view.
serviceProfileId required | string <uuid> (ServiceProfileId) Service Profile UUID |
viewPoint | string Default: "aSide" Enum: "aSide" "zSide" flips view between buyer and seller representation |
ETag | string response header - identifier for a specific version of a resource. |
state | string (ServiceProfileStateEnum) Enum: "ACTIVE" "PENDING_APPROVAL" "DELETED" "REJECTED" Equinix assigned state. | ||||||||||||||||||||||||||||||
object Seller Account for Service Profile. | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
object Seller Account for Service Profile. | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
href | string <uri> Service Profile URI response attribute | ||||||||||||||||||||||||||||||
type | string (ServiceProfileTypeEnum) Enum: "L2_PROFILE" "L3_PROFILE" "IA_PROFILE" Service profile type | ||||||||||||||||||||||||||||||
name | string <= 50 characters Customer-assigned service profile name | ||||||||||||||||||||||||||||||
uuid | string <uuid> Equinix-assigned service profile identifier | ||||||||||||||||||||||||||||||
description | string User-provided service description should be of maximum length 375 | ||||||||||||||||||||||||||||||
Array of objects (SimplifiedNotification) Recipients of notifications on service profile change | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||||||
Array of objects (CustomField) | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
object (MarketingInfo) | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
Array of objects (ServiceProfileAccessPointCOLO) | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
Array of objects (ServiceProfileAccessPointVD) | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
Array of objects (ServiceMetro) Derived response attribute. | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
selfProfile | boolean response attribute indicates whether the profile belongs to the same organization as the api-invoker. | ||||||||||||||||||||||||||||||
projectId | string |
{- "state": "ACTIVE",
- "account": {
- "organizationName": "testSeller-270010"
}, - "changeLog": {
- "createdBy": "fusiontestseller",
- "createdByFullName": "fusiontestSeller fusiontestSeller",
- "createdByEmail": "fusiontestSeller@equinix.com",
- "createdDateTime": "2022-04-12T19:06:57.940Z",
- "updatedBy": "fusiontestseller",
- "updatedByFullName": "fusiontestSeller fusiontestSeller",
- "updatedByEmail": "fusiontestSeller@equinix.com",
- "updatedDateTime": "2022-04-12T19:11:04.017Z"
}, - "type": "L2_PROFILE",
- "name": "Service Profile 2",
- "uuid": "ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
- "description": "Sample_description",
- "visibility": "PUBLIC",
- "allowedEmails": [
- "test@equinix.com",
- "testagain@equinix.com"
], - "accessPointTypeConfigs": [
- {
- "type": "COLO",
- "uuid": "f20c49cd-b022-4aeb-b3e4-49db4389aff3",
- "supportedBandwidths": [
- 100,
- 500
], - "allowRemoteConnections": false,
- "allowCustomBandwidth": true,
- "allowBandwidthAutoApproval": false,
- "linkProtocolConfig": {
- "encapsulationStrategy": "CTAGED",
- "reuseVlanSTag": false,
- "encapsulation": "DOT1Q"
}, - "enableAutoGenerateServiceKey": false,
- "connectionRedundancyRequired": false,
- "apiConfig": {
- "apiAvailable": false,
- "bandwidthFromApi": false
}, - "connectionLabel": "true1",
- "authenticationKey": {
- "required": false,
- "label": "Service Key"
}
}
], - "marketingInfo": {
- "promotion": true
}, - "metros": [
- {
- "code": "SY",
- "name": "Sydney",
- "ibxs": [
- "SY4"
], - "displayName": "Sydney"
}
], - "selfProfile": true
}
This API request replaces a service profile definition
serviceProfileId required | string <uuid> (ServiceProfileId) Service Profile UUID |
If-Match required | string conditional request |
object (Project) | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
type required | string (ServiceProfileTypeEnum) Enum: "L2_PROFILE" "L3_PROFILE" "IA_PROFILE" Service profile type | ||||||||||||||||||||||||||||||
name required | string <= 50 characters Customer-assigned service profile name | ||||||||||||||||||||||||||||||
uuid | string <uuid> Equinix-assigned service profile identifier | ||||||||||||||||||||||||||||||
description required | string User-provided service description should be of maximum length 375 | ||||||||||||||||||||||||||||||
Array of objects (SimplifiedNotification) Recipients of notifications on service profile change | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||||||
Array of objects (CustomField) | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
object (MarketingInfo) | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
Array of objects (ServiceProfileAccessPointCOLO) | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
Array of objects (ServiceProfileAccessPointVD) | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
Array of objects (ServiceMetro) Derived response attribute. | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
selfProfile | boolean response attribute indicates whether the profile belongs to the same organization as the api-invoker. | ||||||||||||||||||||||||||||||
projectId | string |
{- "name": "Service Profile 2",
- "description": "Sample_description",
- "type": "L2_PROFILE",
- "notifications": [
- {
- "emails": [
- "someone@sample.com"
], - "type": "BANDWIDTH_ALERT"
}
], - "visibility": "PUBLIC",
- "allowedEmails": [
- "test@equinix.com",
- "testagain@equinix.com"
], - "ports": [
- {
- "uuid": "c791f8cb-5cc9-cc90-8ce0-306a5c00a4ee",
- "type": "XF_PORT",
- "location": {
- "metroCode": "SY"
}
}
], - "marketingInfo": {
- "promotion": true
}, - "accessPointTypeConfigs": [
- {
- "type": "COLO",
- "connectionRedundancyRequired": false,
- "allowBandwidthAutoApproval": false,
- "allowRemoteConnections": false,
- "connectionLabel": "true1",
- "enableAutoGenerateServiceKey": false,
- "bandwidthAlertThreshold": 10,
- "allowCustomBandwidth": true,
- "apiConfig": {
- "apiAvailable": false,
- "equinixManagedVlan": true,
- "bandwidthFromApi": false,
- "integrationId": null,
- "equinixManagedPort": true
}, - "authenticationKey": {
- "required": false,
- "label": "Service Key",
- "description": "XYZ"
}, - "supportedBandwidths": [
- 100,
- 500
]
}
]
}
{- "state": "ACTIVE",
- "account": {
- "orgId": 91785,
- "organizationName": "testSeller-270010",
- "globalOrgId": "0016u000003JZ4tAAG"
}, - "changeLog": {
- "createdBy": "fusiontestseller",
- "createdByFullName": "fusiontestSeller fusiontestSeller",
- "createdByEmail": "fusiontestSeller@equinix.com",
- "createdDateTime": "2022-04-12T19:06:57.940Z",
- "updatedDateTime": "2022-04-12T19:11:04.017Z"
}, - "type": "L2_PROFILE",
- "name": "Service Profile 2",
- "uuid": "ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
- "description": "Sample_description",
- "notifications": [
- {
- "type": "BANDWIDTH_ALERT",
- "emails": [
- "someone@sample.com"
]
}, - {
- "type": "CONNECTION_APPROVAL",
- "emails": [
- "someone@sample.com"
]
}, - {
- "type": "PROFILE_LIFECYCLE",
- "emails": [
- "someone@sample.com"
]
}
], - "visibility": "PUBLIC",
- "allowedEmails": [
- "test@equinix.com",
- "testagain@equinix.com"
], - "accessPointTypeConfigs": [
- {
- "type": "COLO",
- "uuid": "f20c49cd-b022-4aeb-b3e4-49db4389aff3",
- "supportedBandwidths": [
- 100,
- 500
], - "allowRemoteConnections": false,
- "allowCustomBandwidth": true,
- "bandwidthAlertThreshold": 10,
- "allowBandwidthAutoApproval": false,
- "linkProtocolConfig": {
- "encapsulationStrategy": "CTAGED",
- "reuseVlanSTag": false,
- "encapsulation": "DOT1Q"
}, - "enableAutoGenerateServiceKey": false,
- "connectionRedundancyRequired": false,
- "apiConfig": {
- "apiAvailable": false,
- "equinixManagedPort": true,
- "equinixManagedVlan": true,
- "allowOverSubscription": false,
- "overSubscriptionLimit": 1,
- "bandwidthFromApi": false
}, - "connectionLabel": "true1",
- "authenticationKey": {
- "required": false,
- "label": "Service Key"
}
}
], - "marketingInfo": {
- "promotion": true
}, - "ports": [
- {
- "type": "XF_PORT",
- "uuid": "c791f8cb-5cc9-cc90-8ce0-306a5c00a4ee",
- "location": {
- "metroCode": "SY"
}
}
], - "metros": [
- {
- "code": "SY",
- "name": "Sydney",
- "ibxs": [
- "SY4"
], - "displayName": "Sydney"
}
]
}
delete Service Profile by UUID
serviceProfileId required | string <uuid> (ServiceProfileId) Service Profile UUID |
ETag | string response header - identifier for a specific version of a resource. |
state | string (ServiceProfileStateEnum) Enum: "ACTIVE" "PENDING_APPROVAL" "DELETED" "REJECTED" Equinix assigned state. | ||||||||||||||||||||||||||||||
object Seller Account for Service Profile. | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
object Seller Account for Service Profile. | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
href | string <uri> Service Profile URI response attribute | ||||||||||||||||||||||||||||||
type | string (ServiceProfileTypeEnum) Enum: "L2_PROFILE" "L3_PROFILE" "IA_PROFILE" Service profile type | ||||||||||||||||||||||||||||||
name | string <= 50 characters Customer-assigned service profile name | ||||||||||||||||||||||||||||||
uuid | string <uuid> Equinix-assigned service profile identifier | ||||||||||||||||||||||||||||||
description | string User-provided service description should be of maximum length 375 | ||||||||||||||||||||||||||||||
Array of objects (SimplifiedNotification) Recipients of notifications on service profile change | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||||||
Array of objects (CustomField) | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
object (MarketingInfo) | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
Array of objects (ServiceProfileAccessPointCOLO) | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
Array of objects (ServiceProfileAccessPointVD) | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
Array of objects (ServiceMetro) Derived response attribute. | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
selfProfile | boolean response attribute indicates whether the profile belongs to the same organization as the api-invoker. | ||||||||||||||||||||||||||||||
projectId | string |
{- "state": "DELETED",
- "account": {
- "orgId": 91785,
- "organizationName": "testSeller-270010",
- "globalOrgId": "0016u000003JZ4tAAG"
}, - "changeLog": {
- "createdBy": "fusiontestseller",
- "createdByFullName": "fusiontestSeller fusiontestSeller",
- "createdByEmail": "fusiontestSeller@equinix.com",
- "createdDateTime": "2022-04-12T19:06:57.940Z",
- "updatedBy": "fusiontestseller",
- "updatedByFullName": "fusiontestSeller fusiontestSeller",
- "updatedByEmail": "fusiontestSeller@equinix.com",
- "updatedDateTime": "2022-04-12T21:53:57.816Z"
}, - "type": "L2_PROFILE",
- "name": "Service Profile 2",
- "uuid": "ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
- "description": "Sample_description",
- "notifications": [
- {
- "type": "BANDWIDTH_ALERT",
- "emails": [
- "someone@sample.com"
]
}, - {
- "type": "CONNECTION_APPROVAL",
- "emails": [
- "someone@sample.com"
]
}, - {
- "type": "PROFILE_LIFECYCLE",
- "emails": [
- "someone@sample.com"
]
}
], - "tags": [
- "sample_tag"
], - "visibility": "PUBLIC",
- "allowedEmails": [
- "test@equinix.com",
- "testagain@equinix.com"
], - "accessPointTypeConfigs": [
- {
- "type": "COLO",
- "uuid": "f20c49cd-b022-4aeb-b3e4-49db4389aff3",
- "supportedBandwidths": [
- 100,
- 500
], - "allowRemoteConnections": false,
- "allowCustomBandwidth": true,
- "bandwidthAlertThreshold": 10,
- "allowBandwidthAutoApproval": false,
- "linkProtocolConfig": {
- "encapsulationStrategy": "CTAGED",
- "reuseVlanSTag": false,
- "encapsulation": "DOT1Q"
}, - "enableAutoGenerateServiceKey": false,
- "connectionRedundancyRequired": false,
- "apiConfig": {
- "apiAvailable": false,
- "equinixManagedPort": true,
- "equinixManagedVlan": true,
- "allowOverSubscription": false,
- "overSubscriptionLimit": 1,
- "bandwidthFromApi": false
}, - "connectionLabel": "true1",
- "authenticationKey": {
- "required": false,
- "label": "Service Key"
}
}
], - "marketingInfo": {
- "promotion": true
}, - "ports": [
- {
- "type": "XF_PORT",
- "uuid": "c791f8cb-5cc9-cc90-8ce0-306a5c00a4ee",
- "location": {
- "metroCode": "SY"
}
}
], - "metros": [
- {
- "code": "SY",
- "name": "Sydney",
- "ibxs": [
- "SY4"
], - "displayName": "Sydney"
}
]
}
Update Service Profile by UUID
serviceProfileId required | string <uuid> (ServiceProfileId) Service Profile UUID |
If-Match required | string conditional request |
op required | string (OpEnum) Enum: "add" "remove" "replace" the operation to be performed |
path required | string (Path) A JSON Pointer path. |
value required | object value to add |
ETag | string response header - identifier for a specific version of a resource. |
state | string (ServiceProfileStateEnum) Enum: "ACTIVE" "PENDING_APPROVAL" "DELETED" "REJECTED" Equinix assigned state. | ||||||||||||||||||||||||||||||
object Seller Account for Service Profile. | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
object Seller Account for Service Profile. | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
href | string <uri> Service Profile URI response attribute | ||||||||||||||||||||||||||||||
type | string (ServiceProfileTypeEnum) Enum: "L2_PROFILE" "L3_PROFILE" "IA_PROFILE" Service profile type | ||||||||||||||||||||||||||||||
name | string <= 50 characters Customer-assigned service profile name | ||||||||||||||||||||||||||||||
uuid | string <uuid> Equinix-assigned service profile identifier | ||||||||||||||||||||||||||||||
description | string User-provided service description should be of maximum length 375 | ||||||||||||||||||||||||||||||
Array of objects (SimplifiedNotification) Recipients of notifications on service profile change | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
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
| |||||||||||||||||||||||||||||||
Array of objects (CustomField) | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
object (MarketingInfo) | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
Array of objects (ServiceProfileAccessPointCOLO) | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
Array of objects (ServiceProfileAccessPointVD) | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
Array of objects (ServiceMetro) Derived response attribute. | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
selfProfile | boolean response attribute indicates whether the profile belongs to the same organization as the api-invoker. | ||||||||||||||||||||||||||||||
projectId | string |
[- {
- "op": "add",
- "path": "/tags",
- "value": [
- "sample_tag"
]
}
]
{- "state": "ACTIVE",
- "account": {
- "orgId": 91785,
- "organizationName": "testSeller-270010",
- "globalOrgId": "0016u000003JZ4tAAG"
}, - "changeLog": {
- "createdBy": "fusiontestseller",
- "createdByFullName": "fusiontestSeller fusiontestSeller",
- "createdByEmail": "fusiontestSeller@equinix.com",
- "createdDateTime": "2022-04-12T19:06:57.940Z",
- "updatedDateTime": "2022-04-12T19:11:04.017Z"
}, - "type": "L2_PROFILE",
- "name": "Service Profile 2",
- "uuid": "ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
- "description": "Sample_description",
- "notifications": [
- {
- "type": "BANDWIDTH_ALERT",
- "emails": [
- "someone@sample.com"
]
}, - {
- "type": "CONNECTION_APPROVAL",
- "emails": [
- "someone@sample.com"
]
}, - {
- "type": "PROFILE_LIFECYCLE",
- "emails": [
- "someone@sample.com"
]
}
], - "visibility": "PUBLIC",
- "tags": [
- "sample_tag"
], - "allowedEmails": [
- "test@equinix.com",
- "testagain@equinix.com"
], - "accessPointTypeConfigs": [
- {
- "type": "COLO",
- "uuid": "f20c49cd-b022-4aeb-b3e4-49db4389aff3",
- "supportedBandwidths": [
- 100,
- 500
], - "allowRemoteConnections": false,
- "allowCustomBandwidth": true,
- "bandwidthAlertThreshold": 10,
- "allowBandwidthAutoApproval": false,
- "linkProtocolConfig": {
- "encapsulationStrategy": "CTAGED",
- "reuseVlanSTag": false,
- "encapsulation": "DOT1Q"
}, - "enableAutoGenerateServiceKey": false,
- "connectionRedundancyRequired": false,
- "apiConfig": {
- "apiAvailable": false,
- "equinixManagedPort": true,
- "equinixManagedVlan": true,
- "allowOverSubscription": false,
- "overSubscriptionLimit": 1,
- "bandwidthFromApi": false
}, - "connectionLabel": "true1",
- "authenticationKey": {
- "required": false,
- "label": "Service Key"
}
}
], - "marketingInfo": {
- "promotion": true
}, - "ports": [
- {
- "type": "XF_PORT",
- "uuid": "c791f8cb-5cc9-cc90-8ce0-306a5c00a4ee",
- "location": {
- "metroCode": "SY"
}
}
], - "metros": [
- {
- "code": "SY",
- "name": "Sydney",
- "ibxs": [
- "SY4"
], - "displayName": "Sydney"
}
]
}
Get service profile metros by UUID.
serviceProfileId required | string <uuid> (ServiceProfileId) Service Profile UUID |
offset | integer Example: offset=1 offset |
limit | integer Example: limit=10 number of records to fetch |
Array of objects (ServiceMetro) | |||||||||||||||
Array
| |||||||||||||||
object (Pagination) Pagination response information | |||||||||||||||
|
{- "data": [
- {
- "state": "ACTIVE",
- "account": {
- "organizationName": "testSeller-270010"
}, - "changeLog": {
- "createdBy": "fusiontestseller",
- "createdByFullName": "fusiontestSeller fusiontestSeller",
- "createdByEmail": "fusiontestSeller@equinix.com",
- "createdDateTime": "2022-04-12T19:06:57.940Z",
- "updatedBy": "fusiontestseller",
- "updatedByFullName": "fusiontestSeller fusiontestSeller",
- "updatedByEmail": "fusiontestSeller@equinix.com",
- "updatedDateTime": "2022-04-12T19:11:04.017Z"
}, - "type": "L2_PROFILE",
- "name": "Service Profile 2",
- "uuid": "ea4b5141-e4d2-49f1-9768-4ea6e215b37f",
- "description": "Sample_description",
- "visibility": "PUBLIC",
- "allowedEmails": [
- "test@equinix.com",
- "testagain@equinix.com"
], - "accessPointTypeConfigs": [
- {
- "type": "COLO",
- "uuid": "f20c49cd-b022-4aeb-b3e4-49db4389aff3",
- "supportedBandwidths": [
- 100,
- 500
], - "allowRemoteConnections": false,
- "allowCustomBandwidth": true,
- "allowBandwidthAutoApproval": false,
- "linkProtocolConfig": {
- "encapsulationStrategy": "CTAGED",
- "reuseVlanSTag": false,
- "encapsulation": "DOT1Q"
}, - "enableAutoGenerateServiceKey": false,
- "connectionRedundancyRequired": false,
- "apiConfig": {
- "apiAvailable": false,
- "bandwidthFromApi": false
}, - "connectionLabel": "true1",
- "authenticationKey": {
- "required": false,
- "label": "Service Key"
}
}
], - "marketingInfo": {
- "promotion": true
}, - "metros": [
- {
- "code": "SY",
- "name": "Sydney",
- "ibxs": [
- "SY4"
], - "displayName": "Sydney"
}
], - "selfProfile": true
}
], - "pagination": {
- "offset": 0,
- "limit": 1,
- "total": 52,
- "next": "/serviceProfiles?offset=1&limit=1"
}
}
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.
serviceTokenId required | string <uuid> (ServiceTokenUUID) Service Token UUID |
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (SimplifiedAccount) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Changelog) Change log | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
{- "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": {
- "type": "EVPL_VC",
- "allowRemoteConnection": false,
- "bandwidthLimit": 50,
- "allowCustomBandwidth": false,
- "aSide": {
- "accessPointSelectors": [
- {
- "type": "COLO",
- "port": {
- "type": "XF_PORT",
- "uuid": "b840a1db-5758-758f-97e0-328a5c00a874"
}, - "linkProtocol": {
- "type": "QINQ",
- "vlanCTag": 1399,
- "vlanSTag": 1388
}
}
]
}
}, - "notifications": [
- {
- "type": "NOTIFICATION",
- "emails": [
- "abc@company.com",
- "provider@company.com"
]
}
], - "account": {
- "orgId": 111437
}, - "changeLog": {
- "createdBy": "843577",
- "createdDateTime": "2021-03-18T06:43:49.980Z",
- "updatedBy": "843577",
- "updatedDateTime": "2021-03-18T06:44:14.206Z"
}, - "project": {
- "projectId": "995072000433550"
}
}
Delete Service Tokens removes an Equinix Fabric service token corresponding to the specified uuid which are in INACTIVE state.
serviceTokenId required | string <uuid> (ServiceTokenUUID) Service Token UUID |
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (SimplifiedAccount) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Changelog) Change log | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
{- "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": {
- "type": "EVPL_VC",
- "allowRemoteConnection": false,
- "bandwidthLimit": 50,
- "allowCustomBandwidth": false,
- "aSide": {
- "accessPointSelectors": [
- {
- "type": "COLO",
- "port": {
- "type": "XF_PORT",
- "uuid": "b840a1db-5758-758f-97e0-328a5c00a874"
}, - "linkProtocol": {
- "type": "QINQ",
- "vlanCTag": 1399,
- "vlanSTag": 1388
}
}
]
}
}, - "notifications": [
- {
- "type": "NOTIFICATION",
- "emails": [
- "abc@company.com",
- "provider@company.com"
]
}
], - "account": {
- "orgId": 111437
}, - "changeLog": {
- "createdBy": "843577",
- "createdDateTime": "2021-03-18T06:43:49.980Z",
- "updatedBy": "843577",
- "updatedDateTime": "2021-03-18T06:44:14.206Z"
}, - "project": {
- "projectId": "995072000433550"
}
}
This API provides capability to update user's Service Token
serviceTokenId required | string <uuid> (ServiceTokenUUID) Service Token UUID |
dryRun | boolean Default: false option to verify that API calls will succeed |
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 (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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (SimplifiedAccount) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Changelog) Change log | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
[- {
- "op": "replace",
- "path": "/expirationDateTime",
- "value": "2023-01-20T18:50:34.696Z"
}
]
{- "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": {
- "type": "EVPL_VC",
- "allowRemoteConnection": false,
- "bandwidthLimit": 50,
- "allowCustomBandwidth": false,
- "aSide": {
- "accessPointSelectors": [
- {
- "type": "COLO",
- "port": {
- "type": "XF_PORT",
- "uuid": "b840a1db-5758-758f-97e0-328a5c00a874"
}, - "linkProtocol": {
- "type": "QINQ",
- "vlanCTag": 1399,
- "vlanSTag": 1388
}
}
]
}
}, - "notifications": [
- {
- "type": "NOTIFICATION",
- "emails": [
- "abc@company.com",
- "provider@company.com"
]
}
], - "account": {
- "orgId": 111437
}, - "changeLog": {
- "createdBy": "843577",
- "createdDateTime": "2021-03-18T06:43:49.980Z",
- "updatedBy": "843577",
- "updatedDateTime": "2021-03-18T06:44:14.206Z"
}, - "project": {
- "projectId": "995072000433550"
}
}
Get All ServiceTokens creates a list of all Equinix Fabric service tokens associated with the subscriber's account.
offset | number offset |
limit | number number of records to fetch |
Array of objects (ServiceToken) List of Service Tokens | |||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||
object (Pagination) Pagination response information | |||||||||||||||||||||||||||||
|
{- "pagination": {
- "offset": 0,
- "limit": 75,
- "total": 2
}, - "data": [
- {
- "type": "VC_TOKEN",
- "name": "zside_network_token",
- "uuid": "ea40918e-9b39-4045-8be8-0beaa7eb5ce1",
- "description": "zside_Network_token",
- "connection": {
- "type": "EVPLAN_VC",
- "allowRemoteConnection": true,
- "allowCustomBandwidth": false,
- "bandwidthLimit": 20000,
- "zSide": {
- "accessPointSelectors": [
- {
- "type": "NETWORK",
- "network": {
- "type": "EVPLAN",
- "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4",
- "scope": "REGIONAL"
}
}
]
}
}, - "project": {
- "projectId": "30ad25e2-53dc-11ed-bdc3-0242ac120002"
}, - "expirationDateTime": "2021-03-18T06:43:49.980Z",
- "notifications": [
- {
- "type": "NOTIFICATION",
- "emails": [
- "abc@company.com"
]
}
]
}, - {
- "type": "VC_TOKEN",
- "name": "zside_vd_token",
- "uuid": "ea40918e-9b39-4045-8be8-0beaa7eb5ce1",
- "description": "zside vd token",
- "connection": {
- "type": "EVPL_VC",
- "allowRemoteConnection": true,
- "allowCustomBandwidth": false,
- "supportedBandwidths": [
- 10,
- 50,
- 200
], - "zSide": {
- "accessPointSelectors": [
- {
- "type": "VD",
- "virtualDevice": {
- "type": "EDGE",
- "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
}, - "interface": {
- "type": "NETWORK",
- "id": 45645
}
}
]
}
}, - "project": {
- "projectId": "30ad25e2-53dc-11ed-bdc3-0242ac120002"
}, - "expirationDateTime": "2021-03-18T06:43:49.980Z",
- "notifications": [
- {
- "type": "NOTIFICATION",
- "emails": [
- "abc@company.com"
]
}
]
}, - {
- "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",
- "project": {
- "projectId": "30ad25e2-53dc-11ed-bdc3-0242ac120002"
}, - "connection": {
- "type": "EVPL_VC",
- "allowRemoteConnection": false,
- "bandwidthLimit": 50,
- "allowCustomBandwidth": false,
- "aSide": {
- "accessPointSelectors": [
- {
- "type": "COLO",
- "port": {
- "type": "XF_PORT",
- "uuid": "b840a1db-5758-758f-97e0-328a5c00a874"
}, - "linkProtocol": {
- "type": "QINQ",
- "vlanCTag": 1399,
- "vlanSTag": 1388
}
}
]
}
}, - "notifications": [
- {
- "type": "NOTIFICATION",
- "emails": [
- "abc@company.com",
- "provider@company.com"
]
}
], - "account": {
- "orgId": 111437
}, - "changeLog": {
- "createdBy": "843577",
- "createdDateTime": "2021-03-18T06:43:49.980Z",
- "updatedBy": "843577",
- "updatedDateTime": "2021-03-18T06:44:14.206Z"
}
}
]
}
Create Service Tokens generates Equinix Fabric? service tokens. These tokens authorize users to access protected resources and services.
dryRun | boolean Default: false option to verify that API calls will succeed |
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (SimplifiedAccount) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Changelog) Change log | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (SimplifiedAccount) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Changelog) Change log | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (SimplifiedAccount) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Changelog) Change log | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
{- "type": "VC_TOKEN",
- "name": "Az_Aside_Dot1Q_Pri_SV",
- "description": "Az_Aside_Dot1Q_Pri_SV_Description",
- "expirationDateTime": "2021-03-18T06:43:49.980Z",
- "connection": {
- "type": "EVPL_VC",
- "allowRemoteConnection": false,
- "bandwidthLimit": 50,
- "allowCustomBandwidth": false,
- "aSide": {
- "accessPointSelectors": [
- {
- "type": "COLO",
- "port": {
- "uuid": "b840a1db-5758-758f-97e0-328a5c00a874"
}, - "linkProtocol": {
- "type": "QINQ",
- "vlanCTag": 1399,
- "vlanSTag": 1388
}
}
]
}
}, - "notifications": [
- {
- "type": "NOTIFICATION",
- "emails": [
- "abc@company.com",
- "provider@company.com"
]
}
]
}
{- "type": "VC_TOKEN",
- "name": "Aside_Dot1Q_Service_Token",
- "description": "Az_Aside_Dot1Q_DryRun_Description",
- "expirationDateTime": "2024-12-18T06:43:49.980Z",
- "connection": {
- "type": "EVPL_VC",
- "allowRemoteConnection": false,
- "bandwidthLimit": 50,
- "allowCustomBandwidth": false,
- "aSide": {
- "accessPointSelectors": [
- {
- "type": "COLO",
- "port": {
- "uuid": "b840a1db-5758-758f-97e0-328a5c00a874"
}, - "linkProtocol": {
- "type": "DOT1Q",
- "vlanTag": 1399
}
}
]
}
}, - "notifications": [
- {
- "type": "NOTIFICATION",
- "emails": [
- "abc@company.com",
- "provider@company.com"
]
}
]
}
This API provides capability to accept/reject user's servicetokens
serviceTokenId required | string <uuid> (ServiceTokenUUID) Service Token UUID |
type required | string (ServiceTokenActions) Value: "RESEND_EMAIL_NOTIFICATION" Service Token action type |
{- "type": "RESEND_EMAIL_NOTIFICATION"
}
{- "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": {
- "type": "EVPL_VC",
- "allowRemoteConnection": false,
- "bandwidthLimit": 50,
- "allowCustomBandwidth": false,
- "aSide": {
- "accessPointSelectors": [
- {
- "type": "COLO",
- "port": {
- "type": "XF_PORT",
- "uuid": "b840a1db-5758-758f-97e0-328a5c00a874"
}, - "linkProtocol": {
- "type": "QINQ",
- "vlanCTag": 1399,
- "vlanSTag": 1388
}
}
]
}
}, - "notifications": [
- {
- "type": "NOTIFICATION",
- "emails": [
- "abc@company.com",
- "provider@company.com"
]
}
], - "account": {
- "orgId": 111437
}, - "changeLog": {
- "createdBy": "843577",
- "createdDateTime": "2021-03-18T06:43:49.980Z",
- "updatedBy": "843577",
- "updatedDateTime": "2021-03-18T06:44:14.206Z"
}, - "project": {
- "projectId": "995072000433550"
}
}
The API provides capability to get list of user's servicetokens using search criteria, including optional filtering, pagination and sorting
offset | number offset |
limit | number number of records to fetch |
object (ServiceTokenSearchExpression) | |||||||||
| |||||||||
object (PaginationRequest) Pagination request information | |||||||||
|
Array of objects (ServiceToken) List of Service Tokens | |||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||
object (Pagination) Pagination response information | |||||||||||||||||||||||||||||
|
{- "filter": {
- "and": [
- {
- "property": "/uuid",
- "operator": "=",
- "values": [
- "407f8239-254c-4fe2-a378-458f197e17c4"
]
}
]
}
}
{- "pagination": {
- "offset": 0,
- "limit": 75,
- "total": 2
}, - "data": [
- {
- "type": "VC_TOKEN",
- "name": "zside_network_token",
- "uuid": "ea40918e-9b39-4045-8be8-0beaa7eb5ce1",
- "description": "zside_Network_token",
- "connection": {
- "type": "EVPLAN_VC",
- "allowRemoteConnection": true,
- "allowCustomBandwidth": false,
- "bandwidthLimit": 20000,
- "zSide": {
- "accessPointSelectors": [
- {
- "type": "NETWORK",
- "network": {
- "type": "EVPLAN",
- "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4",
- "scope": "REGIONAL"
}
}
]
}
}, - "project": {
- "projectId": "30ad25e2-53dc-11ed-bdc3-0242ac120002"
}, - "expirationDateTime": "2021-03-18T06:43:49.980Z",
- "notifications": [
- {
- "type": "NOTIFICATION",
- "emails": [
- "abc@company.com"
]
}
]
}, - {
- "type": "VC_TOKEN",
- "name": "zside_vd_token",
- "uuid": "ea40918e-9b39-4045-8be8-0beaa7eb5ce1",
- "description": "zside vd token",
- "connection": {
- "type": "EVPL_VC",
- "allowRemoteConnection": true,
- "allowCustomBandwidth": false,
- "supportedBandwidths": [
- 10,
- 50,
- 200
], - "zSide": {
- "accessPointSelectors": [
- {
- "type": "VD",
- "virtualDevice": {
- "type": "EDGE",
- "uuid": "20d32a80-0d61-4333-bc03-707b591ae2f4"
}, - "interface": {
- "type": "NETWORK",
- "id": 45645
}
}
]
}
}, - "project": {
- "projectId": "30ad25e2-53dc-11ed-bdc3-0242ac120002"
}, - "expirationDateTime": "2021-03-18T06:43:49.980Z",
- "notifications": [
- {
- "type": "NOTIFICATION",
- "emails": [
- "abc@company.com"
]
}
]
}, - {
- "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",
- "project": {
- "projectId": "30ad25e2-53dc-11ed-bdc3-0242ac120002"
}, - "connection": {
- "type": "EVPL_VC",
- "allowRemoteConnection": false,
- "bandwidthLimit": 50,
- "allowCustomBandwidth": false,
- "aSide": {
- "accessPointSelectors": [
- {
- "type": "COLO",
- "port": {
- "type": "XF_PORT",
- "uuid": "b840a1db-5758-758f-97e0-328a5c00a874"
}, - "linkProtocol": {
- "type": "QINQ",
- "vlanCTag": 1399,
- "vlanSTag": 1388
}
}
]
}
}, - "notifications": [
- {
- "type": "NOTIFICATION",
- "emails": [
- "abc@company.com",
- "provider@company.com"
]
}
], - "account": {
- "orgId": 111437
}, - "changeLog": {
- "createdBy": "843577",
- "createdDateTime": "2021-03-18T06:43:49.980Z",
- "updatedBy": "843577",
- "updatedDateTime": "2021-03-18T06:44:14.206Z"
}
}
]
}
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.
portId required | string <uuid> (PortUUID) Port UUID |
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 |
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) | |||||||||||||||||||||||||
|
{- "type": "XF_PORT",
- "uuid": "xxxxx191-xx70-xxxx-xx04-xxxxxxxa37xx",
- "name": "Equinix-EM-CX-xxx-L-Dot1q-BO-100G-PRI-xx",
- "bandwidthUtilization": 10000,
- "stats": {
- "startDateTime": "2020-05-21T08:00:00Z",
- "endDateTime": "2020-05-21T10:30:00Z",
- "bandwidthUtilization": {
- "unit": "Mbps",
- "metricInterval": "PT5M",
- "inbound": {
- "max": 68.00905623111112,
- "mean": 48.90562310112,
- "lastPolled": 41.00905623111112,
- "metrics": [
- {
- "intervalEndDateTime": "2020-05-21T10:30:00Z",
- "max": 45.5623145112009,
- "mean": 31.38641687333333
}
]
}, - "outbound": {
- "max": 41.99068261111111,
- "mean": 33.70374303096296,
- "lastPolled": 41.43428905111111,
- "metrics": [
- {
- "intervalEndDateTime": "2020-05-21T10:30:00Z",
- "max": 42.01401189333334,
- "mean": 39.40894303096296
}
]
}
}
}
}
This API provides service-level metrics so that you can view access and gather key information required to manage service subscription sizing and capacity
connectionId required | string (VirtualCircuitId) Connection UUID |
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 |
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) | |||||||||||||||||||||||||
|
{- "type": "EVPL_VC",
- "uuid": "97d1850f-4df0-468c-9281-fa7b0dfa2096",
- "name": "Admin-STATS-123-Abc",
- "stats": {
- "startDateTime": "2021-01-10T20:05:08Z",
- "endDateTime": "2021-01-10T21:05:08Z",
- "viewPoint": "aSide",
- "bandwidthUtilization": {
- "unit": "Mbps",
- "metricInterval": "PT5M",
- "inbound": {
- "max": 68.38641687333333,
- "mean": 39.96267986650665,
- "lastPolled": 41.00905623111112,
- "metrics": [
- {
- "intervalEndDateTime": "2021-01-10T20:05:00Z",
- "max": 41.89234537555556,
- "mean": 33.62481298948148
}, - {
- "intervalEndDateTime": "2021-01-10T20:10:00Z",
- "max": 41.86234987534256,
- "mean": 36.92451598748148
}, - {
- "intervalEndDateTime": "2021-01-10T20:15:00Z",
- "max": 41.86907222888888,
- "mean": 43.98230834555556
}, - {
- "intervalEndDateTime": "2021-01-10T20:20:00Z",
- "max": 41.91562025333334,
- "mean": 41.086565260765425
}
]
}, - "outbound": {
- "max": 67.79944363333334,
- "mean": 38.116581250214345,
- "lastPolled": 41.43428905111111,
- "metrics": [
- {
- "intervalEndDateTime": "2021-01-10T20:05:00Z",
- "max": 41.99068261111111,
- "mean": 33.70374303096296
}, - {
- "intervalEndDateTime": "2021-01-10T20:10:00Z",
- "max": 42.56065261666111,
- "mean": 31.52464373892222
}, - {
- "intervalEndDateTime": "2021-01-10T20:15:00Z",
- "max": 41.96735416222222,
- "mean": 44.08555118977779
}, - {
- "intervalEndDateTime": "2021-01-10T20:20:00Z",
- "max": 42.01401189333334,
- "mean": 39.40894303096296
}
]
}
}
}
}
This API provides capability to retrieve stream alert rules
streamId required | string <uuid> (StreamId) Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 Stream UUID |
offset | integer Example: offset=1 offset |
limit | integer Example: limit=10 number of records to fetch |
object (Pagination) Pagination response information | |||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
Array of objects (StreamAlertRule) Data returned from the API call. | |||||||||||||||||||||||||||||
Array
|
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1
}, - "data": [
- {
- "uuid": "0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15",
- "type": "METRIC_ALERT",
- "name": "metric-alert-1",
- "description": "metric-alert-1",
- "state": "ACTIVE",
- "enabled": true,
- "metricName": "equinix.fabric.connection.bandwidth_tx.usage",
- "resourceSelector": {
- "include": [
- "*/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b"
]
}, - "windowSize": "PT15M",
- "operand": "ABOVE",
- "warningThreshold": 35000000,
- "criticalThreshold": 45000000,
- "changeLog": {
- "createdBy": "user",
- "createdDateTime": "2024-05-06T16:21:18.545214Z"
}
}
]
}
This API provides capability to create user's Stream Alert Rules
streamId required | string <uuid> (StreamId) Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 Stream UUID |
type | string Value: "METRIC_ALERT" | ||
name | string Customer-provided stream name | ||
description | string Customer-provided stream description | ||
enabled | boolean Default: true Stream alert rule enabled status | ||
metricName | string Enum: "equinix.fabric.connection.bandwidth_tx.usage" "equinix.fabric.connection.bandwidth_rx.usage" "equinix.fabric.port.bandwidth_tx.usage" "equinix.fabric.port.bandwidth_rx.usage" "equinix.fabric.port.packets_erred_tx.count" "equinix.fabric.port.packets_erred_rx.count" "equinix.fabric.port.packets_dropped_tx.count" "equinix.fabric.port.packets_dropped_rx.count" "equinix.fabric.metro.<source_metro_code>_<destination_metro_code>.latency" Stream alert rule metric name | ||
object (ResourceSelector) | |||
| |||
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 |
{- "type": "METRIC_ALERT",
- "name": "metric-alert-1",
- "description": "metric-alert-1",
- "enabled": true,
- "metricName": "equinix.fabric.connection.bandwidth_tx.usage",
- "resourceSelector": {
- "include": [
- "*/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b"
]
}, - "operand": "ABOVE",
- "windowSize": "PT15M",
- "warningThreshold": 35000000,
- "criticalThreshold": 45000000
}
{- "uuid": "0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15",
- "type": "METRIC_ALERT",
- "name": "metric-alert-1",
- "description": "metric-alert-1",
- "state": "ACTIVE",
- "enabled": true,
- "metricName": "equinix.fabric.connection.bandwidth_tx.usage",
- "resourceSelector": {
- "include": [
- "*/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b"
]
}, - "windowSize": "PT15M",
- "operand": "ABOVE",
- "warningThreshold": 35000000,
- "criticalThreshold": 45000000,
- "changeLog": {
- "createdBy": "user",
- "createdDateTime": "2024-05-06T16:21:18.545214Z",
- "updatedBy": "user",
- "updatedDateTime": "2025-02-04T00:20:54.511118575Z"
}
}
This API provides capability to get user's stream alert rules
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 |
href | string <uri> Stream Alert Rule URI | ||||||||||||||||||||||||
uuid | string <uuid> Equinix-assigned access point identifier | ||||||||||||||||||||||||
type | string Value: "METRIC_ALERT" Stream subscription type | ||||||||||||||||||||||||
name | string Customer-provided stream alert rule name | ||||||||||||||||||||||||
description | string Customer-provided stream alert rule description | ||||||||||||||||||||||||
state | string Enum: "ACTIVE" "INACTIVE" Steam subscription provision state | ||||||||||||||||||||||||
enabled | boolean Default: true Stream alert rule enabled status | ||||||||||||||||||||||||
metricName | string Enum: "equinix.fabric.connection.bandwidth_tx.usage" "equinix.fabric.connection.bandwidth_rx.usage" "equinix.fabric.port.bandwidth_tx.usage" "equinix.fabric.port.bandwidth_rx.usage" "equinix.fabric.port.packets_erred_tx.count" "equinix.fabric.port.packets_erred_rx.count" "equinix.fabric.port.packets_dropped_tx.count" "equinix.fabric.port.packets_dropped_rx.count" "equinix.fabric.metro.<source_metro_code>_<destination_metro_code>.latency" Stream alert rule metric name | ||||||||||||||||||||||||
object (ResourceSelector) | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
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 | |||||||||||||||||||||||||
|
{- "uuid": "0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15",
- "type": "METRIC_ALERT",
- "name": "metric-alert-1",
- "description": "metric-alert-1",
- "state": "ACTIVE",
- "enabled": true,
- "metricName": "equinix.fabric.connection.bandwidth_tx.usage",
- "resourceSelector": {
- "include": [
- "*/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b"
]
}, - "windowSize": "PT15M",
- "operand": "ABOVE",
- "warningThreshold": 35000000,
- "criticalThreshold": 45000000,
- "changeLog": {
- "createdBy": "user",
- "createdDateTime": "2024-05-06T16:21:18.545214Z",
- "updatedBy": "user",
- "updatedDateTime": "2025-02-04T00:20:54.511118575Z"
}
}
This API provides capability to update a user's stream alert rule
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 |
name | string Customer-provided stream name | ||
description | string Customer-provided stream description | ||
enabled | boolean Default: true Stream alert rule enabled status | ||
metricName | string Enum: "equinix.fabric.connection.bandwidth_tx.usage" "equinix.fabric.connection.bandwidth_rx.usage" "equinix.fabric.port.bandwidth_tx.usage" "equinix.fabric.port.bandwidth_rx.usage" "equinix.fabric.port.packets_erred_tx.count" "equinix.fabric.port.packets_erred_rx.count" "equinix.fabric.port.packets_dropped_tx.count" "equinix.fabric.port.packets_dropped_rx.count" "equinix.fabric.metro.<source_metro_code>_<destination_metro_code>.latency" Stream alert rule metric name | ||
object (ResourceSelector) | |||
| |||
operand | string Enum: "ABOVE" "BELOW" Stream alert rule metric operand | ||
windowSize | string Stream alert rule metric window size | ||
warningThreshold | string Stream alert rule metric warning threshold | ||
criticalThreshold | string Stream alert rule metric critical threshold |
{- "name": "metric-alert-1",
- "description": "metric-alert-1",
- "enabled": true,
- "metricName": "equinix.fabric.connection.bandwidth_tx.usage",
- "resourceSelector": {
- "include": [
- "*/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b"
]
}, - "operand": "ABOVE",
- "windowSize": "PT15M",
- "warningThreshold": 35000000,
- "criticalThreshold": 45000000
}
{- "uuid": "0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15",
- "type": "METRIC_ALERT",
- "name": "metric-alert-1",
- "description": "metric-alert-1",
- "state": "ACTIVE",
- "enabled": true,
- "metricName": "equinix.fabric.connection.bandwidth_tx.usage",
- "resourceSelector": {
- "include": [
- "*/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b"
]
}, - "windowSize": "PT15M",
- "operand": "ABOVE",
- "warningThreshold": 35000000,
- "criticalThreshold": 45000000,
- "changeLog": {
- "createdBy": "user",
- "createdDateTime": "2024-05-06T16:21:18.545214Z",
- "updatedBy": "user",
- "updatedDateTime": "2025-02-04T00:20:54.511118575Z"
}
}
This API provides capability to delete a user's stream alert rule
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 |
{- "uuid": "0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15",
- "type": "METRIC_ALERT",
- "name": "metric-alert-1",
- "description": "metric-alert-1",
- "state": "INACTIVE",
- "enabled": true,
- "metricName": "equinix.fabric.connection.bandwidth_tx.usage",
- "resourceSelector": {
- "include": [
- "*/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b"
]
}, - "windowSize": "PT15M",
- "operand": "ABOVE",
- "warningThreshold": 35000000,
- "criticalThreshold": 45000000,
- "changeLog": {
- "createdBy": "user",
- "createdDateTime": "2024-05-06T16:21:18.545214Z",
- "updatedBy": "user",
- "updatedDateTime": "2025-02-04T00:20:54.511118575Z"
}
}
This API provides capability to retrieve stream subscriptions
streamId required | string <uuid> (StreamId) Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 Stream UUID |
offset | integer Example: offset=1 offset |
limit | integer Example: limit=10 number of records to fetch |
object (Pagination) Pagination response information | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
Array of objects (StreamSubscription) Data returned from the API call. | |||||||||||||||||||||||||
Array
|
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1
}, - "data": [
- {
- "uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
- "type": "STREAM_SUBSCRIPTION",
- "name": "splunk",
- "description": "subscription 1",
- "state": "PROVISIONED",
- "metricSelector": {
- "include": [
- "equinix.fabric.connection.*"
]
}, - "eventSelector": {
- "include": [
- "equinix.fabric.connection.*"
]
}, - "sink": {
- "type": "SPLUNK_HEC",
- "batchEnabled": false,
- "batchSizeMax": 50,
- "batchWaitTimeMax": 5
}, - "changeLog": {
- "createdDateTime": "2024-05-06T16:21:18.545214Z"
}
}
]
}
This API provides capability to create user's Stream Subscriptions
streamId required | string <uuid> (StreamId) Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 Stream UUID |
type | string Value: "STREAM_SUBSCRIPTION" | ||||||||||||||||||||||||||||||||||||||||||||||
name | string Customer-provided stream subscription name | ||||||||||||||||||||||||||||||||||||||||||||||
description | string Customer-provided stream subscription description | ||||||||||||||||||||||||||||||||||||||||||||||
enabled | boolean Stream subscription enabled status | ||||||||||||||||||||||||||||||||||||||||||||||
object (StreamSubscriptionSelector) | |||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
object (StreamSubscriptionSelector) | |||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
object (StreamSubscriptionSink) Create Stream destination | |||||||||||||||||||||||||||||||||||||||||||||||
|
{- "type": "STREAM_SUBSCRIPTION",
- "name": "splunk1",
- "description": "subscription-1",
- "enabled": true,
- "sink": {
- "type": "SPLUNK_HEC",
- "credential": {
- "type": "ACCESS_TOKEN",
- "accessToken": "Splunk <my-access-token>"
}, - "settings": {
- "source": "Equinix",
- "eventIndex": "idx-hec-event",
- "metricIndex": "idx-hec-metric"
}
}
}
{- "uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
- "type": "STREAM_SUBSCRIPTION",
- "name": "stream 1",
- "description": "stream dec 1",
- "state": "PROVISIONED",
- "enabled": true,
- "metricSelector": {
- "include": [
- "equinix.fabric.connection.*"
]
}, - "eventSelector": {
- "include": [
- "equinix.fabric.connection.*"
]
}, - "sink": {
- "type": "SPLUNK_HEC",
- "credential": {
- "type": "ACCESS_TOKEN",
- "accessToken": "Splunk <my-access-token>"
}, - "settings": {
- "source": "Equinix",
- "eventIndex": "idx-hec-event",
- "metricIndex": "idx-hec-metric"
}, - "batchEnabled": false,
- "batchSizeMax": 50,
- "batchWaitTimeMax": 5
}, - "changeLog": {
- "createdDateTime": "2024-05-06T16:21:18.545214Z"
}
}
This API provides capability to delete user's get Stream Subscriptions
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 |
href | string <uri> Stream Subscription URI | ||||||||||||||||||||||||||||||||||||||||||||||
uuid | string <uuid> Equinix-assigned access point identifier | ||||||||||||||||||||||||||||||||||||||||||||||
type | string Value: "STREAM_SUBSCRIPTION" type | ||||||||||||||||||||||||||||||||||||||||||||||
name | string Customer-provided subscription name | ||||||||||||||||||||||||||||||||||||||||||||||
description | string Customer-provided subscription description | ||||||||||||||||||||||||||||||||||||||||||||||
state | string Enum: "PROVISIONING" "PROVISIONED" "REPROVISIONING" "DEPROVISIONING" "DEPROVISIONED" "FAILED" Steam subscription provision state | ||||||||||||||||||||||||||||||||||||||||||||||
enabled | boolean Stream subscription enabled status | ||||||||||||||||||||||||||||||||||||||||||||||
object (StreamSubscriptionSelector) | |||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
object (StreamSubscriptionSelector) | |||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
object (StreamSubscriptionSink) Create Stream destination | |||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
object (Changelog) Change log | |||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
lastErrorMessage | string HTTP response from sink type if error occurred |
{- "uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
- "type": "STREAM_SUBSCRIPTION",
- "name": "stream 1",
- "description": "stream dec 1",
- "state": "PROVISIONED",
- "enabled": true,
- "metricSelector": {
- "include": [
- "equinix.fabric.connection.*"
]
}, - "eventSelector": {
- "include": [
- "equinix.fabric.connection.*"
]
}, - "sink": {
- "type": "SPLUNK_HEC",
- "credential": {
- "type": "ACCESS_TOKEN",
- "accessToken": "Splunk <my-access-token>"
}, - "settings": {
- "source": "Equinix",
- "eventIndex": "idx-hec-event",
- "metricIndex": "idx-hec-metric"
}, - "batchEnabled": false,
- "batchSizeMax": 50,
- "batchWaitTimeMax": 5
}, - "changeLog": {
- "createdDateTime": "2024-05-06T16:21:18.545214Z"
}
}
This API provides capability to update user's Stream Subscriptions
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 |
name | string Customer-provided stream subscription name | ||||||||||||||||||||||||||||||||||||||||||||||
description | string Customer-provided stream subscription description | ||||||||||||||||||||||||||||||||||||||||||||||
enabled | boolean Stream subscription enabled status | ||||||||||||||||||||||||||||||||||||||||||||||
object (StreamSubscriptionFilter) | |||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
object (StreamSubscriptionSelector) | |||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
object (StreamSubscriptionSelector) | |||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||
object (StreamSubscriptionSink) Create Stream destination | |||||||||||||||||||||||||||||||||||||||||||||||
|
{- "name": "splunk1",
- "description": "subscription 1",
- "enabled": true,
- "metricSelector": {
- "include": [
- "equinix.fabric.connection.*"
]
}, - "eventSelector": {
- "include": [
- "equinix.fabric.connection.*"
]
}, - "sink": {
- "type": "SPLUNK_HEC",
- "credential": {
- "type": "ACCESS_TOKEN",
- "accessToken": "my-access-token"
}, - "settings": {
- "source": "Equinix",
- "eventIndex": "idx-hec-event",
- "metricIndex": "idx-hec-metric"
}, - "batchEnabled": false,
- "batchSizeMax": 50,
- "batchWaitTimeMax": 5
}
}
{- "uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
- "type": "STREAM_SUBSCRIPTION",
- "name": "stream 1",
- "description": "stream dec 1",
- "state": "PROVISIONED",
- "enabled": true,
- "metricSelector": {
- "include": [
- "equinix.fabric.connection.*"
]
}, - "eventSelector": {
- "include": [
- "equinix.fabric.connection.*"
]
}, - "sink": {
- "type": "SPLUNK_HEC",
- "credential": {
- "type": "ACCESS_TOKEN",
- "accessToken": "Splunk <my-access-token>"
}, - "settings": {
- "source": "Equinix",
- "eventIndex": "idx-hec-event",
- "metricIndex": "idx-hec-metric"
}, - "batchEnabled": false,
- "batchSizeMax": 50,
- "batchWaitTimeMax": 5
}, - "changeLog": {
- "createdDateTime": "2024-05-06T16:21:18.545214Z"
}
}
This API provides capability to delete user's Stream Subscriptions
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 |
{- "uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
- "type": "STREAM_SUBSCRIPTION",
- "name": "stream 1",
- "description": "stream dec 1",
- "state": "DEPROVISIONING",
- "enabled": true,
- "metricSelector": {
- "include": [
- "equinix.fabric.connection.*"
]
}, - "eventSelector": {
- "include": [
- "equinix.fabric.connection.*"
]
}, - "sink": {
- "type": "SPLUNK_HEC",
- "credential": {
- "type": "ACCESS_TOKEN",
- "accessToken": "Splunk <my-access-token>"
}, - "settings": {
- "source": "Equinix",
- "eventIndex": "idx-hec-event",
- "metricIndex": "idx-hec-metric"
}, - "batchEnabled": false,
- "batchSizeMax": 50,
- "batchWaitTimeMax": 5
}, - "changeLog": {
- "createdDateTime": "2024-05-06T16:21:18.545214Z"
}
}
This API provides capability to retrieve streams
offset | integer Example: offset=1 offset |
limit | integer Example: limit=10 number of records to fetch |
object (Pagination) Pagination response information | |||||||||||||||||||||
| |||||||||||||||||||||
Array of objects (Stream) Data returned from the API call. | |||||||||||||||||||||
Array
|
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1
}, - "data": [
- {
- "uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
- "type": "TELEMETRY_STREAM",
- "name": "stream 1",
- "description": "stream dec 1",
- "project": {
- "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}, - "state": "PROVISIONED",
- "assetsCount": 1,
- "streamSubscriptionsCount": 2,
- "changeLog": {
- "createdDateTime": "2024-05-06T16:21:18.545214Z"
}
}
]
}
This API provides capability to create user's stream
type | string Value: "TELEMETRY_STREAM" | ||
name | string Customer-provided stream name | ||
description | string Customer-provided stream description | ||
object (Project) | |||
|
{- "type": "TELEMETRY_STREAM",
- "name": "splunk1",
- "description": "subscription-1",
- "project": {
- "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}
}
{- "uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
- "type": "TELEMETRY_STREAM",
- "name": "stream1",
- "description": "stream 1",
- "project": {
- "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}, - "state": "PROVISIONED",
- "assetsCount": 1,
- "streamSubscriptionsCount": 2,
- "changeLog": {
- "createdDateTime": "2024-05-06T16:21:18.545214Z"
}
}
This API provides capability to get user's stream
streamId required | string <uuid> (StreamId) Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 Stream UUID |
href | string <uri> Stream URI | ||||||||||||||||||||||||
uuid | string <uuid> Equinix-assigned access point identifier | ||||||||||||||||||||||||
state | string Enum: "PROVISIONING" "PROVISIONED" "REPROVISIONING" "DEPROVISIONING" "DEPROVISIONED" "FAILED" Stream provision state | ||||||||||||||||||||||||
assetsCount | integer Stream assets count | ||||||||||||||||||||||||
streamSubscriptionsCount | integer Stream subscriptions count | ||||||||||||||||||||||||
object (Changelog) Change log | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
type | string Value: "TELEMETRY_STREAM" | ||||||||||||||||||||||||
name | string Customer-provided stream name | ||||||||||||||||||||||||
description | string Customer-provided stream description | ||||||||||||||||||||||||
object (Project) | |||||||||||||||||||||||||
|
{- "uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
- "type": "TELEMETRY_STREAM",
- "name": "stream1",
- "description": "stream 1",
- "project": {
- "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}, - "state": "PROVISIONED",
- "assetsCount": 1,
- "streamSubscriptionsCount": 2,
- "changeLog": {
- "createdDateTime": "2024-05-06T16:21:18.545214Z"
}
}
This API provides capability to update user's stream
streamId required | string <uuid> (StreamId) Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 Stream UUID |
name | string Customer-provided stream name |
description | string Customer-provided stream description |
{- "name": "splunk1",
- "description": "subscription 1"
}
{- "uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
- "type": "TELEMETRY_STREAM",
- "name": "stream1",
- "description": "stream 1",
- "project": {
- "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}, - "state": "PROVISIONED",
- "assetsCount": 1,
- "streamSubscriptionsCount": 2,
- "changeLog": {
- "createdDateTime": "2024-05-06T16:21:18.545214Z"
}
}
This API provides capability to delete user's stream
streamId required | string <uuid> (StreamId) Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 Stream UUID |
{- "uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
- "type": "TELEMETRY_STREAM",
- "name": "stream1",
- "description": "stream 1",
- "project": {
- "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
}, - "state": "DEPROVISIONING",
- "assetsCount": 1,
- "streamSubscriptionsCount": 2,
- "changeLog": {
- "createdDateTime": "2024-05-06T16:21:18.545214Z"
}
}
This API provides capability to retrieve stream assets
offset | integer Example: offset=1 offset |
limit | integer Example: limit=10 number of records to fetch |
object (StreamAssetFilters) | |||||||||||
| |||||||||||
object (PaginationRequest) Pagination request information | |||||||||||
| |||||||||||
Array of objects (StreamAssetSortCriteria) | |||||||||||
Array
|
object (Pagination) Pagination response information | |||||||||||
| |||||||||||
Array of objects (StreamAsset) Data returned from the API call. | |||||||||||
Array
|
{- "filter": {
- "and": [
- {
- "property": "/streamUuid",
- "operator": "=",
- "values": [
- "e684aa26-8276-48b7-bb42-a6d9def0a419"
]
}
]
}, - "pagination": {
- "offset": 0,
- "limit": 20
}, - "sort": [
- {
- "direction": "DESC",
- "property": "/uuid"
}
]
}
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1
}, - "data": [
- {
- "uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
- "type": "XF_PORT",
- "metricsEnabled": false,
- "attachmentStatus": "ATTACHED"
}
]
}
This API provides capability to get user's assets attached to a stream
assetId required | string <uuid> (AssetId_1) Example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 asset UUID |
asset required | string (Asset) Enum: "ports" "connections" "routers" "metros" "organizations" "projects" asset |
streamId required | string <uuid> (StreamId) Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 Stream UUID |
href | string <uri> Stream Asset URI |
uuid | string <uuid> Equinix-assigned access point identifier |
type | string Enum: "XF_PORT" "IP_VC" "EVPLAN_VC" "EVPL_VC" "XF_METRO" "XF_ROUTER" "ORGANIZATION" "PROJECT" Asset types |
metricsEnabled | boolean enable metric |
attachmentStatus | string Enum: "ATTACHING" "ATTACHED" "DETACHED" "DETACHING" "FAILED" asset status |
{- "uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
- "type": "IP_VC",
- "metricsEnabled": false,
- "attachmentStatus": "ATTACHED"
}
This API provides capability to attach an asset to a stream
assetId required | string <uuid> (AssetId_1) Example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 asset UUID |
asset required | string (Asset) Enum: "ports" "connections" "routers" "metros" "organizations" "projects" asset |
streamId required | string <uuid> (StreamId) Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 Stream UUID |
metricsEnabled | boolean enable metric |
{- "metricsEnabled": false
}
{- "uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
- "type": "XF_ROUTER",
- "metricsEnabled": false,
- "attachmentStatus": "ATTACHING"
}
This API provides capability to detach an asset from a stream
assetId required | string <uuid> (AssetId_1) Example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 asset UUID |
asset required | string (Asset) Enum: "ports" "connections" "routers" "metros" "organizations" "projects" asset |
streamId required | string <uuid> (StreamId) Example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 Stream UUID |
{- "uuid": "d684aa26-8276-48b7-bb42-a6d9def0a418",
- "type": "XF_ROUTER",
- "metricsEnabled": false,
- "attachmentStatus": "DETACHING"
}
GET All service health statys with an option query parameter to return all Equinix Fabric customer in which the customer has a presence.
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 | |||||||
|
{- "href": null,
- "version": "4.4",
- "release": "2022.4.0",
- "description": "Equinix Fabric Health Check API",
- "state": "HEALTHY",
- "apiServices": [
- {
- "route": "/prices",
- "status": "UP",
- "changedDateTime": "2022-10-03T18:37:54.760+00:00"
}, - {
- "route": "/connections",
- "status": "UP",
- "changedDateTime": "2022-10-03T18:37:56.818+00:00"
}, - {
- "route": "/ports",
- "status": "UP",
- "changedDateTime": "2022-10-03T18:37:56.886+00:00"
}, - {
- "route": "/serviceTokens",
- "status": "UP",
- "changedDateTime": "2022-10-03T18:37:56.919+00:00"
}, - {
- "route": "/stats",
- "status": "UP",
- "changedDateTime": "2022-10-03T18:37:56.951+00:00"
}, - {
- "route": "/routers",
- "status": "UP",
- "changedDateTime": "2022-10-03T18:37:57.271+00:00"
}, - {
- "route": "/serviceProfiles",
- "status": "UP",
- "changedDateTime": "2022-10-03T18:38:01.298+00:00"
}
]
}
This API provides capability to create user's Fabric Network
dryRun | boolean Default: false option to verify that API calls will succeed |
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 | ||||||||||
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 | |||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||
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 | ||||||||||||||||||||||||
Array
|
{- "type": "EVPLAN",
- "name": "My-Network-1",
- "scope": "GLOBAL",
- "project": {
- "projectId": "d64fa54a-cfcb-4fb0-82ee-86cf47007fa2"
}, - "notifications": [
- {
- "type": "ALL",
- "emails": [
- "test@equinix.com"
]
}
]
}
{- "uuid": "0633e83f-116f-481d-b86f-c472271d1a8c",
- "type": "EVPLAN",
- "name": "My-evplan-network-1",
- "scope": "GLOBAL",
- "state": "INACTIVE",
- "connectionsCount": 0,
- "account": {
- "orgId": 14510,
- "organizationName": "fabric",
- "globalCustId": "0026u00000595sBAAM"
}, - "change": {
- "uuid": "ce7c0bbc-7bd2-431f-903f-de796ea9e858",
- "type": "NETWORK_CREATION"
}, - "operation": {
- "equinixStatus": "PROVISIONING"
}, - "changeLog": {
- "createdBy": "fabric",
- "createdByFullName": "fabric fabric",
- "createdByEmail": "fabric@gmail.com",
- "createdDateTime": "2025-03-03T19:37:29.326Z"
}, - "links": {
- "rel": "getConnectionsByNetworkUuid",
- "method": "GET",
- "contentType": "application/json",
- "authenticate": true
}, - "project": {
- "projectId": "d64fa54a-cfcb-4fb0-82ee-86cf47007fa2"
}, - "notifications": [
- {
- "type": "ALL",
- "emails": [
- "fabric@gmail.com"
]
}
]
}
This API provides capability to retrieve user's Fabric Network
networkId required | string <uuid> (NetworkId) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Network UUID |
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 | |||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||
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 | ||||||||||||||||||||||||
Array
|
{- "type": "EVPLAN",
- "uuid": "92dc376a-a932-43aa-a6a2-c806dedbd784",
- "name": "My-EVPLAN-1",
- "state": "ACTIVE",
- "location": {
- "region": "EMEA"
}, - "scope": "REGIONAL",
- "connectionsCount": 0,
- "project": {
- "projectId": "123456"
}, - "notifications": [
- {
- "type": "ALL",
- "emails": [
- "test@equinix.com"
]
}
], - "operation": {
- "equinixStatus": "PROVISIONED"
}, - "changeLog": {
- "createdBy": "testuser",
- "createdDateTime": "2020-05-21T10:30:00Z",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "updatedBy": "testuser",
- "updatedDateTime": "2020-05-21T10:30:00Z",
- "updatedByEmail": "testuser@equinix.com",
- "updatedByFullName": "testuser testuser"
}, - "links": [
- {
- "rel": "getConnectionsByNetworkUuid",
- "method": "GET",
- "contentType": "application/json",
- "authenticate": true
}
]
}
This API provides capability to delete user's Fabric Network
networkId required | string <uuid> (NetworkId) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Network UUID |
{- "type": "EVPLAN",
- "uuid": "92dc376a-a932-43aa-a6a2-c806dedbd784",
- "name": "My-EVPLAN-1",
- "state": "INACTIVE",
- "change": {
- "uuid": "6d500177-9404-41f2-99e8-2bf1a84d8db5",
- "type": "NETWORK_DELETION"
}, - "location": {
- "region": "EMEA"
}, - "scope": "REGIONAL",
- "project": {
- "projectId": "123456"
}, - "notifications": [
- {
- "type": "ALL",
- "emails": [
- "test@equinix.com"
]
}
], - "operation": {
- "equinixStatus": "DEPROVISIONING"
}, - "changeLog": {
- "createdBy": "testuser",
- "createdDateTime": "2020-05-21T10:30:00Z",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "updatedBy": "testuser1",
- "updatedDateTime": "2020-05-21T10:30:00Z",
- "updatedByEmail": "testuser@equinix.com",
- "updatedByFullName": "testuser testuser",
- "deletedBy": "testuser1",
- "deletedDateTime": "2020-05-21T10:30:00Z",
- "deletedByEmail": "testuser@equinix.com",
- "deletedByFullName": "testuser testuser"
}
}
This API provides capability to update user's Fabric Network
networkId required | string <uuid> (NetworkId) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Network UUID |
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 |
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 | |||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||
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 | ||||||||||||||||||||||||
Array
|
[- {
- "op": "replace",
- "path": "/name",
- "value": "NewName"
}
]
{- "type": "EVPLAN",
- "uuid": "92dc376a-a932-43aa-a6a2-c806dedbd784",
- "name": "My-EVPLAN-1",
- "state": "ACTIVE",
- "change": {
- "uuid": "6d500177-9404-41f2-99e8-2bf1a84d8db5",
- "type": "NETWORK_UPDATE"
}, - "location": {
- "region": "EMEA"
}, - "scope": "REGIONAL",
- "connectionsCount": 0,
- "project": {
- "projectId": "123456"
}, - "notifications": [
- {
- "type": "ALL",
- "emails": [
- "test@equinix.com"
]
}
], - "operation": {
- "equinixStatus": "PROVISIONED"
}, - "changeLog": {
- "createdBy": "testuser",
- "createdDateTime": "2020-05-21T10:30:00Z",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "updatedBy": "testuser",
- "updatedDateTime": "2020-05-21T10:30:00Z",
- "updatedByEmail": "testuser@equinix.com",
- "updatedByFullName": "testuser testuser"
}, - "links": [
- {
- "rel": "getConnectionsByNetworkUuid",
- "method": "GET",
- "contentType": "application/json",
- "authenticate": true
}
]
}
The API provides capability to get list of user's Fabric Network using search criteria, including optional filtering, pagination and sorting
object (NetworkFilter) | |||||||||||
| |||||||||||
object (PaginationRequest) Pagination request information | |||||||||||
| |||||||||||
Array of objects (NetworkSortCriteria) | |||||||||||
Array
|
object (Pagination) Pagination response information | |||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||
Array of objects (NetworkSortCriteriaResponse) | |||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||
Array of objects (Network) | |||||||||||||||||||||||||||||||
Array
|
{- "filter": {
- "and": [
- {
- "property": "/state",
- "operator": "=",
- "values": [
- "ACTIVE"
]
}
]
}, - "pagination": {
- "offset": 0,
- "limit": 20
}, - "sort": [
- {
- "direction": "DESC",
- "property": "/changeLog/createdDateTime"
}
]
}
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1
}, - "data": [
- {
- "type": "EVPLAN",
- "uuid": "92dc376a-a932-43aa-a6a2-c806dedbd784",
- "platformUuid": "19dc376a-a932-43aa-a6a2-c806dedbd730",
- "name": "My-EVPLAN-1",
- "state": "ACTIVE",
- "location": {
- "region": "EMEA"
}, - "scope": "REGIONAL",
- "connectionsCount": 0,
- "project": {
- "projectId": "567"
}, - "notifications": [
- {
- "type": "ALL",
- "emails": [
- "test@equinix.com"
]
}
], - "operation": {
- "equinixStatus": "PROVISIONED"
}, - "changeLog": {
- "createdBy": "testuser",
- "createdDateTime": "2020-05-21T10:30:00Z",
- "createdByEmail": "testuser@equinix.com",
- "createdByFullName": "testuser testuser",
- "updatedBy": "testuser1",
- "updatedDateTime": "2020-05-21T10:30:00Z",
- "updatedByEmail": "testuser@equinix.com",
- "updatedByFullName": "testuser testuser"
}, - "links": [
- {
- "rel": "getConnectionsByNetworkUuid",
- "method": "GET",
- "contentType": "application/json",
- "authenticate": true
}
]
}
], - "sort": [
- {
- "property": "/changeLog/updatedDateTime",
- "direction": "DESC"
}
]
}
The API provides capability to get list of user's Fabric Network connections
networkId required | string <uuid> (NetworkId) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Network UUID |
object (Pagination) Pagination response information | |||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||
Array of objects (Connection) | |||||||||||||||||||||||||||||||||||||||||||||
Array
|
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 2
}, - "data": [
- {
- "type": "IP_VC",
- "uuid": "9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81"
}, - {
- "type": "IP_VC",
- "uuid": "38a1eb68-4daf-4ef0-bd7f-6970727b6fc1"
}
]
}
The API provides capability to get list of user's Fabric Network changes
networkId required | string <uuid> (NetworkId) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Network UUID |
object (Pagination) Pagination response information | |||||||||||||||
| |||||||||||||||
Array of objects (NetworkChange) | |||||||||||||||
Array
|
{- "pagination": {
- "offset": 0,
- "limit": 20,
- "total": 1
}, - "data": [
- {
- "type": "NETWORK_CREATION",
- "uuid": "4b17da68-3d6b-436d-9c8f-2105f3b950d9",
- "status": "COMPLETED",
- "createdDateTime": "2020-05-21T10:30:00Z",
- "updatedDateTime": "2020-05-21T10:30:50Z"
}, - {
- "type": "NETWORK_DELETION",
- "uuid": "da2a2f1b-9ba0-415b-85d6-234bd4c737ec",
- "status": "REQUESTED",
- "createdDateTime": "2020-05-21T10:30:00Z",
- "updatedDateTime": "2020-05-21T10:30:00Z"
}
]
}
This API provides capability to retrieve user's Fabric Network Change
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 |
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
|
{- "type": "NETWORK_CREATION",
- "uuid": "4b17da68-3d6b-436d-9c8f-2105f3b950d9",
- "status": "COMPLETED",
- "createdDateTime": "2020-05-21T10:30:00Z",
- "updatedDateTime": "2020-05-21T10:30:50Z"
}
The API provides capability to get subscription
subscriptionId required | string <uuid> (SubscriptionId) Example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 Subscription UUID |
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 | |||||||||||||||||||||||||
| |||||||||||||||||||||||||
metroCodes | Array of strings List of available metro | ||||||||||||||||||||||||
required | Array of objects (SubscriptionEntitlementResponse) List of entitlements associated with the subscription | ||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||
object (Changelog) Change log | |||||||||||||||||||||||||
|
{- "uuid": "c5557b51-7938-4f7d-afaa-41b930903a5e",
- "state": "ACTIVE",
- "marketplace": "AWS",
- "offerType": "PRIVATE_OFFER",
- "isAutoRenew": false,
- "offerId": "offer-wqquayy2jy25o",
- "trial": {
- "enabled": true
}, - "metroCodes": [
- "SV",
- "DC"
], - "entitlements": [
- {
- "uuid": "a15b6b20-b765-4bf7-a661-a3e9372d5435",
- "quantityEntitled": 1,
- "quantityConsumed": 0,
- "quantityAvailable": 1,
- "asset": {
- "type": "XF_ROUTER",
- "package": {
- "code": "STANDARD"
}
}
}, - {
- "uuid": "2e3a9041-19ce-4c80-add3-3e3a069fc5e9",
- "quantityEntitled": 1,
- "quantityConsumed": 0,
- "quantityAvailable": 1,
- "asset": {
- "type": "IP_VC",
- "bandwidth": 500
}
}, - {
- "uuid": "9e30f661-d92e-4083-812f-db359807806e",
- "quantityEntitled": 1,
- "quantityConsumed": 0,
- "quantityAvailable": 1,
- "asset": {
- "type": "IPWAN_VC",
- "bandwidth": 200
}
}
], - "changeLog": {
- "createdBy": "adminuser",
- "createdDateTime": "2020-05-21T10:30:00Z",
- "updatedBy": "adminuser",
- "updatedDateTime": "2020-05-21T10:30:00Z"
}
}