Verify an API key

GET

/v2/authcheck

Confirms the presented API key is usable and names the account it belongs to. Takes no parameters and no body.

Authorizations

BearerAuth

Your Papermill API key, sent as Authorization: Bearer <key>.

Type

HTTP (bearer)

or

ApiKeyHeader

Your Papermill API key. Equivalent to the bearer form.

Type

API Key (header: x-api-key)

Responses

The key is usable.

Content-Type

application/json

{

  

"status": "string"

}

GET

/v2/authcheck

Playground

Authorization

BearerAuth

Samples

Example

shell

curl https://api.papermill.io/v2/authcheck \
  -H "Authorization: Bearer $PAPERMILL_API_KEY"

python

import os
import requests

response = requests.get(
    "https://api.papermill.io/v2/authcheck",
    headers={"Authorization": f"Bearer {os.environ['PAPERMILL_API_KEY']}"},
)
print(response.json())

javascript

const response = await fetch('https://api.papermill.io/v2/authcheck', {
  headers: { Authorization: `Bearer ${process.env.PAPERMILL_API_KEY}` },
})
console.log(await response.json())

{ "status": "Successfully authenticated as user@example.com" }