API keys

API keys authenticate your CI/CD pipelines with VisualQ. Each key is scoped to a specific project.

Creating an API key

Go to Settings

Navigate to your project's Settings tab.

Find the API Keys section

Scroll to the API Keys section.

Create a new key

Click "Create API key". A new key will be generated and displayed.

Copy the key immediately

The full key is only shown once. Copy it and store it securely (e.g., in your CI system's secrets).

API keys are shown only once at creation. If you lose a key, revoke it and create a new one.

Using API keys

Include the API key in the X-API-Key header when calling the REST API:

curl -X POST https://visualq.ai/api/ci/run \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-api-key-here" \
  -d '{"project": "my-project"}'

Or pass it to the GitHub Action:

- uses: visualq/visualq-action@v1
  with:
    api-key: ${{ secrets.VISUALQ_API_KEY }}
    project: my-project

Revoking a key

From the API Keys section in Settings, click Revoke next to any key. The key is immediately invalidated and can no longer be used for authentication.

Security best practices

Store API keys in your CI system's secrets or environment variables
Never commit API keys to your repository
Rotate keys periodically
Revoke keys that are no longer needed