The WireMock Cloud REST API is served from https://api.wiremock.cloud/v1. It accepts and returns application/json.

​
Authentication

There are two ways to authenticate yourself with the WireMock Cloud API:

​
1. API Token authentication (preferred)

Pass an Authorization header of the form Token <api-key>:

request
GET /v1
Authorization: Token <api-key>
Accept: application/json

Your API key can be retrieved from the web application at https://app.wiremock.cloud/account/security.

Unfortunately while this is our preferred authentication mechanism, it is not supported by the OpenAPI 3.x specification so it is not the one that features in the generated documentation examples.

​
2. Basic authentication (legacy)

Pass an Authorization header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:api-key.

request
GET /v1
Authorization: Basic <encoded-value>
Accept: application/json

Your API key can be retrieved from the web application at https://app.wiremock.cloud/account/security.

Unfortunately the generated documentation erroneously describes the <encoded-value> as the base64-encoded string username:password rather than username:api-key - at present we cannot fix this.

​
Documentation

The full API is documented under API Reference.