API call quickstart

Once you have an API token, you can call the veilx API with any tool that sends HTTP requests. Here's the shortest path to a working first request.

Authentication

Authenticate by carrying your token in the request header, for example:

• Carry the token in the Authorization header.
• Send all requests over HTTPS so the credential is encrypted in transit.

Make your first request

To read your list of sites, send a GET request with curl:

curl -H "Authorization: Bearer <your-token>" \
  https://api.veilx.io/v1/sites

The response is JSON listing the sites under your account. Swap in your own token to see real data.

Reading responses and errors

• 2xx means success, and the body is the requested data.
• 401 / 403 usually means an invalid token or insufficient permission — check the token and its scopes.
• 429 means you're calling too often — slow down or add retry backoff.
• A 4xx body generally carries an error description; fix the request parameters as instructed.