Integrations

The Integrations API allows you to manage cloud provider integrations in Firefly.

List Integrations

Get integrations by provider type

get

Retrieves all integrations for a specific cloud provider

Authorizations

AuthorizationstringRequired

JWT authentication token

Path parameters

providerTypestring · enumRequired

The cloud provider type

Possible values:

Responses

200

Successfully retrieved integrations

application/json

idstringOptional

Integration ID

accountIdstringOptional

Account ID

namestringOptional

Integration name

activebooleanOptional

Whether the integration is active

lastScanstring · date-timeOptional

Last successful scan time

creationDatestring · date-timeOptional

Integration creation date

accountNumberstringOptional

Cloud account number (for AWS, Azure, K8s)

projectIdstringOptional

GCP project ID (for GCP only)

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

get/api/integrations/{providerType}

GET /api/integrations/{providerType} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "text",
    "accountId": "text",
    "name": "text",
    "active": true,
    "lastScan": "2026-01-01T00:00:00.000Z",
    "creationDate": "2026-01-01T00:00:00.000Z",
    "accountNumber": "text",
    "projectId": "text"
  }
]

Create Integration

Create a new integration

post

Creates a new cloud integration (AWS or K8s)

Authorizations

AuthorizationstringRequired

JWT authentication token

Path parameters

providerTypestring · enumRequired

The cloud provider type (aws or k8s)

Possible values:

Body

or

Responses

200

Successfully created integration

application/json

or

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

409

Integration already exists

application/json

500

Internal Server Error

application/json

post/api/integrations/{providerType}

POST /api/integrations/{providerType} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "accountNumber": "text",
  "nickname": "text"
}

{
  "externalId": "text"
}

Delete Integration

Delete a K8s integration

delete

Deletes an existing K8s integration by cluster ID

Authorizations

AuthorizationstringRequired

JWT authentication token

Path parameters

providerTypestring · enumRequired

The provider type (only k8s supported for delete)

Possible values:

clusterIdstringRequired

The cluster ID to delete

Responses

200

Successfully deleted integration

application/json

clusterIdstringOptional

The deleted cluster ID

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

delete/api/integrations/{providerType}/{clusterId}

DELETE /api/integrations/{providerType}/{clusterId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "clusterId": "text"
}

Get AWS External ID

Get AWS external ID

get

Retrieves the AWS external ID for the account, used in IAM role trust policies

Authorizations

AuthorizationstringRequired

JWT authentication token

Responses

200

Successfully retrieved external ID

application/json

externalIdstringOptional

AWS external ID for IAM role trust policy

401

Unauthorized Error

application/json

500

Internal Server Error

application/json

get/api/integrations/aws/external-id

GET /api/integrations/aws/external-id HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "externalId": "text"
}