Skip to main content

Fabric Cloud Router Packages

Prerequisites

Authenticate - Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication. Refer to API Authentication for instructions on how to call the OAuth API to validate and authenticate your credentials.

Get All Fabric Cloud Router Packages

To list all Fabric Cloud Router packages, send a GET request to the /fabric/v4/routerPackages endpoint. Use the optional query parameters to control pagination.

GET /fabric/v4/routerPackages
MethodGET
URL or Endpoint/fabric/v4/routerPackages
HeadersAuthorization, Content-Type
Path ParametersNot applicable
Query Parametersoffset, limit
Body ParametersNot applicable

Sample curl request:

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

Query parameters:

  • offset (optional) integer - Index of the first item returned in the response. Defaults to 0.
  • limit (optional) integer - Maximum number of items returned per page. Defaults to 20.

Sample response:

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

Get Specified Fabric Cloud Router Package

To get the details of a Fabric Cloud Router package, send a GET request to the /fabric/v4/routerPackages/{routerPackageCode} endpoint.

GET /fabric/v4/routerPackages/{routerPackageCode}
MethodGET
URL or Endpoint/fabric/v4/routerPackages/{routerPackageCode}
HeadersAuthorization, Content-Type
Path ParametersrouterPackageCode
Query ParametersNot applicable
Body ParametersNot applicable

Sample curl request:

curl -X  
GET 'https://api.equinix.com/fabric/v4/routerPackages/{routerPackageCode}'
-H 'content-type: application/json'
-H 'authorization: Bearer <token>'

Path parameter:

  • routerPackageCode (required) string - Fabric Cloud Router package identifier. Applicable values: LAB, STANDARD.

Sample response:

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