Version: 0.1

• OpenAPI Spec

HivePaaS API

The REST API of HivePaaS, the one its dashboard uses. Every path is under the install's API base path, /api: GET https://<your HivePaaS domain>/api/projects lists the projects.

Authentication

A request authenticates one of two ways:

• An API key, in the headers HIVEPAAS-API-KEY-ID and HIVEPAAS-API-SECRET-KEY. A user creates their keys in the dashboard, among their account's settings, or with POST /users/current/settings/api-keys. A key acts as its user, within the limits it was created with. Scripts and integrations use this.
• A session's access token, in the header Authorization: Bearer <access token>. A login such as POST /auth/login-with-password gives it, and it expires within minutes: POST /sessions/refresh renews it. The dashboard uses this.

A request with neither is answered 401. The logins, the sign-up and password reset steps, the webhooks and the public images need neither.

Errors

A request that fails is answered with a 4xx or 5xx status and an hperrors.ErrorInfo body, whose code names the error, such as ERR_NO_SESSION.

Authentication

API Key: APIKeyID

The ID of an API key. It goes with HIVEPAAS-API-SECRET-KEY.

Security Scheme Type:	apiKey
Header parameter name:	HIVEPAAS-API-KEY-ID

API Key: APISecretKey

The secret of an API key. It goes with HIVEPAAS-API-KEY-ID.

Security Scheme Type:	apiKey
Header parameter name:	HIVEPAAS-API-SECRET-KEY

API Key: BearerToken

Bearer <access token>, a session's access token from a login.

Security Scheme Type:	apiKey
Header parameter name:	Authorization

Contact

HivePaaS:

URL: https://github.com/hivepaas/hivepaas/issues

License

Apache 2.0