Skip to content
SSHVerify Docs

Authentication

Authentication for the SSHVerify API uses project API keys. Create API keys in the web app from project settings.

Using the API key

Section titled “Using the API key”

Send the key in the x-api-key header:

x-api-key: <api-key>

For example:

Terminal window
curl https://sshverify.com/api/v1/auth/info/ \
  -H "x-api-key: <api-key>"

Scope

Section titled “Scope”

Each API key is scoped to a project. It can manage SSH key collection and verification sessions only inside that project. The /auth/info/ endpoint returns the current key ID, key name, project ID, creation time, and optional expiration time.

Security

Section titled “Security”

Keep API keys out of source control and client-side code. Store them in a server-side environment variable or secret manager, and rotate keys when they are no longer needed.