Skip to main content
Webentor Studio

Help · API reference

This deployment

This deployment: its name and what it offers.

All groups

List hosting providersGET /api/v1/hosting-providers

Lists the hosting providers this deployment has installed, with each one's id, label, whether it needs a credential, its credential fields and whether it is unverified. Use an id as provider when adding a deploy target.

Who may call it: A signed-in session, or an access token (write to change anything)

200 Success.

Errors it can answer
  • 401 Authentication required. (code is unauthenticated.)
  • default Any other failure, as RFC 9457 problem details.

Get this API descriptionGET /api/v1/openapi.json

Returns this description of the API, the same file the reference is rendered from, as OpenAPI 3.1. Cacheable for five minutes; send the ETag back as If-None-Match and an unchanged file answers 304.

Who may call it: Anybody

Parameters

  • If-None-Match (header, string, optional): Conditional read; answers 304 when unchanged.

200 Success.

Errors it can answer
  • 304 Not modified: the If-None-Match you sent is current.
  • 404 Not found. Also returned when the resource exists but the caller may not see it, so that the two cannot be told apart. (code is not_found.)
  • default Any other failure, as RFC 9457 problem details.