Sign in
latestOpenAPI 3.0.32026-08-10152216352.3 KB

eea119b4113f

Relationships

Get resource relationships

Retrieves the relationships/connections for a specific resource identified by its FRN. Returns an array of connected resources with their full asset details including metadata, state information, and relationship type.

Results are filtered based on the user's RBAC permissions - only connections to integrations the user has access to will be returned.

post/relationships

Request body

frnstring required

The Firefly Resource Name (FRN) of the resource to query

integrationIdstring required

The integration ID of the resource

levelinteger

Number of levels to traverse in the relationship graph

Example request

{
  "frn": "aws_instance:us-east-1:i-0123456789abcdef0",
  "integrationId": "60123456789abcdef1234567",
  "level": 1
}

Response

Successfully retrieved relationships

idstring required

Unique identifier in format "integrationId:assetType:region:resourceId"

frnstring required

Firefly Resource Name

assetIdstring

Cloud provider's resource identifier (ARN for AWS)

resourceIdstring

Provider-specific resource ID

integrationIdstring required

Integration ID of the connected resource

accountIdstring required

Firefly account ID

assetTypestring required

Type of the connected asset

namestring

Resource name

regionstring

Cloud region

providerstring

Cloud provider

providerIdstring

Cloud provider account ID

providerType'cloud' | 'saas' | 'kubernetes'

Provider category

providerSubTypestring

Provider subcategory

servicestring

Cloud service name

connectionTypestring

Type of connection between resources

hierarchystring[] required

Hierarchy path of the resource in the relationship graph

type'ASSET' | 'TRACE' required

Node type in the relationship graph

hasOwnerTargetsboolean

Whether this resource has ownership targets

hasOwnerSourcesboolean

Whether this resource has ownership sources

ownerTargetsListstring[]

List of resources this resource owns

ownerSourcesListstring[]

List of resources that own this resource

hasControllerTargetsboolean

Whether this resource has controller targets (Kubernetes)

hasControllerSourcesboolean

Whether this resource has controller sources (Kubernetes)

state'unmanaged' | 'managed' | 'modified' | 'ghost' | 'iacIgnored' | 'child'

Current state of the resource

prevStatestring

Previous state of the resource

iacTypestring

Infrastructure as Code type

isExcludedboolean

Whether the resource is excluded from mutations

exclusionsstring[]

List of exclusion rule IDs applied to this resource

firstSeenstring

When the resource was first discovered

updateAtstring date-time

Last update timestamp

inventoryUpdateTimestring date-time

Last inventory update time

lastResourceStateChangestring date-time

Last state change timestamp

tagsstring

JSON string of resource tags

tagsListstring[]

Array of tags

taggingStatus'NOT_SUPPORTED' | 'NOT_TAGGED' | 'TAGGED'

Tagging status

consoleURLstring

Cloud provider console URL for the resource

deleteCommandstring

CLI command to delete the resource

stackIdstring

Identifier of the stack where this resource is located if managed by Infrastructure as Code

stackNamestring

Name of the stack where this resource is located

stackIdsstring[]

List of identifiers of the stacks where this resource is located, if managed by multiple stacks

metaHashstring

Hash of the metadata of the resource

prevSignaturestring

Previous hash signature of the resource

schemaVersioninteger

Terraform version of the resource's schema

revisionsNumberinteger

Number of mutations revisions of the resource

hasRevisionsboolean

Whether the resource has revisions

isChildboolean

Whether the resource is a child of another resource

isLockedboolean

Whether the resource is locked

isEventDrivenboolean

Whether the latest resource configuration originated from an event

isOutOfSyncboolean

Whether the resource configuration might be out of sync with the remote

runIdstring

Identifier of the run that created the resource

accountNamestring

Name of the Firefly account who owns this resource

arnstring

ARN of the resource

nonBijectionFRNstring

FRN of the resource

Example response

[
  {
    "id": "60123456789abcdef1234567:aws_instance:us-east-1:i-0123456789abcdef0",
    "frn": "aws_instance:us-east-1:i-0123456789abcdef0",
    "assetId": "arn:aws:ec2:us-east-1:012345678912:instance/i-0123456789abcdef0",
    "resourceId": "i-0123456789abcdef0",
    "integrationId": "60123456789abcdef1234567",
    "accountId": "60123456789abcdef1234567",
    "assetType": "aws_instance",
    "name": "i-0123456789abcdef0",
    "region": "us-east-1",
    "provider": "aws",
    "providerId": "012345678912",
    "providerType": "cloud",
    "providerSubType": "iaas",
    "service": "ec2",
    "connectionType": "Contains",
    "type": "ASSET",
    "hasOwnerTargets": true,
    "state": "iacIgnored",
    "prevState": "created",
    "iacType": "unmanaged",
    "isExcluded": true,
    "firstSeen": "2025-06-29 14:13:27.050209723 +0000 UTC",
    "updateAt": "2025-01-01T12:34:56.323161114Z",
    "inventoryUpdateTime": "2025-01-01T12:34:56.323161114Z",
    "lastResourceStateChange": "2025-06-29T14:15:24.283522147Z",
    "tags": "{\"key1\": \"value1\", \"key2\": \"value2\"}",
    "tagsList": [
      "key1: value1"
    ],
    "consoleURL": "https://us-east-1.console.aws.amazon.com/vpc/home?region=us-east-1#RouteTableDetails:RouteTableId=rtb-12345678",
    "deleteCommand": "aws ec2 terminate-instances --instance-ids i-12345678"
  }
]