Equinix Fabric API v4 | Equinix Product Documentation

Create Router

Request

This API provides capability to create user's Cloud Router

Security

BearerAuth

Query

dryRunboolean

option to verify that API calls will succeed

Default:false

Bodyapplication/jsonrequired

typestringrequired

Value:"XF_ROUTER"

namestringrequired

Customer-provided Cloud Router name

locationobject(SimplifiedLocationWithoutIBX)required

packageobject(CloudRouterPostRequestPackage)required

Fabric Cloud Router Package Type

orderobject(Order)

projectobject(Project)

accountobject(SimplifiedAccount)

notificationsArray of objects(SimplifiedNotification)required

Preferences for notifications on connection configuration or status changes

marketplaceSubscriptionobject(marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

Payload

{
  "type": "XF_ROUTER",
  "name": "My-Cloud-Router",
  "location": {
    "metroCode": "SV"
  },
  "package": {
    "code": "LAB"
  },
  "notifications": [
    { … }
  ],
  "account": {
    "accountNumber": 272010
  },
  "project": {
    "projectId": "995072000433550"
  }
}

Responses

Fabric Cloud Router object

Bodyapplication/json

typestring

Value:"XF_ROUTER"

namestring, (string)

Customer-provided Cloud Router name

Example:"test-fg-1"

locationobject(SimplifiedLocationWithoutIBX)

packageobject(CloudRouterPostRequestPackage)

Fabric Cloud Router Package Type

orderobject(Order)

projectobject(Project)

accountobject(SimplifiedAccount)

notificationsArray of objects(SimplifiedNotification)

Preferences for notifications on connection configuration or status changes

marketplaceSubscriptionobject(marketplaceSubscription)

Equinix Fabric Entity for Marketplace Subscription

hrefstring, (uri)read-only

Cloud Routers URI

Example:"https://api.equinix.com/fabric/v4/routers/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170"

uuidstring, (uuid)

Equinix-assigned access point identifier

Example:"c9b8e7a2-f3b1-4576-a4a9-1366a63df170"

statestring(CloudRouterAccessPointState)

Access point lifecycle state

Enum:"PROVISIONED""PROVISIONING""DEPROVISIONING""DEPROVISIONED""REPROVISIONING""NOT_PROVISIONED""NOT_DEPROVISIONED"

Example:"PROVISIONED"

equinixAsninteger, (int64)

Equinix ASN

Example:30000

connectionsCountinteger, >= 0

Number of connections associated with this Access point

changeLogobject(Changelog)

Change log

changeobject(CloudRouterChange)

Current state of latest CloudRouter change

Response

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