Integrations API

The Integrations API lets you manage plugin instances, automation rules, and CI/CD scan profiles programmatically. Use it to configure integrations with issue trackers, set up automated actions for vulnerability events, and manage scan profiles for CI/CD pipelines.

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

Common examples

List plugin instances

Use this to retrieve all configured plugin instances in your organization, such as Jira or other issue tracker connections.

View list plugin instances example

Endpoint: GET /api/integrations/v1/instances

Try it in Swagger UI:

1. Expand Instances and select GET /api/integrations/v1/instances.
2. Click Try it out.
3. Optionally filter by pluginId or set configuredOnly to true to return only fully configured instances.
4. Click Execute.

Example response:

{
  "instances": [
    {
      "instanceId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "pluginId": "jira-plugin",
      "name": "Production Jira",
      "configured": true,
      "createdOn": "2025-11-15T10:30:00Z"
    }
  ]
}

Create a plugin instance

Use this to create a new plugin instance, for example to add a Jira connection.

View create plugin instance example

Endpoint: POST /api/integrations/v1/instances

Try it in Swagger UI:

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

{
  "pluginId": "jira-plugin",
  "name": "string"
}

4. Click Execute.

A successful response returns HTTP 201 Created with the new instance details including its instanceId.

List automation rules

Use this to retrieve all automation rules configured in your organization.

View list automation rules example

Endpoint: GET /api/integrations/v1/automations

Try it in Swagger UI:

1. Expand Automations and select GET /api/integrations/v1/automations.
2. Click Try it out.
3. Click Execute.

Example response:

{
  "automations": [
    {
      "automationId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "name": "Critical Vulnerability Alert",
      "description": "Alert on critical severity findings",
      "enabled": true,
      "createdOn": "2025-11-10T14:20:00Z"
    }
  ]
}

Create an automation rule

Use this to create an automation rule that triggers an action when a specific event occurs, such as creating a Jira issue when a critical vulnerability is found.

View create automation rule example

Endpoint: POST /api/integrations/v1/automations

Try it in Swagger UI:

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

{
  "name": "string",
  "description": "string",
  "enabled": true,
  "scope": {
    "scopeType": "all"
  },
  "events": [
    {
      "eventType": "vulnerability_found",
      "actions": [
        {
          "actionType": "create_issue",
          "createIssueOptions": {
            "instanceId": "string"
          }
        }
      ],
      "vulnerabilityOptions": {
        "criticality": "critical"
      }
    }
  ]
}

4. Click Execute.

A successful response returns HTTP 201 Created with the new automation ID.

Supported eventType values: scan_done, scan_failed, vulnerability_found, vulnerability_created, report_created

Supported actionType values: create_issue, send_email, send_to_communicator

Supported criticality values: low, normal, high, critical

List CI/CD profiles

Use this to retrieve all CI/CD scan profiles configured in your organization.

View list CI/CD profiles example

Endpoint: GET /api/integrations/v1/cicd-profiles

Try it in Swagger UI:

1. Expand CI/CD Profiles and select GET /api/integrations/v1/cicd-profiles.
2. Click Try it out.
3. Click Execute.

Example response:

{
  "cicdProfiles": [
    {
      "cicdProfileId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "name": "Production Scan Profile",
      "createdOn": "2025-11-12T09:15:00Z"
    }
  ]
}

Create a CI/CD profile

Use this to create a CI/CD scan profile that defines how scans run in your pipeline and when to fail the build.

View create CI/CD profile example

Endpoint: POST /api/integrations/v1/cicd-profiles

Try it in Swagger UI:

1. Expand CI/CD Profiles and select POST /api/integrations/v1/cicd-profiles.
2. Click Try it out.
3. Replace the example request body with your values:

{
  "name": "string",
  "scanningProfileId": "string",
  "reportTemplateId": "string",
  "failConditions": {
    "failTheBuild": "when_conditions_are_met",
    "vulnerabilitySeverityConditions": "high_or_critical"
  }
}

4. Click Execute.

A successful response returns HTTP 201 Created with the new profile ID.

Supported failTheBuild values: when_conditions_are_met, do_not_fail_build

---

Need help?

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