Skip to content

API keys

An API key lets a server-side integration make requests for one AzScraper project. Every key is project-scoped and uses the Bearer authentication scheme.

Create a key

In the dashboard, open the project, select API keys, and create a key with a descriptive name. Copy the secret when it is shown; the dashboard does not reveal the full key again.

You can also rename or revoke a key in the dashboard. The API endpoints in this guide do not manage API keys.

Send requests

Store the key in a server-side secret manager or environment variable, then send it as a Bearer token:

export API_KEY="<project-api-key>"

curl -sS "$API_BASE/v1/key/projects/$PROJECT_ID/jobs" \
  -H "Authorization: Bearer $API_KEY"

The key can access project-scoped crawl, schedule, analytics, change-tracking, and webhook endpoints. The supported request paths are listed in Get data.

Security

  • Never expose the key in client-side JavaScript, a mobile app, or a public repository.
  • Use separate keys for separate integrations so you can revoke them independently.
  • If a key may have been exposed, revoke it in the dashboard and create a replacement.