API overview
A small, versioned HTTP API for reading a workspace's data from an integration.
The WP Octo API lets an integration read what a workspace sees in its dashboard. It is deliberately small: today it exposes the workspace's websites, with their package and the outcome of their last update round. It grows as integrations need more, and each addition is recorded under Changes.
| Base URL | https://wpocto.com/api/v1 |
| Format | JSON, UTF-8 |
| Authentication | a workspace API key as a bearer token — Authentication |
| Scope | the workspace the key belongs to, and nothing else — Authorization |
| Versioning | in the path; v1 is the current and only version |
The reference
The API reference is generated from the application's own routes, controllers and response classes, so it describes what the code does rather than what someone remembered it doing. Every operation there can be tried from the page against https://wpocto.com with your own key.
API reference
Every operation, generated from the application.
Authentication
Creating a key and sending it.
Pagination
How lists are paged and sorted.
What the API is not
- It is not the way to talk to a site. The platform talks to the worker on a managed site over a channel of its own, which is not a public interface and is not documented as one.
- It does not issue keys. A key is created in the dashboard by a workspace administrator. There is no login endpoint that returns one.
- It does not act on sites. Starting an update round, a backup or a restore is done in the dashboard. Write operations are not part of
v1at this time.