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

WP Engine SSH Key API

The SSH Key API from WP Engine — 2 operation(s) for ssh key.

WP Engine SSH Key API is one of 17 APIs that WP Engine publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 3 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 2.0, at version 1.17.0.

Requests are made against the base URL https://api.wpengineapi.com/v1.

3 operations 2 paths 10 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.17.0
Base URL
https://api.wpengineapi.com/v1
Authentication
basic
Terms of Service
Resource Areas
1

Authentication & Security 1

WP Engine SSH Key API declares 1 security scheme for authenticating requests. It defines a basic scheme (basicAuth).

  • basicAuth — API username and password from Portal's API Access page: https://my.wpengine.com/apiaccess

Paths & Operations 3

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

SSH Key 3
GET
/ssh_keys
Get your SSH keys
listSshKeys 3 params → 200400401429503
POST
/ssh_keys
Add a new SSH key
createSshKey 2 params → 201400401403429503
DELETE
/ssh_keys/{ssh_key_id}
Delete an existing SSH key
deleteSshKey 2 params → 204400401403429503

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are ResourceError (5 properties), SshKey (4 properties), BadRequestErrorResponse (3 properties), ForbiddenErrorResponse (2 properties). Each schema is shown below with its type and property counts.

PreviousPage
string
Path to the previous page of results
SshKey
object
4 properties
NextPage
string
Path to the next page of results
TooManyRequestsOperation
Too many requests
BadRequestErrorResponse
object
3 properties 1 required
ResourceError
object
5 properties 5 required
ServiceUnavailableOperation
Service unavailable
ResultsCount
integer
The total number of results
ForbiddenErrorResponse
object
2 properties 1 required
AuthenticationErrorResponse
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wpengine-ssh-key-api-openapi.yml Raw ↑

Other APIs WP Engine publishes across the network.

WP Engine Account API
WP Engine Account User API
WP Engine Archive API
WP Engine Backup API
WP Engine Cache API
WP Engine Certificates API
WP Engine Domain API
WP Engine Install API
WP Engine Offload Settings API
WP Engine Site API
WP Engine Site Reports API
WP Engine Site Transfer API