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

Equinix SSHKeys API

Manage SSH keys. See project endpoints to list and create project-level SSH keys.

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

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

This API exposes 8 operations across 4 paths, and defines 6 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.

8 operations 4 paths 6 schemas 1 DELETE4 GET2 POST1 PUT

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
Terms of Service
Resource Areas
1

Paths & Operations 8

Across 4 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

SSHKeys 8

Manage SSH keys. See project endpoints to list and create project-level SSH keys.

GET
/devices/{id}/ssh-keys
Retrieve a device's ssh keys
findDeviceSSHKeys 3 params → 200401
GET
/projects/{id}/ssh-keys
Retrieve a project's ssh keys
findProjectSSHKeys 3 params → 200401
POST
/projects/{id}/ssh-keys
Create a ssh key for the given project
createProjectSSHKey 2 params body → 201401422
GET
/ssh-keys
Retrieve all ssh keys
findSSHKeys 2 params → 200401
POST
/ssh-keys
Create a ssh key for the current user
createSSHKey 1 param body → 201401422
DELETE
/ssh-keys/{id}
Delete the ssh key
deleteSSHKey 1 param → 204401403404
GET
/ssh-keys/{id}
Retrieve a ssh key
findSSHKeyById 2 params → 200401403404
PUT
/ssh-keys/{id}
Update the ssh key
updateSSHKey 2 params body → 200401403404422

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are SSHKey (9 properties), SSHKeyCreateInput (4 properties), SSHKeyInput (3 properties), Error (2 properties). Each schema is shown below with its type and property counts.

SSHKeyInput
object
3 properties
SSHKey
object
9 properties
Error
object
Error responses are included with 4xx and 5xx HTTP responses from the API service. Either "error" or "errors" will be set.
2 properties
SSHKeyCreateInput
object
4 properties
SSHKeyList
object
1 property
Href
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

equinix-sshkeys-api-openapi.yml Raw ↑

Other APIs Equinix publishes across the network.

Equinix Agent Templates API
Equinix Agents API
Equinix Authentication API
Equinix availability API
Equinix Batches API
Equinix BGP API
Equinix Capacity API
Equinix Cloud Events API
Equinix Cloud Routers API
Equinix Company Profiles API
Equinix Connections API
Equinix Console Log Details API