WP OctoDocs

Authentication

A workspace API key, sent as a bearer token.

Create a key

In the dashboard, a workspace administrator opens Workspace settings → API keys and creates one. The key is shown once; copy it into the integration's configuration. A key identifies the workspace, not a person, and keeps working when the person who made it leaves the workspace.

Revoke a key from the same page. It stops working at once.

Send it

Every request carries the key as a bearer token:

GET /api/v1/dashboard/websites HTTP/1.1
Host: wpocto.com
Accept: application/json
Authorization: Bearer <your key>

A request without a valid key is answered with 401.

Keep it where it belongs

The key opens this platform. It does not belong on a managed WordPress site, in a browser, or in a repository. A site holds a different credential — the workspace token — for a different purpose, and the two are not interchangeable; see Secrets.

From the reference pages

The API reference lets you try each operation from the page. Enter your key once in the authorization field; it is used for the requests you make from that browser and is not stored by the documentation site.

On this page