Skip to main content

Use the Jakka public API

Get an API key, authenticate, and make your first call.

J
Written by Jakka Pranav swaroop Naidu

Get an API key

API keys are managed at the account level, not at the org or project level. Open the User dropdown (top right) and click API access. A drawer opens with your existing keys and a Create API key button.

  1. Click Create API key.

  2. Enter a Name (for example, Production server or My local script).

  3. Click Create. The key appears once. Copy it and store it securely.

Authenticate

Pass the key as a Bearer token in the Authorization header.

Authorization: Bearer YOUR_API_KEY

Your first call

List the projects in your org:

-H "Authorization: Bearer YOUR_API_KEY"

Trigger a Test Run

-H "Authorization: Bearer YOUR_API_KEY" \

-H "Content-Type: application/json" \

-d '{"scope":"priority_pages","suites":"all"}'

The response contains a run ID. Poll GET /v1/runs/<run_id> until status is completed.

Retrieve results

Standard endpoints for runs, issues, pages, and assets. Pagination uses page and per_page query parameters. Default 25 per page, max 100.

Rate limits

Per-key limits apply. Back off with exponential delay if you receive 429 responses. Batch where possible.

Rotate or revoke a key

Open API access from the User dropdown. Click the trash icon next to any key to revoke it immediately. Create a new key first if you need a rolling rotation.

Related articles

Did this answer your question?