Inventory

The Inventory API allows you to search and retrieve cloud assets from your Firefly inventory.

Search Inventory

Retrieve inventory hits

post

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Query parameters

includeAssetConfigurationbooleanOptional

Include asset configuration

Default: false

Body

application/json

sizeintegerOptional

Number of results to return per page (max 10000)

Default: 50

sourcestring[]Optional

List of fields to include in the response

Responses

200

Successful response

application/json

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

500

Internal Server Error

application/json

post

/api/inventory

HTTPcURLJavaScriptPython

POST /api/inventory HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 922

{
  "filters": {
    "assetState": "text",
    "assetTypes": [
      "text"
    ],
    "modifiedSince": "text",
    "freeTextSearch": "text",
    "arns": [
      "text"
    ],
    "frns": [
      "text"
    ],
    "providerIds": [
      "text"
    ],
    "regions": [
      "text"
    ],
    "names": [
      "text"
    ],
    "providerTypes": {
      "providerType": [
        "text"
      ],
      "providerSubType": [
        "text"
      ],
      "provider": [
        "text"
      ],
      "integrationId": [
        "text"
      ]
    },
    "tags": [
      "text"
    ],
    "iacTypes": [
      "text"
    ],
    "deleted": false,
    "includeConfiguration": true,
    "excludeIacTypes": [
      "text"
    ],
    "excludeTags": [
      "text"
    ],
    "excludeTypes": [
      "text"
    ],
    "excludeRegions": [
      "text"
    ],
    "severity": [
      "CRITICAL"
    ],
    "violatingPoliciesIds": [
      "text"
    ],
    "matchingExclusionRulesIds": [
      "text"
    ],
    "stackIds": [
      "text"
    ],
    "owners": [
      "text"
    ],
    "integrationIds": [
      "text"
    ],
    "hasMutations": false,
    "hasVCSLink": false,
    "hasComments": false,
    "deletedRange": [
      "text"
    ],
    "hasRelationship": false,
    "masterType": [
      "cloud"
    ],
    "isExcluded": false,
    "query": "text"
  },
  "sorting": {
    "field": "text",
    "order": "asc"
  },
  "size": 50,
  "source": [
    "text"
  ],
  "afterKey": {
    "sortField": "text",
    "id": "text"
  }
}

{
  "responseObjects": [
    {
      "integrationId": "text",
      "provider": "text",
      "providerId": "text",
      "assetId": "text",
      "resourceId": "text",
      "isExcluded": true,
      "lastConfigurationChangeTime": "text",
      "updatedAt": "text",
      "matchingExclusionRuleIds": [
        "text"
      ],
      "state": "modified",
      "isChild": true,
      "frn": "text",
      "providerGroupId": "text",
      "firstSeen": "text",
      "pendingTo": "text",
      "lastAssetStateChange": "text",
      "subProvider": "text",
      "classificationsDetails": {
        "remediationCommands": [
          "text"
        ],
        "description": "text",
        "monthlyCost": {
          "currency": "text",
          "value": 1
        }
      },
      "tags": {
        "key": "text",
        "value": "text"
      },
      "assetType": "text",
      "violationPolicyIds": [
        "text"
      ],
      "status": "text",
      "stateUpdatedTime": "text",
      "stackIds": [],
      "name": "text",
      "location": "text",
      "creationDate": 1,
      "deleteCommand": "text",
      "consoleURL": "text",
      "tagsList": [
        "text"
      ],
      "arn": "text",
      "flywheelSummary": {
        "requires_replace_items": "text",
        "requires_replace": true,
        "drifts": "text",
        "status": "text"
      },
      "taggingStatus": "NOT_TAGGED",
      "pendingExpiration": "text",
      "customColumns": {
        "key": "text",
        "value": "text"
      },
      "service": "text",
      "lastActivity": {
        "ActionType": "text",
        "eventTime": "text",
        "eventName": "text",
        "userIdentity": {
          "customColor": "text",
          "initials": "text",
          "displayName": "text",
          "type": "IAMUser"
        },
        "eventId": "text"
      },
      "providerSubType": "text",
      "creationTime": "text",
      "id": "text",
      "revisionCount": 1,
      "iac": {
        "type": "text",
        "stackName": "text",
        "stackIds": [
          "text"
        ],
        "activeStackId": "text",
        "firstSeen": "text",
        "moduleAddress": "text",
        "objectName": "text",
        "objectFullAddresses": "text",
        "stateLocation": "text"
      },
      "vcs": {
        "id": "text",
        "codeLink": "text",
        "codeFileLink": "text",
        "provider": "text",
        "repo": "text",
        "workingDirectory": "text"
      }
    }
  ],
  "totalObjects": 1,
  "afterKey": {
    "sortField": "text",
    "id": "text"
  }
}

Get Asset

Get an asset by ID

get

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Path parameters

assetIdstringRequired

Responses

200

Successful response

application/json

integrationIdstringOptional

The integration ID

providerstringOptional

The provider of the asset

providerIdstringOptional

The provider ID

assetIdstringOptional

The asset ID

resourceIdstringOptional

The resource ID

isExcludedbooleanOptional

Whether the asset is excluded (matched by an exclusion id)

lastConfigurationChangeTimestringOptional

The time the asset configuration was last changed

updatedAtstringOptional

The time the asset was last updated

matchingExclusionRuleIdsstring[]Optional

The exclusion rule IDs that match the asset

statestring · enumOptionalPossible values:

isChildbooleanOptional

Whether the asset is a child resource

frnstringOptional

The FRN of the asset

providerGroupIdstringOptional

The provider group ID (if applicable)

firstSeenstringOptional

The time the asset was first seen

pendingTostringOptional

The pending state of the asset

lastAssetStateChangestringOptional

The time the asset's state was last changed

subProviderstringOptional

The sub-provider of the asset

assetTypestringOptional

The type of the asset

violationPolicyIdsstring[]Optional

List of violating governance policy IDs

statusstringOptional

stateUpdatedTimestringOptional

The time the asset's state was last updated

stackIdsarrayOptional

namestringOptional

locationstringOptional

creationDateintegerOptional

deleteCommandstringOptional

consoleURLstringOptional

tagsListstring[]Optional

A tag

arnstringOptional

taggingStatusstring · enumOptionalPossible values:

pendingExpirationstringOptional

servicestringOptional

providerSubTypestringOptional

creationTimestringOptional

idstringOptional

revisionCountintegerOptional

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/inventory/{assetId}

HTTPcURLJavaScriptPython

GET /api/inventory/{assetId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "integrationId": "text",
  "provider": "text",
  "providerId": "text",
  "assetId": "text",
  "resourceId": "text",
  "isExcluded": true,
  "lastConfigurationChangeTime": "text",
  "updatedAt": "text",
  "matchingExclusionRuleIds": [
    "text"
  ],
  "state": "modified",
  "isChild": true,
  "frn": "text",
  "providerGroupId": "text",
  "firstSeen": "text",
  "pendingTo": "text",
  "lastAssetStateChange": "text",
  "subProvider": "text",
  "classificationsDetails": {
    "remediationCommands": [
      "text"
    ],
    "description": "text",
    "monthlyCost": {
      "currency": "text",
      "value": 1
    }
  },
  "tags": {
    "key": "text",
    "value": "text"
  },
  "assetType": "text",
  "violationPolicyIds": [
    "text"
  ],
  "status": "text",
  "stateUpdatedTime": "text",
  "stackIds": [],
  "name": "text",
  "location": "text",
  "creationDate": 1,
  "deleteCommand": "text",
  "consoleURL": "text",
  "tagsList": [
    "text"
  ],
  "arn": "text",
  "flywheelSummary": {
    "requires_replace_items": "text",
    "requires_replace": true,
    "drifts": "text",
    "status": "text"
  },
  "taggingStatus": "NOT_TAGGED",
  "pendingExpiration": "text",
  "customColumns": {
    "key": "text",
    "value": "text"
  },
  "service": "text",
  "lastActivity": {
    "ActionType": "text",
    "eventTime": "text",
    "eventName": "text",
    "userIdentity": {
      "customColor": "text",
      "initials": "text",
      "displayName": "text",
      "type": "IAMUser"
    },
    "eventId": "text"
  },
  "providerSubType": "text",
  "creationTime": "text",
  "id": "text",
  "revisionCount": 1,
  "iac": {
    "type": "text",
    "stackName": "text",
    "stackIds": [
      "text"
    ],
    "activeStackId": "text",
    "firstSeen": "text",
    "moduleAddress": "text",
    "objectName": "text",
    "objectFullAddresses": "text",
    "stateLocation": "text"
  },
  "vcs": {
    "id": "text",
    "codeLink": "text",
    "codeFileLink": "text",
    "provider": "text",
    "repo": "text",
    "workingDirectory": "text"
  }
}

Get Providers

Get all supported providers

get

Returns a list of all supported cloud and SaaS providers

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Responses

200

Successful response

application/json

string[]OptionalExample: ["aws","gcp","azurerm","oci","k8s","akamai","newrelic","datadog"]

401

Unauthorized Error

application/json

500

Internal Server Error

application/json

get

/api/inventory/providers

HTTPcURLJavaScriptPython

GET /api/inventory/providers HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  "aws",
  "gcp",
  "azurerm",
  "oci",
  "k8s",
  "akamai",
  "newrelic",
  "datadog"
]

Get IaC Coverage

Get IaC coverage statistics

post

Returns IaC coverage statistics for the account, optionally filtered by integrations

Authorizations

JWTAuth

AuthorizationstringRequired

JWT authentication token

Body

application/json

integrationsstring[]Optional

List of integration IDs to filter by

Responses

200

Successful response

application/json

400

Bad Request Error

application/json

401

Unauthorized Error

application/json

404

Not Found Error

application/json

500

Internal Server Error

application/json

post

/api/inventory/iac-coverage

HTTPcURLJavaScriptPython

POST /api/inventory/iac-coverage HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "integrations": [
    "text"
  ]
}

{
  "iacCoverage": {
    "codified": 1,
    "unmanaged": 1,
    "ghost": 1,
    "drifted": 1
  }
}