Skip to content
hydrate.sh droplet markhydrate.sh

Authentication

The v1 API authenticates with an API key.

Getting a key

Section titled “Getting a key”

API keys are issued from the hydrate dashboard. A key is shown once, when it is created, so copy it then and store it in a secrets manager. It cannot be retrieved again; if you lose it, issue a new one.

Keys come in two variants, shown by their prefix: hyd_test_… and hyd_live_….

The v1 API

Section titled “The v1 API”

Every /v1/ request sends the key as a Bearer token in the Authorization header:

Terminal window
curl https://api.hydrate.sh/v1/projects \
  -H "Authorization: Bearer hyd_live_xxxxxxxxxxxxxxxxxxxx"

A request with a missing or invalid key returns 401.

Scope and revocation

Section titled “Scope and revocation”

A key acts with the access of the account it was issued for, and no more. Revoking a key takes effect immediately: the next request returns 401. See the API reference for the scopes each endpoint requires.