API upgrade guide

When upgrading to Invicti Platform, the product API differs from the API used in previous Invicti products.

As a result, any existing:

• Automation scripts
• CI/CD integrations
• Custom tooling
• API-based reporting or orchestration

must be reviewed and updated to align with the Invicti Platform API schema.

This document explains what changes, where to find the new API, and what actions are required.

API compatibility

• The Invicti Platform API isn't backward-compatible with the API used in previous Invicti products.
• Existing API calls won't work as-is after the upgrade.
• Customers must adapt their integrations to use the Invicti Platform API endpoints, models, and authentication scheme.

Accessing the Invicti Platform API

The Invicti Platform API is documented via Swagger and is accessible based on your subscription region:

• US region: https://platform.invicti.com/swagger/
• EU region: https://platform-eu.invicti.com/swagger/
• Canada region: https://platform-ca.invicti.com/swagger/

Customers should use the Swagger UI to:

• Explore available endpoints.
• Review request/response schemas.
• Test API calls interactively.

API keys after the upgrade

• API keys aren't carried over during the upgrade.
• Customers must create new API keys in Invicti Platform before using the API.

How to create API keys

Refer to the following documentation:

• API access

This guide covers:

• Creating API keys.
• Managing permissions.
• Securing API access.

Required customer actions

After upgrading to Invicti Platform, customers should:

1. Review all existing automation scripts and API integrations.
2. Identify API calls that reference the legacy product API.
3. Create new API keys in Invicti Platform.
4. Update integrations to use the Invicti Platform API endpoints.
5. Validate integrations using the Swagger interface.

Summary

• Invicti Platform uses a different API than previous products.
• Existing API-based integrations must be updated.
• API keys aren't carried over and must be recreated.
• Swagger documentation is available per subscription region.

---

Need help?

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