Account API
Updated 2026-11-07
Base URL: https://api.plsk.org. Credential: account key (X-API-Key: plsa_… or Authorization: Bearer plsa_…). Scope read permits GET operations; scope manage permits all. Authentication, rate limit and error format: API reference. The operations below are generated from https://api.plsk.org/openapi.json, which also describes the schemas.
| Method | Path | What it does | Operation |
|---|
GET | /v1/subscriptions | List your subscriptions | listSubscriptions |
POST | /v1/subscriptions | Create a subscription (idempotent) | createSubscription |
GET | /v1/subscriptions/{id} | Read one subscription | getSubscription |
DELETE | /v1/subscriptions/{id} | Delete a ready subscription or remove a failed one | deleteSubscription |
POST | /v1/subscriptions/{id}/retry | Retry a failed subscription | retrySubscription |
GET | /v1/subscriptions/{id}/keys | List the keys of a subscription (no secrets) | listSubscriptionKeys |
POST | /v1/subscriptions/{id}/keys | Issue the subscription key for the Plesk API (secret shown once) | createSubscriptionKey |
DELETE | /v1/subscriptions/{id}/keys/{keyId} | Revoke a subscription key | revokeSubscriptionKey |
POST | /v1/feedback | Send a bug report or feedback (any key scope) | submitFeedback |
Status codes
| Operation | Success |
|---|
POST /v1/subscriptions | 201 created, 200 existing subscription for the same Idempotency-Key |
DELETE /v1/subscriptions/{id}, POST /v1/subscriptions/{id}/retry | 202 |
POST /v1/subscriptions/{id}/keys | 201 with token (returned once) |
DELETE /v1/subscriptions/{id}/keys/{keyId} | 204 |
POST /v1/feedback | 201 stored, 200 duplicate |
Error codes
| Status | Code | Condition |
|---|
| 401 | invalid_key | The key is missing, unknown, revoked or expired. |
| 403 | insufficient_scope | The scope of the key does not permit the operation. |
| 403 | disclosure_required | The research disclosure has not been acknowledged in the cabinet. |
| 404 | not_found | The resource does not exist in the account. |
| 409 | idempotency_conflict | The Idempotency-Key was used with a different request. |
| 409 | idempotency_key_spent | The Idempotency-Key belongs to a subscription that was deleted. |
| 409 | quota_exceeded | The account has 5 active subscriptions. |
| 409 | not_ready, not_failed | The state of the subscription does not permit the operation. |
| 409 | not_available | A key cannot be issued for the subscription now. |
| 409 | key_exists | The subscription already has an active key. |
| 429 | rate_limited | Rate limit exceeded; Retry-After gives the seconds to wait. |