API keys

API keys let external systems access Instruqt – for example, a CI/CD pipeline that manages labs, or a script that pulls reporting data through the API.

Your team has one API key, managed by team Owners.

View and copy your API key

1. In the sidebar, click Settings → API keys.
2. Click the eye icon to reveal the key, or copy it directly to your clipboard.

Only team Owners can view the API key.

Regenerate your API key

1. In the sidebar, click Settings → API keys.
2. Click Regenerate API Key.

Regenerating creates a new key and replaces the current one. Any system using the old key loses access, so update your integrations right after regenerating.

Use the API key

The key authorizes requests to the Instruqt GraphQL API. Pass it in the Authorization header:

Authorization: Bearer YOUR_API_KEY

All queries and mutations are HTTP POST requests to https://play.instruqt.com/graphql.

Caution

The API key carries full Owner permissions for your team, whoever holds it. Treat it like an Owner’s password: store it in a secret manager, share it only with systems that need it, and regenerate it when the group of people with access changes.

LTI credentials

The same page also holds your team’s LTI credentials – a Consumer Key and Consumer Secret used to connect Instruqt to a learning management system. You can regenerate these independently of the API key. See the LTI integration page for setup.