Secure Cabinet API | Equinix Product Documentation

Order a new Secure Cabinet deployment

Request

Order a new Secure Cabinet deployment and recommended additional products at IBX data centers worldwide.

Security

BearerAuth

Idempotency-Keystring, [ 1 .. 255 ] characters(IdempotencyKey)

Optional, caller-provided unique token that makes order creation idempotent. When supplied, retrying the same request with the same key returns the original order result instead of creating a duplicate order. Reusing the same key with a materially different request payload results in a 409 Conflict response.

Example:550e8400-e29b-41d4-a716-446655440000

Bodyapplication/jsonrequired

accountNumberstring, non-empty(AccountNumber)required

Identifier of a billing account, with permission to order colocation products.

Example:"132028"

customerReferencestring, <= 100 characters

Supplementary identifier for your discretionary use. For example, your internal identifier.

Example:"My Reference"

endCustomerNamestring

End customer name. Applicable and required if a reseller billing account is used.

Example:"Michael Scott"

ibxCodestring(IbxCode)^[A-Z]{2}[0-9]+x?$required

IBX data center identifier.

Example:"CH1"

contractTermstring(ContractTerm)required

Contract term length.

Enum:"TERM_24_MONTHS""TERM_36_MONTHS""TERM_48_MONTHS""TERM_60_MONTHS"

Example:"TERM_24_MONTHS"

orderItemobject(OrderItem)required

Order details.

purchaseOrderNumberstring, non-empty(PurchaseOrderNumber)

Purchase order number. Optional, unless the billing account requires it.

Example:"8-132028"

technicalContactobject(ContactDetails)

Contact person details for technical inquiries.

Payload

{
  "accountNumber": "132028",
  "customerReference": "My Reference",
  "endCustomerName": "Michael Scott",
  "ibxCode": "CH1",
  "contractTerm": "TERM_24_MONTHS",
  "orderItem": {
    "drawCapacity": 5,
    "fabricPort": true,
    "numberOfCabinets": 1,
    "cabinetDimensions": { … },
    "pdus": true
  },
  "purchaseOrderNumber": "8-132028",
  "technicalContact": {
    "firstName": "John",
    "lastName": "Smith",
    "email": "john@smith.com",
    "phone": { … }
  }
}

Responses

Generated Order Number

Bodyapplication/json

orderNumberstring, non-empty(OrderNumber)required

Order Number

Example:"1-126546546546"

Response

{
  "orderNumber": "1-126546546546"
}

orders

Order a new Secure Cabinet deployment

Request

Headers

Responses