Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/plugins/{slug} \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Public and unauthenticated. A plugin we publish no release of is a `404`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
slug (path) | string | Yes | The plugin's directory name and text domain, e.g. `zinn-cache`. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
kind | string<wordpress_plugin, whmcs_module, hostbill_module, generic_client> | Yes | What this is, and therefore where it is installed. `wordpress_plugin` goes in `wp-content/plugins`; `whmcs_module` in a WHMCS install's `modules/servers/`; `hostbill_module` in… |
slug | string | Yes | The archive's directory name, e.g. `zinn-cache` or `zinn-whmcs`. |
name | string | Yes | — |
version | string | Yes | — |
package_sha256 | string | Yes | Lowercase hex SHA-256 of the archive. The value `downloadPlugin` returns in `X-Zinn-Package-SHA256`, and the one the plugin's own updater checks a download against before WordPr… |
package_bytes | integer | Yes | — |
requires_wp | string | No | — |
requires_php | string | No | — |
tested_wp | string | No | The WordPress version this release was installed and activated against before it was published — a real test on a real install, not an estimate. Empty means we have not stated o… |
changelog | string | No | — |
homepage | string | No | — |
distribution | string<public, app-only> | No | Who may download this plugin. `public` — anyone, no account needed, and it is also listed on https://zinndigital.com/wordpress-plugins. `app-only` — signed-in customers only; it… |
published_at | string | No | — |
Errors this endpoint can return
404 · 429