API fundamentals

availability

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

API fundamentals series

This is the landing page for the API fundamentals series. Use the table below to navigate to each part.

This document is the landing page for the five-part API fundamentals series, which covers the essentials of the Invicti Platform API. It takes you from understanding when and why to use the API through to making authenticated calls and handling responses. Complete this series before moving on to the API scanning workflows series.

What this series covers

Part	Topic	What you do
1	When to use the API	Understand when the API is the right tool for the job
2	Get your API key	Generate your API key and access the interactive documentation
3	Authenticate	Understand how the X-Auth header works and apply security best practices
4	Make your first call	Make an authenticated call using Postman, curl, or Python
5	Handle responses	Understand response formats and implement error handling

---

Start here

→ Part 1: When to use the API

---

Need help?

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