Skip to main content

Effective 10 September 2024, API Documentation can be found on our Equinix Product Documentation site.
The content on this page will not be updated after 1 Oct 2024 and will be inaccessible after 31st Dec 2024.


Orders

Create Order

 POST /securecabinet/v1/orders
MethodPOST
Endpoint/securecabinet/v1/orders
HeadersAuthorization, Content-Type
Path ParametersNot applicable
Query ParametersNot applicable
Body ParametersaccountNumber, customerReferenceNumber, endCustomerOrderInfoName, ibxCode, initialTerm, orderItem, purchaseOrderNumber, technicalContact

This API request creates an order for a Secure Cabinet.


Sample curl request

curl -X POST 'https://api.equinix.com/securecabinet/v1/orders'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
"accountNumber": "132028",
"customerReference": "My Reference",
"endCustomerName": "Michael Scott Paper Co.",
"ibxCode": "SV10",
"contractTerm": "TERM_24_MONTHS",
"orderItem": {
"drawCapacity": 5,
"fabricPort": true,
"numberOfCabinets": 1,
"pdus": true
},
"purchaseOrderNumber": "8-132028",
"technicalContact": {
"firstName": "John",
"lastName": "Smith",
"email": "john@smith.com",
"phone": {
"number": "4915126449706",
"availability": "WORK_HOURS"
}
}
}'

Body parameters

Parameter
Description
accountNumber string
REQUIRED
Billing account number.
Example: 1234
customerReference string
OPTIONAL
Supplementary identifier for your discretionary use. For example, your end customer identifier.
Example: 555
endCustomerName string
OPTIONAL
End customer name. Applicable and required if a reseller billing account is used.
Example: Michael Scott Paper Company
ibxCode string
REQUIRED
IBX data center identifier.
Example: SV10
contractTerm string
REQUIRED
Contracted term length.
Applicable values:
  • TERM_24_MONTHS
  • TERM_36_MONTHS
  • TERM_48_MONTHS
  • TERM_60_MONTHS
orderItem object
REQUIRED
Order details.
drawCapacity number
REQUIRED
Maximum total power draw measured in kVA.
Example: 5

Use the Get Availability API request to determine the available minimum and maximum draw capacity values. Use a value in that range, in 0.5 increments.

fabricPort boolean
REQUIRED
Indicates if a Fabric port should be included in the order.
Example: true
numberOfCabinets integer
REQUIRED
The number of cabinets ordered.
Example: 1
pdus boolean
REQUIRED
Indicates if a standard set of two PDUs per cabinet should be included in the order.
Example: true
purchaseOrderNumber string
OPTIONAL
Purchase order number.
Example: 8-132028
technicalContact object
OPTIONAL
Contact person details for technical inquiries.
firstName string
REQUIRED
First name.
Example: Ryan
lastName string
REQUIRED
Last name.
Example: Howard
email string
REQUIRED
Email address.
Example: ryan.howard@michaelscottpaper.co
phone object
OPTIONAL
Primary phone number details.
number string
REQUIRED
A phone number in full international format.
Example: +1 717 555 0177
availability string
REQUIRED
When is the best time to call.
Applicable values:
  • ANYTIME
  • CUSTOMER_BUSINESS_HOURS
  • NOT_AVAILABLE
  • WORK_HOURS

Sample response

{
"orderNumber": "1-126546546546"
}

Response payload body description

Parameter
Description
orderNumber object
Secure Cabinet order number.