Equinix Cloud Routers API
Cloud Routers
Equinix Cloud Routers API is one of 74 APIs that Equinix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Cloud Routers. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 19 operations across 14 paths, and defines 107 schemas. It is described by OpenAPI 3.0.1, at version 1.2.
Requests are made against a single base URL, https://api.equinix.com.
19 operations
14 paths
107 schemas
2 DELETE7 GET1 PATCH9 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 19
Across 14 paths, the API surfaces 19 operations — 2 DELETE, 7 GET, 1 PATCH, 9 POST. Each is listed below with its method, path, parameters, and response codes.
Cloud Routers 19
Cloud Routers
POST
/fabric/v4/connections/{connectionId}/advertisedRoutes/search
Search Advertised Routes
POST
/fabric/v4/connections/{connectionId}/receivedRoutes/search
Search Received Routes
POST
/fabric/v4/routers
Create Routers
GET
/fabric/v4/routers/{routerId}
Get Routers
DELETE
/fabric/v4/routers/{routerId}
Delete Routers
PATCH
/fabric/v4/routers/{routerId}
Update Routers
GET
/fabric/v4/routers/{routerId}/actions
Get Route Table Actions
POST
/fabric/v4/routers/{routerId}/actions
Create Route Table Action
POST
/fabric/v4/routers/{routerId}/actions/search
Search Route Table Actions
GET
/fabric/v4/routers/{routerId}/actions/{actionId}
Get Route Table Action by ID
GET
/fabric/v4/routers/{routerId}/commands
Get Commands
POST
/fabric/v4/routers/{routerId}/commands
Initiate Command
POST
/fabric/v4/routers/{routerId}/commands/search
Search Commands
GET
/fabric/v4/routers/{routerId}/commands/{commandId}
Get Command
DELETE
/fabric/v4/routers/{routerId}/commands/{commandId}
Delete Command
POST
/fabric/v4/routers/{routerId}/routes/search
Search Route Table
POST
/fabric/v4/routers/search
Search Routers
GET
/fabric/v4/routerPackages
List Packages
GET
/fabric/v4/routerPackages/{routerPackageCode}
Get Package Details
Schemas 107
The contract defines 107 schemas that model the data the API accepts and returns. The most detailed are SimplifiedAccount (12 properties), Changelog (12 properties), CloudRouterPackage (11 properties), OutputStructuredPing (11 properties). Each schema is shown below with its type and property counts.
RouteTableEntryOrFilter
object
1 property
CloudRouterCommandSearchSortCriteria
object
2 properties
ConnectionRouteEntryFilter
object
RouteTableEntrySimpleExpression
object
3 properties
Hop_probes
object
5 properties
RouterPackageCode
string
Router package code
CloudRouterSimpleExpression
object
3 properties
PackageChangeLog
object
Cloud Router package change log
2 properties
RouteTableEntryState
string
Route table entry state
code
string
Cloud Router package code
RouteTableEntryType
string
Route table entry type
CloudRouterCommandSearchFilter
object
CloudRouterCommandSearchSortBy
string
Possible field names to use on sorting
CloudRouterPostRequestPackage
object
Fabric Cloud Router Package Type
3 properties
1 required
ConnectionRouteSortCriteria
object
2 properties
RouteTableEntrySearchRequest
object
Search requests containing criteria
3 properties
CloudRouterSortBy
string
Possible field names to use on sorting
OutputStructuredPing
object
11 properties
CloudRouterActionState
string
Cloud router action state
CloudRouterCommandRequestPayload
object
Fabric Cloud Router Command Request
6 properties
2 required
CloudRouterCommandPingResponse
object
3 properties
CloudRouterCommandType
string
Fabric Cloud Router Command Type
CloudRouterCommandState
string
Fabric Cloud Router Command State
CloudRouterCommandPostRequest
object
Execute Cloud Router Command Request
5 properties
3 required
CloudRouterCommandRequestConnection
object
Connection object for Cloud Router Command
1 property
1 required
RouteTableEntry_connection
object
3 properties
RouteTableEntrySortBy
string
Possible field names to use on sorting
Hop
object
2 properties
PaginationRequest
object
Pagination request information
2 properties
CloudRouterFilter
object
CloudRouterCommandTracerouteResponse
object
3 properties
CloudRouterCommandResponse
object
Operation
object
Operation object for router actions
4 properties
CloudRouterUpdateRequest
array
Fabric Cloud Router Update Request
Changelog
object
Change log
12 properties
marketplaceSubscription
object
Equinix Fabric Entity for Marketplace Subscription
3 properties
CloudRouterCommandSearchFilters
object
1 property
CloudRouterActionsSearchSortBy
string
Possible field names to use on sorting
ConnectionRouteEntrySimpleExpression
object
3 properties
RouterActionsConnection
object
Connection object for router actions
4 properties
RouteTableEntrySearchResponse
object
2 properties
CloudRouterActionResponse
object
Cloud router actions response object
8 properties
4 required
CloudRouterCommandSearchResponse
object
2 properties
CloudRouterActionsSearchFilter
object
CloudRouter
object
Fabric Cloud Router object
9 properties
RouteTableEntrySortCriteria
object
2 properties
RouterActionsRouter
object
Router object for router actions
4 properties
SimplifiedNotification
object
4 properties
2 required
CloudRouterOrFilter
object
1 property
ConnectionRouteEntryFilters
object
1 property
GetAllCloudRouterCommands
object
List of Fabric Cloud Router Command
2 properties
CloudRouterActionRequest
object
Cloud router action request
2 properties
1 required
RouteTableEntryFilter
object
Pagination
object
Pagination response information
5 properties
2 required
CommandId
string
Command UUID
ConnectionRouteTableEntrySearchResponse
object
2 properties
PackageResponse
object
2 properties
ActionState
CloudRouterChangeOperation
object
Fabric Cloud Router change operation data
3 properties
3 required
ConnectionId
string
Connection UUID
CloudRouterSortCriteria
object
2 properties
RouteTableEntry
object
Route table entry object
10 properties
3 required
CloudRouterSortDirection
string
Sorting direction
ActionId_1
string
Action UUID
CloudRouterFilters
object
1 property
CloudRouterChange
object
Current state of latest CloudRouter change
7 properties
2 required
CloudRouterCommandSearchOrFilter
object
1 property
ConnectionRouteSearchRequest
object
Search requests containing criteria
3 properties
RouteTableEntryFilters
object
1 property
CloudRouterActionsSearchRequest
object
Search requests containing criteria
3 properties
OutputStructuredPingResponseItem
object
5 properties
CloudRouterActionsSearchOrFilter
object
1 property
ConnectionType
string
Connection type
RouterId
string
Cloud Router UUID
CloudRouterCommandSearchSortDirection
string
Sorting direction
RouterId_1
string
Router UUID
PriceError_additionalInfo
object
2 properties
CloudRouterActionsSearchSortCriteria
object
2 properties
RouteTableEntryProtocolType
string
Route table entry protocol type
CloudRouterCommandSearchRequest
object
Search requests containing criteria
3 properties
CloudRouterActionsSearchFilters
object
1 property
CloudRouterActionType
string
Cloud router action type
SearchResponse
object
2 properties
ErrorList
array
List of Error Message
CloudRouterCommandSearchExpression
object
3 properties
CloudRouterAccessPointState
string
Access point lifecycle state
ConnectionRouteEntrySortBy
string
Possible field names to use on sorting
CloudRouterSearchRequest
object
Search requests containing criteria
3 properties
CloudRouterCommand
object
Get Fabric Cloud Router Command response object
10 properties
CloudRouterActionsSearchExpression
object
3 properties
Order
object
7 properties
RouteTableEntrySortDirection
string
Sorting direction
SimplifiedAccount
object
12 properties
OutputStructuredTraceroute
object
5 properties
ConnectionRouteEntrySortDirection
string
Sorting direction
Project
object
1 property
1 required
SimplifiedLocationWithoutIBX
object
4 properties
1 required
ConnectionRouteEntryOrFilter
object
1 property
CloudRouterPostRequestBase
object
Create Cloud Router
9 properties
CloudRouterActionsSearchResponse
object
2 properties
CloudRouterActionsSearchSortDirection
string
Sorting direction
Error
object
Error Response with details
6 properties
2 required
CloudRouterPackage
object
Fabric Cloud Router Package
11 properties
ConnectionRouteTableEntry
object
Advertised and received route table entry object
10 properties
2 required
CloudRouterPostRequest
5 required
CloudRouterCommandRequestResponse
object
Fabric Cloud Router Command Request
8 properties
ConnectionRouteTableEntry_connection
object
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Equinix 12
Other APIs Equinix publishes across the network.
Equinix Agent Templates API
Equinix Agents API
Equinix Authentication API
Equinix availability API
Equinix Batches API
Equinix BGP API
Equinix Capacity API
Equinix Cloud Events API
Equinix Company Profiles API
Equinix Connections API
Equinix Console Log Details API
Equinix Devices API
#Cloud Routers