API Importers API

The API Importers API lets you manage importers - integrations that automatically pull API definitions from external sources such as AWS API Gateway, Azure API Management, Apigee, Kong, and MuleSoft Anypoint Exchange.

Use this API to create, configure, trigger, and delete importers programmatically.

For authentication and general Swagger UI navigation, refer to Use the Invicti Platform API. Open this API definition directly in Swagger UI.

Common examples

List all importers

Use this to retrieve all configured importers in your organization.

View list importers example

Endpoint: GET /api/apihub/v1/importers

Try it in Swagger UI:

1. Expand Importers and select GET /api/apihub/v1/importers.
2. Click Try it out.
3. Click Execute.

Example response:

{
  "importers": [
    {
      "importerId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "name": "My AWS Importer",
      "type": "Aws_api_gateway",
      "status": "Active",
      "updateFrequency": null,
      "lastRunDate": "2025-11-15T10:30:00Z",
      "lastRunFailReason": null,
      "syncStatus": "Completed",
      "parameters": {},
      "extras": null
    }
  ]
}

Supported syncStatus values: None, Completed, Failed

Create an importer

Use this to create a new importer that pulls API definitions from an external source on a schedule.

View create importer example

Endpoint: POST /api/apihub/v1/importers

Try it in Swagger UI:

1. Expand Importers and select POST /api/apihub/v1/importers.
2. Click Try it out.
3. Replace the example request body with your values:

{
  "name": "AWS Gateway Importer",
  "type": "aws_api_gateway",
  "status": "active",
  "updateFrequency": {
    "unit": "daily",
    "value": 1
  },
  "parameters": {
    "clientId": "string",
    "clientSecret": "string",
    "organizationId": "string"
  },
  "excludeEmptySpecs": true
}

4. Click Execute.

Fields:

Field	Required	Notes
name	Yes	Display name for the importer
type	No	Source type (see values below)
status	No	active, inactive, or pending
updateFrequency.unit	No	hourly, daily, weekly, or monthly
updateFrequency.value	No	Numeric interval for the unit
parameters	No	Connection parameters specific to the importer type
excludeEmptySpecs	No	When true, skips importing API specs with no operations

Supported type values:

Value	Source
aws_api_gateway	AWS API Gateway
azure	Azure API Management
apigee	Apigee
kong	Kong
anypoint_exchange	MuleSoft Anypoint Exchange
invicti_nad_agent	Invicti NAD Agent

A successful response returns HTTP 200 with the new importer ID.

Trigger an importer

Use this to manually trigger an importer to run immediately, without waiting for its scheduled interval.

View trigger importer example

Endpoint: POST /api/apihub/v1/importers/{importerId}/trigger

Try it in Swagger UI:

1. Expand Importers and select POST /api/apihub/v1/importers/{importerId}/trigger.
2. Click Try it out.
3. Enter the importerId of the importer you want to trigger. You can retrieve this from the list importers endpoint.
4. Click Execute.

A successful response returns HTTP 204 No Content.

Delete an importer

Use this to permanently remove an importer.

View delete importer example

Endpoint: DELETE /api/apihub/v1/importers/{importerId}

Try it in Swagger UI:

1. Expand Importers and select DELETE /api/apihub/v1/importers/{importerId}.
2. Click Try it out.
3. Enter the importerId of the importer you want to delete.
4. Click Execute.

A successful response returns HTTP 204 No Content.

warning

Deleting an importer is permanent. API definitions previously imported by it are not automatically removed.

---

Need help?

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