Skip to main content

Manage your API key

availability

Deployment: Invicti Platform on-demand, Invicti Platform on-premises

Your API key is the credential you use to authenticate all Invicti Platform API requests. This document explains how to generate, copy, and delete your API key, and access the API documentation from the User settings page.

Generate a new API key

  1. Click the initials at the top right corner of the page, then select User settings.
User menu expanded showing the User settings option
  1. Click API key.
  2. Use the Generate new API key button to generate a new one.
  3. Click Copy to copy your new API key, or use the trash can icon to delete it.
API key section showing the Generate new API key button and Copy and delete options

Copy an existing API key

If you already have an API key and want to reuse it:

  1. Click the initials at the top right corner of the page, then select User settings.
  2. Click API key.
  3. Click Copy to copy the key to your clipboard.

Access API documentation

The API documentation link is available on the same page:

  1. Click the initials at the top right corner of the page, then select User settings.
  2. Click API key.
  3. Click the API documentation link to open the documentation in a user-friendly, readable format.
API key section showing the API documentation link

Need help?

Invicti Support team is ready to provide you with technical help. Go to Help Center

Was this page useful?