Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Equinix

Equinix Smarthands API

The Smarthands API from Equinix — 14 operation(s) for smarthands.

Documentation Provider Profile APIs.io OpenAPI GitHub

Equinix Smarthands API is one of 74 APIs that Equinix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Smarthands. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 14 operations across 14 paths, and defines 32 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.

14 operations 14 paths 32 schemas 2 GET12 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.2
Base URL
https://api.equinix.com
Contact
Equinix API Support
Terms of Service
View terms
Resource Areas
1

Paths & Operations 14

Across 14 paths, the API surfaces 14 operations — 2 GET, 12 POST. Each is listed below with its method, path, parameters, and response codes.

Smarthands 14
POST
/v1/orders/smarthands/equipmentInstall
Request equipment installation per your specifications by an IBX Technician
handleSmartHandOrder 2 params → 201400403500
POST
/v1/orders/smarthands/shipmentUnpack
Request inbound shipment unpacking and packaging disposal.
handleSmartHandShipmentUnpackOrder 2 params → 201400403500
POST
/v1/orders/smarthands/moveJumperCable
This API is used to request a patch cable to be moved between devices.
handleSmartHandMoveJumperCableOrder 2 params → 201400403500
POST
/v1/orders/smarthands/cageEscort
Request a patch cable to be moved between devices
handleSmartHandCageEscortOrder 2 params → 201400403500
POST
/v1/orders/smarthands/locatePackage
Get the location of your package(s) at an IBX.
handleSmartHandLocatePackageOrder 2 params → 201400403500
POST
/v1/orders/smarthands/picturesDocument
Request an IBX Technician to provide cage-related pictures or documentation.
handleSmartHandPicturesDocumentOrder 2 params → 201400403500
POST
/v1/orders/smarthands/patchCableInstall
Request installation of a cross connect patch cable by an IBX Technician.
handleSmartHandPatchCableInstallOrder 2 params → 201400403500
POST
/v1/orders/smarthands/patchCableRemoval
Request removal of a cross connect cable by an IBX Technician.
handleSmartHandPatchCableRemovalOrder 2 params → 201400403500
POST
/v1/orders/smarthands/cageCleanup
Request trash removal or cage cleanup
handleSmartHandCageCleanupOrder 2 params → 201400403500
POST
/v1/orders/smarthands/cableRequest
This API is used to request cables per your specifications for your equipment.
handleSmartHandCableRequestOrder 2 params → 201400403500
POST
/v1/orders/smarthands/runJumperCable
This API is used to request a jumper cable to be ran between devices.
handleSmartHandRunJumperCableOrder 2 params → 201400403500
POST
/v1/orders/smarthands/other
Request a Smart Hands order not listed in catalogue
handleSmartHandOthersOrder 2 params → 201400403500
GET
/v1/orders/smarthands/locations
Get locations(ibx, cage) details for placing smart hands based on smart hands permission for user
getLocation 4 params → 200400403500
GET
/v1/orders/smarthands/types
All supported smart hands types API.
smartHandTypes 1 param → 200400403500

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are contactInfo (12 properties), cableRequestRequest (7 properties), shipmentUnpackRequest (7 properties), locatePackageRequest (7 properties). Each schema is shown below with its type and property counts.

picturesDocumentRequest
object
7 properties 4 required
equipmentInstallRequest
object
7 properties 4 required
cross-connect-install
object
7 properties 5 required
device
object
3 properties 3 required
order-contacts
array
Use this array to pass ordering contact, notification contacts and technical contact. Only one ordering contact, technical contact is allowed. One or more noti…
contactInfo
object
Use this model to build contact object. Ordering and notification contacts are are always equinix registered contacts and we only expect username and rest of t…
12 properties 1 required
shipmentUnpackRequest
object
7 properties 4 required
purchaseOrder
object
Use this model to pass purchase order reference information. When purchase order selection type is EXEMTED, number is not required
2 properties 1 required
ibxLocation
object
IBX, Cage, Accounts and Cabinet information
2 properties 2 required
moveJumperCableRequest
object
7 properties 4 required
account
object
5 properties 2 required
smarthandType
object
2 properties 2 required
patchCableInstallRequest
object
7 properties 4 required
cageEscortRequest
object
7 properties 4 required
location
object
2 properties 2 required
cageCleanupRequest
object
7 properties 3 required
customerReferenceNumber
string
You may use numbers and text in this field to enter reference information for your records. This will also appear in your reports and details. You may use this…
needSupportFromASubmarineCableStationEngineer
boolean
This flag is only applicable to Submarine Cable IBXs
otherRequest
object
7 properties 4 required
scheduleInfo
object
Use this model to pass the scheduling option that best meets your needs. Please remember that additional approvals or fees may be required for expedited reques…
3 properties 1 required
attachmentArray
array
Use this to pass uploaded attachments. Attachments need to be uploaded using the attachments API. Maximum size of an attachment is 2MB with the following forma…
cabinets
object
2 properties
scopeOfWork
string
Enter any additional details that will help our technicians execute your request. You may also attach your scope of work as a document if you exceed the charac…
runJumperCableRequest
object
7 properties 4 required
attachment
object
2 properties 2 required
patchCableRemovalRequest
object
7 properties 4 required
locatePackageRequest
object
7 properties 4 required
cross-connect-removal
object
7 properties 5 required
genericError
object
2 properties
cage
object
3 properties 1 required
cableRequestRequest
object
7 properties 4 required
smarthandResponse
object
Order has been submitted successfully
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

equinix-smarthands-api-openapi.yml Raw ↑

Other APIs Equinix publishes across the network.

Equinix Agent Templates API
AE Profile APIs.io
Equinix Agents API
AE Profile APIs.io
Equinix Authentication API
AE Profile APIs.io
Equinix availability API
AE Profile APIs.io
Equinix Batches API
AE Profile APIs.io
Equinix BGP API
AE Profile APIs.io
Equinix Capacity API
AE Profile APIs.io
Equinix Cloud Events API
AE Profile APIs.io
Equinix Cloud Routers API
AE Profile APIs.io
Equinix Company Profiles API
AE Profile APIs.io
Equinix Connections API
AE Profile APIs.io
Equinix Console Log Details API
AE Profile APIs.io
#Smarthands
← Back to E APIs
API Details
ID
equinix:equinix-smarthands-api
Base URL
https://api.equinix.com
Docs
https://developer.equinix.com/catalog/fabricv4
Provider
Equinix
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network