Skip to main content
API docs by Redocly

Secure Cabinet API (1.0.0)

Download OpenAPI specification:Download

URL: https://docs.equinix.com/api-support.htm Terms of Service

Secure Cabinet API

orders

Order Secure Cabinets

Order a new Secure Cabinet deployment

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

Authorizations:
BearerAuth
Request Body schema: application/json
required
accountNumber
required
string (AccountNumber) non-empty

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

customerReference
string <= 100 characters

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

endCustomerName
string

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

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

IBX data center identifier.

contractTerm
required
string (ContractTerm)
Enum: "TERM_24_MONTHS" "TERM_36_MONTHS" "TERM_48_MONTHS" "TERM_60_MONTHS"

Contract term length.

required
object (OrderItem)

Order details.

drawCapacity
required
number <double> (Rating)

Maximum, combined power draw of all cabinets in your order, measured in kVA. Applicable values, in 0.5 increments, depend on the IBX data center.

fabricPort
required
boolean

Indicates if a single, primary Fabric port should be included and delivered to one of the ordered cabinets.

numberOfCabinets
required
integer [ 1 .. 2147483647 ]

The number of ordered cabinets.

required
object (Dimensions)
required
object (Dimension)
required
object (Dimension)
required
object (Dimension)
pdus
required
boolean

Indicates if an Equinix-recommended set of two PDUs, for single-phase circuit, per cabinet should be installed.

purchaseOrderNumber
string (PurchaseOrderNumber) non-empty

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

object (ContactDetails)

Contact person details for technical inquiries.

firstName
required
string <= 50 characters

First name.

lastName
required
string <= 50 characters

Last name.

email
required
string <= 100 characters

Email address.

object (Phone)

Phone number details.

number
required
string <= 40 characters

A phone number in full international format.

availability
required
string (ContactAvailability)
Enum: "WORK_HOURS" "ANYTIME" "CUSTOMER_BUSINESS_HOURS" "NOT_AVAILABLE"

When is the best time to call.

Responses

Request samples

Content type
application/json
{
  • "accountNumber": "132028",
  • "customerReference": "My Reference",
  • "endCustomerName": "Michael Scott",
  • "ibxCode": "CH1",
  • "contractTerm": "TERM_24_MONTHS",
  • "orderItem": {
    },
  • "purchaseOrderNumber": "8-132028",
  • "technicalContact": {
    }
}

Response samples

Content type
application/json
{
  • "orderNumber": "1-126546546546"
}

availability

Secure Cabinet availability

Secure Cabinet availability.

Returns the availability of Secure Cabinets and recommended additional products for provided billing account.

Authorizations:
BearerAuth
path Parameters
accountNumber
required
string (AccountNumber) non-empty
Example: 132028

Billing Account Number.

Responses

Response Schema: application/json
Array
ibx
required
string (IbxCode) ^[A-Z]{2}[0-9]+x?$

IBX data center identifier.

maximumNumberOfCabinetsToOrder
required
integer

Maximum number of cabinets that can be ordered in one order in this ibx.

minimumDrawCapacityPerCabinet
required
number <double>

The minimum power draw capacity per ordered cabinet.

maximumDrawCapacityPerCabinet
required
number <double>

The maximum power draw capacity per ordered cabinet.

required
object (Dimensions)
required
object (Dimension)
required
object (Dimension)
required
object (Dimension)
required
object (AcCircuitConfig)
voltage
required
integer (Voltage)

Voltage numerical value

soldAmperage
required
number <double> (Amperage)

Amperage Numerical Value

phase
required
string (Phase)
Value: "SINGLE"

Circuit phase

receptacle
required
string

Receptacle type

object (PduConfig)
model
required
string

Model Code

fabricPortSpeed
string (FabricPortSpeed)
Enum: "SPEED_1_GBPS" "SPEED_10_GBPS"

Port speed

Response samples

Content type
application/json
[
  • {
    }
]