Fabric Cloud Routers

Create Fabric Cloud Router

POST /fabric/v4/routers
Method POST
URL or Endpoint /fabric/v4/routers
Headers Authorization, Content-Type
Path Parameters Not applicable
Query Parameters Not applicable
Body Parameters type, name, location, package, order, notifications, account, project

This API creates a Fabric Cloud Router instance.


Sample curl request

Copy 
curl -X
POST 'https: //api.equinix.com/fabric/v4/routers'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "type": "XF_ROUTER",
    "name": "My-Fabric-Cloud-Router",
    "location": {
        "metroCode": "SV"
    },
    "package": {
        "code": "LAB"
    },
    "order": {
        "purchaseOrderNumber": "1-129105284100"
    },
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "test@test.com"
            ]
        }
    ],
    "account": {
        "accountNumber": 272010
    },
    "project": {
        "projectId": "995072000433550"
    }
}'

Body parameters

Parameter
Description
type string
REQUIRED
 Asset instance type.
Example: XF_ROUTER - Fabric Cloud Router.
name string
REQUIRED
 Fabric Cloud Router instance name.
Example: My-Fabric-Cloud-Router
location object
REQUIRED
 Fabric Cloud Router location information.
metroCode string
REQUIRED
 Metropolitan area identifier.
Example: SV
package object
REQUIRED
 Fabric Cloud Router package determining the number of supported routes and Network Access Control Lists (NACL).
code string
REQUIRED
 Fabric Cloud Router package code.
Applicable values:
  • LAB - Max Routes IPv4 = 50; Max Routes IPv6 = 50; 10Mbps max per connection ingress/egress bandwidth limit; Max connections per FCR: 10 (Trial package)
  • STANDARD - Max Routes IPv4 = 1000; Max Routes IPv6 = 100
order object
OPTIONAL
 Order details.
purchaseOrderNumber string
OPTIONAL
 Purchase order identifier.
Example: 1-129105284100
notifications object
REQUIRED
 Notification preferences regarding changes in asset configuration or its status.
type string
REQUIRED
 Notification preferences for a specified asset.
Applicable values: ALL
emails array[string]
REQUIRED
 List of recipients.
Minimum: 1
Maximum: 12
Example: ["test@equinix.com"]
account object
REQUIRED
 Customer billing account information.
accountNumber integer
REQUIRED
 Equinix-assigned account number.
Example: 272010
project object
REQUIRED
 Customer resource hierarchy project information.
Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId string
REQUIRED
Customer project identifier.
Example: 995072000433550

If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.


Sample response

Copy 
{
    "href": "https://api.equinix.com/fabric/v4/routers/201b7346-a9eb-42fe-ae7a-08148c71928d",
    "uuid": "201b7346-a9eb-42fe-ae7a-08148c71928d",
    "state": "PROVISIONED",
    "type": "XF_ROUTER",
    "name": "My-Fabric-Cloud-Router",
    "location": {
        "metroCode": "HH"
    },
    "package": {
        "code": "LAB"
    },
    "order": {
        "purchaseOrderNumber": "1-129105284100"
    },
    "project": {
        "projectId": "12345"
    },
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "abc@abc.com"
            ]
        }
    ],
    "account": {
        "accountNumber": 123
    },
    "bgpIpv4RoutesCount": 0,
    "bgpIpv6RoutesCount": 0,
    "connectionCount": 0,
    "changeLog": {
        "createdBy": "abc@xyz.com",
        "createdByFullName": "abc",
        "createdByEmail": "abc@xyz.com",
        "createdDateTime": "2021-09-24T06:59:46Z"
    }
}

Response payload body description

Parameter
Description
href string
 An absolute URL that returns the specified asset.
Example:https://api.equinix.com/fabric/v4/routers/3a58dd05-f46d-4b1d-a154-2e85c396ea62
uuid string
 Equinix-assigned asset identifier.
Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
state string
 Asset lifecycle stage.
  • PENDING - Fabric Cloud Router creation pending.
  • PROVISIONING - Fabric Cloud Router is being provisioned.
  • PROVISIONED - Fabric Cloud Router has been provisioned.
  • LOCKED - Fabric Cloud Router package upgrade has failed. Existing connections associated with this Fabric Cloud Router instance continue to work but you can't make any changes to them or create new ones. For assistance, open a support case with Equinix Service Desk.
  • DEPROVISIONING - Fabric Cloud Router is being deprovisioned.
  • DEPROVISIONED - Fabric Cloud Router has been deprovisioned.
type string
 Asset instance type.
Example: XF_ROUTER - Fabric Cloud Router.
name string
 Fabric Cloud Router instance name.
Example: My-Fabric-Cloud-Router
location object
 Fabric Cloud Router location information.
metroCode string
 Metropolitan area identifier.
Example: SV
package object
 Fabric Cloud Router package determining the number of supported routes and Network Access Control Lists (NACL).
code string
 Fabric Cloud Router package code.
Applicable values:
  • LAB - Max Routes IPv4 = 50; Max Routes IPv6 = 50; 10Mbps max per connection ingress/egress bandwidth limit; Max connections per FCR: 10 (Trial package)
  • STANDARD - Max Routes IPv4 = 1000; Max Routes IPv6 = 100
order object
 Order details.
purchaseOrderNumber string
 Purchase order identifier.
Example: 1-129105284100
project object
 Customer resource hierarchy project information.
Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId string
 Customer project identifier.
Example: 995072000433550
notifications object
 Notification preferences regarding changes in asset configuration or its status.
type string
 Notification preferences for a specified asset.
Applicable values: ALL
emails array[string]
 List of recipients.
Minimum: 1
Maximum: 12
Example: ["test@equinix.com"]
account object
 Customer billing account information.
accountNumber integer
 Equinix-assigned account number.
Example: 272010
bgpIpv4RoutesCount integer
 Number of IPv4 BGP routes in use.
Example: 0
bgpIpv6RoutesCount integer
 Number of IPv6 BGP routes in use.
Example: 0
connectionCount integer
 Number of connections associated with this Fabric Cloud Router instance.
Example: 0
changeLog object
 A permanent record of asset creation, modification, or deletion.
createdBy string
 Identity of the asset creator.
Example: AverageJoe
createdByFullName string
 First and last name of the asset creator.
Example: Joe Average
createdByEmail string
 Email address of the asset creator.
Example:joe@average.org
createdDateTime string
 Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z

Get Specified Fabric Cloud Router

GET /fabric/v4/routers/{uuid}
Method GET
URL or Endpoint /fabric/v4/routers/{uuid}
Headers Authorization, Content-Type
Path Parameters uuid
Query Parameters Not applicable
Body Parameters Not applicable

This API request retrieves details of a specified Fabric Cloud Router instance.


Sample curl request

Copy 
curl -X
GET 'https://api.equinix.com/fabric/v4/routers/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter
Description
uuid string
REQUIRED		 Equinix-assigned Fabric Cloud Router identifier.
Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.


Sample response

Copy 
{
    "href": "https://api.equinix.com/fabric/v4/routers/201b7346-a9eb-42fe-ae7a-08148c71928d",
    "uuid": "201b7346-a9eb-42fe-ae7a-08148c71928d",
    "state": "PROVISIONED",
    "type": "XF_ROUTER",
    "name": "My-Fabric-Cloud-Router",
    "location": {
        "metroCode": "HH"
    },
    "package": {
        "code": "LAB"
    },
    "order": {
        "purchaseOrderNumber": "1-129105284100"
    },
    "project": {
        "projectId": "12345"
    },
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "abc@abc.com"
            ]
        }
    ],
    "account": {
        "accountNumber": 123
    },
    "bgpIpv4RoutesCount": 0,
    "bgpIpv6RoutesCount": 0,
    "distinctIpv4PrefixesCount": 4,
    "distinctIpv6PrefixesCount": 4,
    "connectionCount": 0,
    "changeLog": {
        "createdBy": "abc@xyz.com",
        "createdByFullName": "abc",
        "createdByEmail": "abc@xyz.com",
        "createdDateTime": "2021-09-24T06:59:46Z"
    }
}

Response payload body description

Parameter
Description
href string
 An absolute URL that returns the specified asset.
Example:https://api.equinix.com/fabric/v4/routers/3a58dd05-f46d-4b1d-a154-2e85c396ea62
uuid string
 Equinix-assigned asset identifier.
Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
state string
 Asset lifecycle stage.
  • PENDING - Fabric Cloud Router creation pending.
  • PROVISIONING - Fabric Cloud Router is being provisioned.
  • PROVISIONED - Fabric Cloud Router has been provisioned.
  • LOCKED - Fabric Cloud Router package upgrade has failed. Existing connections associated with this Fabric Cloud Router instance continue to work but you can't make any changes to them or create new ones. For assistance, open a support case with Equinix Service Desk.
  • DEPROVISIONING - Fabric Cloud Router is being deprovisioned.
  • DEPROVISIONED - Fabric Cloud Router has been deprovisioned.
type string
 Asset instance type.
Example: XF_ROUTER - Fabric Cloud Router.
name string
 Fabric Cloud Router instance name.
Example: My-Fabric-Cloud-Router
location object
 Fabric Cloud Router location information.
metroCode string
 Metropolitan area identifier.
Example: SV
package object
 Fabric Cloud Router package determining the number of supported routes and Network Access Control Lists (NACL).
code string
 Fabric Cloud Router package code.
Applicable values:
  • LAB - Max Routes IPv4 = 50; Max Routes IPv6 = 50; 10Mbps max per connection ingress/egress bandwidth limit; Max connections per FCR: 10 (Trial package)
  • STANDARD - Max Routes IPv4 = 1000; Max Routes IPv6 = 100
order object
 Order details.
purchaseOrderNumber string
 Purchase order identifier.
Example: 1-129105284100
project object
 Customer resource hierarchy project information.
Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId string
 Customer project identifier.
Example: 995072000433550
notifications object
 Notification preferences regarding changes in asset configuration or its status.
type string
 Notification preferences for a specified asset.
Applicable values: ALL
emails array[string]
 List of recipients.
Minimum: 1
Maximum: 12
Example: ["test@equinix.com"]
account object
 Customer billing account information.
accountNumber integer
 Equinix-assigned account number.
Example: 272010
bgpIpv4RoutesCount integer
 Number of IPv4 BGP routes in use (including non-distinct prefixes).
Example: 0
bgpIpv6RoutesCount integer
 Number of IPv6 BGP routes in use (including non-distinct prefixes).
Example: 0
distinctIpv4PrefixesCount integer
 Number of distinct IPv4 routes.
Example: 4
distinctIpv6PrefixesCount integer
 Number of distinct IPv6 routes.
Example: 4
connectionCount integer
 Number of connections associated with this Fabric Cloud Router instance.
Example: 0
changeLog object
 A permanent record of asset creation, modification, or deletion.
createdBy string
 Identity of the asset creator.
Example: AverageJoe
createdByFullName string
 First and last name of the asset creator.
Example: Joe Average
createdByEmail string
 Email address of the asset creator.
Example:joe@average.org
createdDateTime string
 Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z

Update Fabric Cloud Router

PATCH /fabric/v4/routers/{uuid}
Method PATCH
URL or Endpoint /fabric/v4/routers/{uuid}
Headers Authorization, Content-Type
Path Parameters uuid
Query Parameters Not applicable
Body Parameters op, path, value

This API modifies Fabric Cloud Router instance parameters.


Sample curl request

Copy 
curl -X
PATCH 'https: //api.equinix.com/fabric/v4/routers/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '[
    {
        "op": "replace",
        "path": "/name",
        "value": "Cloud-Router-2"
    }
]'

Path parameters

Parameter
Description
uuid string
REQUIRED		 Equinix-assigned Fabric Cloud Router identifier.
Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

Body parameters

Parameter
Description
op string
REQUIRED
 Update reqest type.
Applicable values:
  • replace
  • add
  • remove
path string
REQUIRED
 Parameter path.
Applicable values:
  • /name
  • /package/code
value string
REQUIRED
 New parameter value.
/name
value string
REQUIRED
 Fabric Cloud Router instance name.
Example: myUpdatedFabricCloudRouter
/package/code
value string
REQUIRED
 Fabric Cloud Router package code that determines the maximum allowed number of routes and ACL rules. Note that when you upgrade a Fabric Cloud Router package, you can only upgrade to a higher package level.
Applicable values:
  • LAB - Max Routes IPv4 = 50; Max Routes IPv6 = 50; 10Mbps max per connection ingress/egress bandwidth limit; Max connections per FCR: 10 (Trial package)
  • STANDARD - Max Routes IPv4 = 1000; Max Routes IPv6 = 100

If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.


Sample response

Copy 
{
    "href": "https://api.equinix.com/fabric/v4/routers/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
    "uuid": "3c9b8e7a2-f3b1-4576-a4a9-1366a63df170",
    "state": "PROVISIONED",
    "operation": {
        "bgpIpv4RoutesUsage": 0,
        "bgpIpv6RoutesUsage": 0,
        "staticIpv4RoutesUsage": 0,
        "staticIpv6RoutesUsage": 0,
        "aclsUsage": 0,
        "aclRulesUsage": 0,
        "connectionCount": 0
    },
    "type": "XF_ROUTER",
    "name": "Cloud-Router-2",
    "location": {
        "metroCode": "HH"
    },
    "package": {
        "code": "LAB"
    },
    "order": {
        "purchaseOrderNumber": "1-129105284100"
    },
    "project": {
        "projectId": 123456
    },
    "notifications": [
        {
            "type": "ALL",
            "emails": [
                "abc@abc.com"
            ]
        }
    ],
    "account": {
        "accountNumber": 123
    },
    "changelog": {
        "createdDateTime": "2021-07-15T19:30:29.526Z",
    }
}

Response payload body description

Parameter Type Example values Description
href string https://api.equinix.com/fabric/v4/routers/3a58dd05-f46d-4b1d-a154-2e85c396ea62 An absolute URL that returns the specified asset.
uuid string 3a58dd05-f46d-4b1d-a154-2e85c396ea62 Equinix-assigned asset identifier.
state string PROVISIONED Asset lifecycle stage.

PENDING - Fabric Cloud Router creation pending.

PROVISIONING - Fabric Cloud Router is being provisioned.

PROVISIONED - Fabric Cloud Router has been provisioned.

LOCKED - Fabric Cloud Router package upgrade has failed. Existing connections associated with this Fabric Cloud Router instance continue to work but you can't make any changes to them or create new ones. For assistance, open a support case with Equinix Service Desk.

DEPROVISIONING - Fabric Cloud Router is being deprovisioned.

DEPROVISIONED - Fabric Cloud Router has been deprovisioned.
operation object - Operational status information.
type string XF_ROUTER Asset instance type.

XF_ROUTER - Fabric Cloud Router.
name string Cloud-Router-2 Fabric Cloud Router instance name.
location object - Fabric Cloud Router location information.
package object - Fabric Cloud Router package determining the number of supported routes and Access Control Lists (ACL).
order object - Order details.
project object - Project data in customer resource hierarchy.
notifications array[object] - Subscriber preferences for notification of changes in asset configuration or status.
account object - Customer billing account data.
changeLog object - A permanent record of asset creation, modification, or deletion.
operation
bgpIpv4RoutesUsage integer 0 Number of IPv4 BGP routes in use.
bgpIpv6RoutesUsage integer 0 Number of IPv6 BGP routes in use.
staticIpv4RoutesUsage integer 0 Number of IPv4 static routes in use.
staticIpv6RoutesUsage integer 0 Number of IPv6 static routes in use.
aclsUsage integer 0 Number of Access Control Lists (ACL) in use.
aclRulesUsage integer 0 Number of ACL rules in use.
connectionCount integer 0 Total number of connections to the given Fabric Cloud Router instance.
location
metroCode string HH Metropolitan area identifier.
package
code string LAB Fabric Cloud Router package code.

LAB - Max Routes IPv4 = 50; Max Routes IPv6 = 50; 10Mbps max per connection ingress/egress bandwidth limit; Max connections per FCR: 10 (Trial package)

STANDARD - Max Routes IPv4 = 1000; Max Routes IPv6 = 100

order
purchaseOrderNumber string 1-129105284100 Subscriber's purchase order identifier.
project
projectId integer 123456 Project identifier.
notifications
type string ALL Notification preferences for a specified asset, such as a service token, port, access point, or profile.
emails array[string] ["test@equinix.com"] List of recipients.
account
accountNumber integer 123 Equinix-assigned account number.
changeLog
changeLog.createdDateTime string 2021-07-15T19:30:29.526Z Asset creation timestamp in the IETF ISO 8601 extended date/time format:

YYYY-MM-DDTHH:MM:SS.000+0000

Manage Routing Tables

POST /fabric/v4/routers/{uuid}/actions
Method POST
URL or Endpoint /fabric/v4/routers/{uuid}/actions
Headers Authorization, Content-Type
Path Parameters uuid
Query Parameters Not applicable
Body Parameters type

This API request triggers update of the Fabric Cloud Router's routing tables.


Sample curl request

Copy 
curl -X
POST 'https://api.equinix.com/fabric/v4/routers/638895bc-4458-4627-9a3d-02c76ab362d7/actions'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "type": "ROUTE_TABLE_ENTRY_UPDATE"
}'

Path parameters

Parameter Mandatory Type Example Values Description
uuid yes string 638895bc-4458-4627-9a3d-02c76ab362d7 Equinix-assigned Fabric Cloud Router instance identifier.

Body parameters

Parameter Mandatory Type Example Values Description
type yes string ROUTE_TABLE_ENTRY_UPDATE

Routing table management action.

  • ROUTE_TABLE_ENTRY_UPDATE - Update routing table.

  • RECEIVED_ROUTE_ENTRY_UPDATE - See all the prefixes learned via BGP

  • ADVERTISED_ROUTE_ENTRY_UPDATE - See the prefixes that FCR is sending via BGP

 
connection no object  

An object that has the connection details. Mandatory for RECEIVED_ROUTE_ENTRY_UPDATE and ADVERTISED_ROUTE_ENTRY_UPDATE types.
connection.uuid no string 3a58dd05-f46d-4b1d-a154-2e85c396ea62

Unique Id of the connection. Mandatory for RECEIVED_ROUTE_ENTRY_UPDATE and ADVERTISED_ROUTE_ENTRY_UPDATE types.

If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.


Sample response

Copy 
{
    "type": "ROUTE_TABLE_ENTRY_UPDATE",
    "uuid": "37c10edc-ba2e-4240-a850-8a48f9c47d00",
    "state": "PENDING",
    "changeLog": {
        "createdDateTime": "2021-07-15T19:30:29.526Z",
        "updatedDateTime": "2021-08-15T19:30:29.526Z"
    }
}

Response payload body description

Parameter Type Example values Description
type string ROUTE_TABLE_ENTRY_UPDATE

Routing table management action.

  • ROUTE_TABLE_ENTRY_UPDATE - Update routing table.

  • RECEIVED_ROUTE_ENTRY_UPDATE - See all the prefixes learned via BGP

  • ADVERTISED_ROUTE_ENTRY_UPDATE - See the prefixes that FCR is sending via BGP
href string

https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/actions/1e9414f1-763e-4c0a-86c6-0bc8336048d9

 A URL that has the specified asset.
uuid string 3a58dd05-f46d-4b1d-a154-2e85c396ea62 Equinix-assigned action request Id.
state string PENDING

Action execution status.

  • PENDING - Requested action execution pending.
  • SUCCEEDED - Requested action completed successfully.
  • FAILED - Requested action execution failed.
connection object - An object that has the connection Id.
connection.uuid string 7898dd05-f46d-4b1d-a154-2e85c396ea89 Unique Id of the connection.
changeLog object - A permanent record of asset creation, modification, or deletion.
changeLog.createdDateTime string 2021-07-15T19:30:29.526Z Asset creation timestamp in the IETF ISO 8601 extended date/time format:

YYYY-MM-DDTHH:MM:SS.000+0000
changeLog.updatedDateTime string 2021-08-15T19:30:29.526Z Asset update timestamp in the IETF ISO 8601 extended date/time format:

YYYY-MM-DDTHH:MM:SS.000+0000

Get Routing Tables Management Requests

GET /fabric/v4/routers/{uuid}/actions?state=PENDING
Method GET
URL or Endpoint /fabric/v4/routers/{uuid}/actions?state=PENDING
Headers Authorization
Path Parameters uuid
Query Parameters state
Body Parameters Not applicable

This API retrieves routing tables management actions requests.


Sample curl request

Copy 
curl -X
GET 'https://api.equinix.com/fabric/v4/routers/638895bc-4458-4627-9a3d-02c76ab362d7/actions?state=PENDING'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter Mandatory Type Example Values Description
uuid yes string 638895bc-4458-4627-9a3d-02c76ab362d7 Equinix-assigned Fabric Cloud Router instance identifier.

Query parameters

Parameter Mandatory Type Example Values Description
state no string PENDING Action execution status.
  • PENDING - Requested action execution pending.
  • SUCCEEDED - Requested action has been completed successfully.
  • FAILED - Requested action execution has failed.

If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.


Sample response

Copy 
{
    "type": "ROUTE_TABLE_ENTRY_UPDATE",
    "uuid": "37c10edc-ba2e-4240-a850-8a48f9c47d00",
    "state": "PENDING",
    "changeLog": {
        "createdDateTime": "2021-07-15T19:30:29.526Z",
        "updatedDateTime": "2021-08-15T19:30:29.526Z"
    }
}

Response payload body description

Parameter Type Example values Description
type string ROUTE_TABLE_ENTRY_UPDATE Routing table management action.
ROUTE_TABLE_ENTRY_UPDATE
uuid string 3a58dd05-f46d-4b1d-a154-2e85c396ea62 Equinix-assigned action request identifier.
state string PENDING Action execution status.
PENDING - Requested action execution pending.
SUCCEEDED - Requested action has been completed successfully.
FAILED - Requested action execution has failed.
changeLog object - A permanent record of asset creation, modification, or deletion.
changeLog
createdDateTime string 2021-07-15T19:30:29.526Z Asset creation timestamp in the IETF ISO 8601 extended date/time format:

YYYY-MM-DDTHH:MM:SS.000+0000
updatedDateTime string 2021-08-15T19:30:29.526Z Asset update timestamp in the IETF ISO 8601 extended date/time format:

YYYY-MM-DDTHH:MM:SS.000+0000

Get Routing Tables Management Requests by Id

GET /fabric/v4/routers/{uuid}/actions/{actionId}?state=PENDING
Method GET
URL or Endpoint /fabric/v4/routers/{uuid}/actions/{actionId}?state=PENDING
Headers Authorization
Path Parameters uuid, actionId
Query Parameters state
Body Parameters Not applicable

Returns routing tables management action requests by Action Id


Sample curl request

Copy 
curl -X
GET 'https://api.equinix.com/fabric/v4/routers/638895bc-4458-4627-9a3d-02c76ab362d7/actions/89hyy5bc-4458-4627-9a3d-02c76ab34ft4?state=PENDING'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'


Path parameters

Parameter Mandatory Type Example Values Description
uuid yes string 638895bc-4458-4627-9a3d-02c76ab362d7 Equinix-assigned Fabric Cloud Router Id.
actionId yes string uyj765bc-4458-4627-9a3d-02c76ab362d7 Equinix-assigned Action Id.


Query parameters

Parameter Mandatory Type Example Values Description
state no string PENDING Action status.
  • PENDING - Requested action pending.
  • SUCCEEDED - Requested action completed .
  • FAILED - Requested action failed.

If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.


Sample response

Copy 
{
  "href": "https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/actions/1e9414f1-763e-4c0a-86c6-0bc8336048d9",
  "uuid": "1e9414f1-763e-4c0a-86c6-0bc8336048d9",
  "type": "RECEIVED_ROUTE_ENTRY_UPDATE",
  "state": "PENDING|SUCCEEDED|FAILED",
  "connection": {
    "uuid": "b1c6b7fd-aead-410a-96b4-b1dfa1071700"
  },
  "operation": {
    "bgpIpv4RoutesCount": 6,
    "bgpIpv6RoutesCount": 6
  },
  "changeLog": {
    "createdDateTime": "2024-01-01T01:00:00.000Z",
    "updatedDateTime": "2024-01-01T01:01:00.000Z"
  }
}


Response payload body description

Parameter Type Example values Description
href string "https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/actions/1e9414f1-763e-4c0a-86c6-0bc8336048d9" A URL of the specified asset.
type string RECEIVED_ROUTE_ENTRY_UPDATE

Possible values:

  • ROUTE_TABLE_ENTRY_UPDATE

  • RECEIVED_ROUTE_ENTRY_UPDATE
  • ADVERTISED_ROUTE_ENTRY_UPDATE
uuid string 3a58dd05-f46d-4b1d-a154-2e85c396ea62 Equinix-assigned action request identifier.
state string PENDING Action execution status.
  • PENDING - Requested action is pending.
  • SUCCEEDED - Requested action has completed successfully.
  • FAILED - Requested action has failed.
connection object - Connection details.
connection.uuid string 3a58dd05-f46d-4b1d-a154-2e85c396ea62 Connection Id.
operation object - Operation details.
operation.bgpIpv4RoutesCount integer 6

Number of Ipv4 BGP routes in use.
Example: 6

operation.bgpIpv6RoutesCount integer 6

Number of Ipv6 BGP routes in use.
Example: 6

changeLog object - A permanent record of asset creation, modification, or deletion.
changeLog.createdDateTime string 2021-07-15T19:30:29.526Z Asset creation timestamp in the IETF ISO 8601 extended date/time format:
Example: YYYY-MM-DDTHH:MM:SS.000+0000
changeLog.updatedDateTime string 2021-08-15T19:30:29.526Z Asset update timestamp in the IETF ISO 8601 extended date/time format:
Example: YYYY-MM-DDTHH:MM:SS.000+0000

Search Routing Tables Management Requests

POST /fabric/v4/routers/{routerId}/actions/search
Method POST
URL or Endpoint /fabric/v4/routers/{routerId}/actions/search
Headers Authorization, Content-Type
Path Parameters routerId
Query Parameters Not applicable
Body Parameters filter, pagination, sort

This API searches routing tables management actions requests.

For instructions on how to obtain an authorization token, refer to Requesting Access and Refresh Tokens.

Sample curl request

Copy 
curl -X POST 'http: //api.equinix.com/fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/actions/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
  "filter": {
    "and": [
      {
        "property": "/type",
        "operator": "IN",
        "values": [
          "ROUTE_TABLE_ENTRY_UPDATE",
          "RECEIVED_ROUTE_ENTRY_UPDATE"
        ]
      },
      {
        "property": "/state",
        "operator": "=",
        "values": [
          "SUCCEEDED"
        ]
      },
      {
        "property": "/connection/uuid",
        "operator": "IN",
        "values": [
          "3066ab1d-af87-49d7-8a14-c9bdb57ac809"
        ]
      }
    ]
  },
  "pagination": {
    "offset": 0,
    "limit": 1
  },
  "sort": [
    {
      "property": "/changeLog/createdDateTime",
      "direction": "DESC"
    }
  ]
}'

Body parameters

Parameter
Description
filter string
REQUIRED
 Array of objects defining search conditions.
and array[object]
REQUIRED
 Logical operator applied on objects in the array.
property string
REQUIRED
 Search field parameter.
Applicable values:
  • /type
  • /state
  • /connection/uuid
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • !=
  • >
  • >=
  • <
  • <=
  • BETWEEN
  • LIKE
  • IN
  • NOT BETWEEN
  • NOT LIKE
  • NOT IN
  • ~*
value array[string]
REQUIRED
 Search field parameter value.
pagination object
OPTIONAL
 Search results pagination settings.
offset integer
OPTIONAL
 Index of the first item returned in the response.
Minimum: 0
Default: 0
limit integer
OPTIONAL
 Maximum number of items returned per data page.
Minimum: 1
Default: 20
sort object
OPTIONAL
 Search results sorting settings.
direction string
OPTIONAL
 Search results sorting direction.
Applicable values:
  • ASC
  • DESC
property string
OPTIONAL
 Search results sorting parameter.
Applicable values:
  • /type
  • /connection/name
  • /changeLog/createdDateTime
  • /changeLog/updatedDateTime

Default value: /changeLog/updatedDateTime
/type Example:
"property": "/type",
"operator": "=",
"values": [
"%test%
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • !=
  • LIKE
  • IN
  • NOT LIKE
  • NOT IN
  • ~*
value array[string]
REQUIRED
 Possible values.
  • ROUTE_TABLE_ENTRY_UPDATE
  • RECEIVED_ROUTE_ENTRY_UPDATE
  • ADVERTISED_ROUTE_ENTRY_UPDATE
/state Example:
"property": "/state",
"operator": "=",
"values": [
"PENDING"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • !=
  • LIKE
  • IN
  • NOT LIKE
  • NOT IN
  • ~*
value array[string]
REQUIRED
 Asset lifecycle status.
Applicable values:
  • SUCCEEDED
  • PENDING
  • FAILED
/connection/uuid Example:
"property": "/connection/uuid",
"operator": "IN",
"values":
["3066ab1d-af87-49d7-8a14-c9bdb57ac809"]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • !=
  • LIKE
  • IN
  • NOT LIKE
  • NOT IN
  • ~*
value array[string]
REQUIRED
 Connection Id.
Example: ["3066ab1d-af87-49d7-8a14-c9bdb57ac809"]

Sample response

Copy 

{
  "pagination": {
    "offset": 0,
    "limit": 1,
    "total": 2,
    "prev": null,
    "next": null
  },
  "data": [
    {
      "href": "https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/actions/1e9414f1-763e-4c0a-86c6-0bc8336048d9",
      "uuid": "1e9414f1-763e-4c0a-86c6-0bc8336048d9",
      "type": "RECEIVED_ROUTE_ENTRY_UPDATE",
      "state": "SUCCEEDED",
      "connection": {
        "uuid": "3066ab1d-af87-49d7-8a14-c9bdb57ac809"
      },
      "operation": {
        "bgpIpv4RoutesCount": 6,
        "bgpIpv6RoutesCount": 6
      },
      "changeLog": {
        "createdDateTime": "2024-01-01T01:00:00.000Z",
        "updatedDateTime": "2024-01-01T01:01:00.000Z"
      }
    }
  ]
}

To see the detailed response descriptions, check the response of Get Routing Tables Management Requests by Id .

Retrieve Fabric Cloud Routers

POST /fabric/v4/routers/search
Method POST
URL or Endpoint /fabric/v4/routers/search
Headers Authorization, Content-Type
Path Parameters Not applicable
Query Parameters Not applicable
Body Parameters filter, pagination, sort

This API request retrieves Fabric Cloud Router instances that match provided search criteria.

For instructions on how to obtain an authorization token, refer to Requesting Access and Refresh Tokens.


Sample curl request

Copy 
curl -X POST 'http: //api.equinix.com/fabric/v4/routers/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "filter": {
        "and": [
            {
                "property": "/name",
                "operator": "LIKE",
                "values": [
                    "%Test%"
                ]
            },
            {
                "property": "/state",
                "operator": "=",
                "values": [
                    "PROVISIONED"
                ]
            },
            {
                "property": "/project/projectId",
                "operator": "=",
                "values": [
                    "995072000433550"
                ]
            },
            {
                "property": "/location/metroCode",
                "operator": "=",
                "values": [
                    "SV"
                ]
            }
        ]
    },
    "pagination": {
        "offset": 0,
        "limit": 20
    },
    "sort": [
        {
            "direction": "DESC",
            "property": "/changeLog/createdDateTime"
        }
    ]
}'

Body parameters

Parameter
Description
filter string
REQUIRED
 Array of objects defining search conditions.
and array[object]
REQUIRED
 Logical operator applied on objects in the array.
property string
REQUIRED
 Search field parameter. Note that the property value determines the list of applicable operators and values.
Applicable values:
  • /name
  • /uuid
  • /state
  • /location/metroCode
  • /location/metroName
  • /package/code
  • /*
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • !=
  • >
  • >=
  • <
  • <=
  • BETWEEN
  • LIKE
  • IN
  • NOT BETWEEN
  • NOT LIKE
  • NOT IN
  • ~*
value array[string]
REQUIRED
 Search field parameter value.
pagination object
OPTIONAL
 Search results pagination settings.
offset integer
OPTIONAL
 Index of the first item returned in the response.
Minimum: 0
Default: 0
limit integer
OPTIONAL
 Maximum number of items returned per data page.
Minimum: 1
Default: 20
sort object
OPTIONAL
 Search results sorting settings.
direction string
OPTIONAL
 Search results sorting direction.
Applicable values:
  • ASC
  • DESC
property string
OPTIONAL
 Search results sorting parameter.
Applicable values:
  • /name
  • /uuid
  • /state
  • /location/metroCode
  • /location/metroName
  • /package/code
  • /changeLog/createdDateTime
  • /changeLog/updatedDateTime

Default value: /changeLog/updatedDateTime
/name Example:
"property": "/name",
"operator": "LIKE",
"values": [
"%test%
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • !=
  • LIKE
  • IN
  • NOT LIKE
  • NOT IN
  • ~*
value array[string]
REQUIRED
 Fabric Cloud Router name.
Example: ["%Test%"]
/uuid Example:
"property": "/uuid",
"operator": "=",
"values": [
"3a58dd05-f46d-4b1d-a154-2e85c396ea62
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
value array[string]
REQUIRED
 Fabric Cloud Router instance identifier.
Example: ["3a58dd05-f46d-4b1d-a154-2e85c396ea62"]
/state Example:
"property": "/state",
"operator": "=",
"values": [
"PROVISIONED"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • !=
  • LIKE
  • IN
  • NOT LIKE
  • NOT IN
  • ~*
value array[string]
REQUIRED
 Asstet lifecycle status.
Applicable values:
  • PROVISIONED
  • PROVISIONING
  • DEPROVISIONING
  • DEPROVISIONED
  • LOCKED
/location/metroCode Example:
"property": "/location/metroCode",
"operator": "=",
"values": [
"SV"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • !=
  • LIKE
  • IN
  • NOT LIKE
  • NOT IN
  • ~*
value array[string]
REQUIRED
 Metropolitan area identifier.
Example: ["SV"]
/location/metroName Example:
"property": "/location/metroName",
"operator": "=",
"values": [
"Silicon Valley"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • !=
  • LIKE
  • IN
  • NOT LIKE
  • NOT IN
  • ~*
value array[string]
REQUIRED
 Metropolitan area name.
Example: ["Silicon Valley"]
/router/package/code Example:
"property": "/router/package/code",
"operator": "IN",
"values": [
"STANDARD",
"LAB"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • !=
  • LIKE
  • IN
  • NOT LIKE
  • NOT IN
  • ~*
value array[string]
REQUIRED
 Fabric Cloud Router package identifier.
Applicable values:
  • LAB
  • STANDARD
/* Example:
"property": "/*",
"operator": "LIKE",
"values": [
"%Silicon%"
]
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • !=
  • LIKE
  • IN
  • NOT LIKE
  • NOT IN
  • ~*
value array[string]
REQUIRED
 All categories search.
Example: ["%Silicon%"]

Sample response

Copy 
{
    "pagination": {
        "offset": 0,
        "limit": 20,
        "total": 1,
        "next": "/search?offset=4&limit=2",
        "previous": "/search?offset=0&limit=2"
    },
    "data": [
        {
            "href": "https://api.equinix.com/fabric/v4/routers/201b7346-a9eb-42fe-ae7a-08148c71928d",
            "uuid": "201b7346-a9eb-42fe-ae7a-08148c71928d",
            "state": "PROVISIONED",
            "type": "XF_ROUTER",
            "name": "My-Fabric-Cloud-Router",
            "location": {
                "metroCode": "HH"
            },
            "package": {
                "code": "LAB"
            },
            "order": {
                "purchaseOrderNumber": "1-129105284100"
            },
            "project": {
                "projectId": "12345"
            },
            "notifications": [
                {
                    "type": "ALL",
                    "emails": [
                        "abc@abc.com"
                    ]
                }
            ],
            "account": {
                "accountNumber": 123
            },
            "bgpIpv4RoutesCount": 0,
            "bgpIpv6RoutesCount": 0,
            "connectionCount": 0,
            "changeLog": {
                "createdBy": "abc@xyz.com",
                "createdByFullName": "abc",
                "createdByEmail": "abc@xyz.com",
                "createdDateTime": "2021-09-24T06:59:46Z"
            }
        }
    ]
}

Response payload body description

Parameter
Description
pagination object
 Search results pagination settings.
offset integer
 Index of the first item returned in the response.
Example: 0
limit integer
 Maximum number of items returned per page.
Example: 20
total integer
 Total number of items returned.
Example: 10
next string
 Next data page URL.
Example: /search?offset=40&limit=20
previous string
 Previous data page URL.
Example: /search?offset=0&limit=20
data array[object]
 Data array containing objects that match the provided search criteria.
href string
 An absolute URL that returns the specified asset.
Example:https://api.equinix.com/fabric/v4/routers/3a58dd05-f46d-4b1d-a154-2e85c396ea62
uuid string
 Equinix-assigned asset identifier.
Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
state string
 Asset lifecycle stage.
  • PENDING - Fabric Cloud Router creation pending.
  • PROVISIONING - Fabric Cloud Router is being provisioned.
  • PROVISIONED - Fabric Cloud Router has been provisioned.
  • LOCKED - Fabric Cloud Router package upgrade has failed. Existing connections associated with this Fabric Cloud Router instance continue to work but you can't make any changes to them or create new ones. For assistance, open a support case with Equinix Service Desk.
  • DEPROVISIONING - Fabric Cloud Router is being deprovisioned.
  • DEPROVISIONED - Fabric Cloud Router has been deprovisioned.
type string
 Asset instance type.
Example: XF_ROUTER - Fabric Cloud Router.
name string
 Fabric Cloud Router instance name.
Example: My-Fabric-Cloud-Router
location object
 Fabric Cloud Router location information.
metroCode string
 Metropolitan area identifier.
Example: SV
package object
 Fabric Cloud Router package determining the number of supported routes and Network Access Control Lists (NACL).
code string
 Fabric Cloud Router package code.
Applicable values:
  • LAB - Max Routes IPv4 = 50; Max Routes IPv6 = 50; 10Mbps max per connection ingress/egress bandwidth limit; Max connections per FCR: 10 (Trial package)
  • STANDARD - Max Routes IPv4 = 1000; Max Routes IPv6 = 100
order object
 Order details.
purchaseOrderNumber string
 Purchase order identifier.
Example: 1-129105284100
project object
 Customer resource hierarchy project information.
Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId string
 Customer project identifier.
Example: 995072000433550
notifications object
 Notification preferences regarding changes in asset configuration or its status.
type string
 Notification preferences for a specified asset.
Applicable values: ALL
emails array[string]
 List of recipients.
Minimum: 1
Maximum: 12
Example: ["test@equinix.com"]
account object
 Customer billing account information.
accountNumber integer
 Equinix-assigned account number.
Example: 272010
bgpIpv4RoutesCount integer
 Number of IPv4 BGP routes in use.
Example: 0
bgpIpv6RoutesCount integer
 Number of IPv6 BGP routes in use.
Example: 0
connectionCount integer
 Number of connections associated with this Fabric Cloud Router instance.
Example: 0
changeLog object
 A permanent record of asset creation, modification, or deletion.
createdBy string
 Identity of the asset creator.
Example: AverageJoe
createdByFullName string
 First and last name of the asset creator.
Example: Joe Average
createdByEmail string
 Email address of the asset creator.
Example:joe@average.org
createdDateTime string
 Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z

If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

Delete Fabric Cloud Router

DELETE /fabric/v4/routers/{uuid}
Method DELETE
URL or Endpoint /fabric/v4/routers/{uuid}
Headers Authorization, Content-Type
Path Parameters uuid
Query Parameters Not applicable
Body Parameters Not applicable

This API request deletes a specified Fabric Cloud Router instance.


Sample curl request

Copy 
curl -X
DELETE 'https://api.equinix.com/fabric/v4/routers/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter
Description
uuid string
REQUIRED		 Equinix-assigned Fabric Cloud Router identifier.
Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric portal access.

Get All Fabric Cloud Router Packages

GET /fabric/v4/routerPackages
Method GET
URL or Endpoint /fabric/v4/routerPackages
Headers Authorization, Content-Type
Path Parameters Not applicable
Query Parameters offset, limit
Body Parameters Not applicable

This API request retrieves Fabric Cloud Router packages' details.


Sample curl request

Copy 
curl -X
GET 'https://api.equinix.com/fabric/v4/routerPackages'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Query parameters

Parameter
Description
offset integer
OPTIONAL		 Index of the first item returned in the response.
Minimum: 0
Default value: 0
limit integer
OPTIONAL		 Maximum number of items returned per page.
Minimum: 1
Maximum: 100
Default value: 20

If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.


Sample response

Copy 
{
    "pagination": {
        "offset": 0,
        "limit": 20,
        "total": 1
    },
    "data": [
        {
            "href": "https://api.equinix.com/fabric/v4/routerPackages/STANDARD",
            "type": "ROUTER_PACKAGE",
            "code": "STANDARD",
            "description": "string",
            "totalIPv4RoutesMax": 5,
            "totalIPv6RoutesMax": 5,
            "staticIPv4RoutesMax": 3,
            "staticIPv6RoutesMax": 3,
            "naclsMax": 2,
            "naclRulesMax": 5,
            "haSupported": true,
            "routeFilterSupported": true,
            "natType": "STATIC_NAT",
            "maxConnLimit": 10,
            "maxGwLimit": 3,
            "maxBwLimit": 50,
            "changeLog": {
                "createdDateTime": "2022-02-10T00:14:47Z",
                "updatedDateTime": "2022-02-10T00:14:47Z"
            }
        }
    ]
}

Response payload body description

Parameter
Description
pagination object Data set pagination information.
offset integer
 Index of the first item returned in the response.
Example: 0
limit integer
 Maximum number of items returned per page.
Example: 20
total integer
 Total number of items returned.
Example: 123
data array[object] Data set containing Fabric Cloud Router packages.
href string
 An absolute URL that returns the specified asset.
Example:https://api.equinix.com/fabric/v4/routerPackages/STANDARD
type string
 Fabric Cloud Router package type.
Example: ROUTER_PACKAGE
code string
 Fabric Cloud Router package identifier.
Example: STANDARD
description string
 Fabric Cloud Router package description.
totalIPv4RoutesMax integer
 Maximum number of IPv4 BPG routes allowed.
Example: 5
totalIPv6RoutesMax integer
 Maximum number of IPv6 BGP routes allowed.
Example: 10
staticIPv4RoutesMax integer
 Maximum number of IPv4 static routes allowed.
Example: 3
staticIPv6RoutesMax integer
 Maximum number of IPv6 static routes allowed.
Example: 3
naclMax integer
 Maximum number of network access control Lists (NACL) allowed.
Example: 2
naclRuleMax integer
 Maximum number of network ACL rules allowed.
Example: 10
haSupported boolean
 Indicator showing if high availability configuration is supported.
Example: true
routeFilterSupported boolean
 Indicator showing if route filtering feature is supported.
Example: true
natType string
 Cloud Router package network address translation (NAT) type.
Possible values:
  • STATIC_NAT - Static network address translation.
maxConnLimit integer
 Maximum number of connections that can be created using this cloud router.
Example: 10
maxGwLimit integer
 Fabric Cloud Router limit per customer org. Only applicable for LAB package tier of Fabric Cloud Router.
Example: 3
maxBwLimit integer
 Maximum allowed bandwidth.
Example: 50 Mbps
changeLog object
 A permanent record of asset creation, modification, or deletion.
createdDateTime string
 Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
updatedDateTime string
 Asset modification timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15611:12:29.526Z

Get Specified Fabric Cloud Router Package

GET /fabric/v4/routerPackages/{routerPackageCode}
Method GET
URL or Endpoint /fabric/v4/routerPackages/{routerPackageCode}
Headers Authorization, Content-Type
Path Parameters routerPackageCode
Query Parameters Not applicable
Body Parameters Not applicable

This API request retrieves details of a specified Fabric Cloud Router package.


Sample curl request

Copy 
curl -X
GET 'https://api.equinix.com/fabric/v4/routerPackages/STANDARD'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter
Description
routerPackageCode string
REQUIRED		 Fabric Cloud Router package identifier.
Applicable values:
  • LAB
  • STANDARD

If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.


Sample response

Copy 
{
    "href": "https://api.equinix.com/fabric/v4/routerPackages/STANDARD",
    "type": "ROUTER_PACKAGE",
    "code": "STANDARD",
    "description": "string",
    "totalIPv4RoutesMax": 5,
    "totalIPv6RoutesMax": 5,
    "staticIPv4RoutesMax": 3,
    "staticIPv6RoutesMax": 3,
    "aclMax": 2,
    "aclRuleMax": 10,
    "haSupported": true,
    "routeFilterSupported": true,
    "natType": "STATIC_NAT",
    "maxConnLimit": 10,
    "maxGwLimit": 3,
    "maxBwLimit": 50,
    "changeLog": {
        "createdDateTime": "2022-01-24T10:28:51.024Z",
        "updatedDateTime": "2022-01-24T10:28:51.024Z"
    }
}

Response payload body description

Parameter
Description
href string
 An absolute URL that returns the specified asset.
Example:https://api.equinix.com/fabric/v4/routerPackages/STANDARD
type string
 Fabric Cloud Router package type.
Example: ROUTER_PACKAGE
code string
 Fabric Cloud Router package identifier.
Example: STANDARD
description string
 Fabric Cloud Router package description.
totalIPv4RoutesMax integer
 Maximum number of IPv4 BPG routes allowed.
Example: 5
totalIPv6RoutesMax integer
 Maximum number of IPv6 BGP routes allowed.
Example: 10
staticIPv4RoutesMax integer
 Maximum number of IPv4 static routes allowed.
Example: 3
staticIPv6RoutesMax integer
 Maximum number of IPv6 static routes allowed.
Example: 3
naclMax integer
 Maximum number of network access control Lists (NACL) allowed.
Example: 2
naclRuleMax integer
 Maximum number of network ACL rules allowed.
Example: 10
haSupported boolean
 Indicator showing if high availability configuration is supported.
Example: true
routeFilterSupported boolean
 Indicator showing if route filtering feature is supported.
Example: true
natType string
 Cloud Router package network address translation (NAT) type.
Possible values:
  • STATIC_NAT - Static network address translation.
maxConnLimit integer
 Maximum number of connections that can be created using this cloud router.
Example: 10
maxGwLimit integer
 Fabric Cloud Router limit per customer org. Only applicable for LAB package tier of Fabric Cloud Router.
Example: 3
maxBwLimit integer
 Maximum allowed bandwidth.
Example: 50 Mbps
changeLog object
 A permanent record of asset creation, modification, or deletion.
createdDateTime string
 Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
updatedDateTime string
 Asset modification timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15611:12:29.526Z