Resources | API Documentation | Heeler User Guide

Get Resource By Id

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

resource_idstringRequired

Responses

200

Successful Response

application/json

or

nullOptional

404

Not found

422

Validation Error

application/json

get

/api/resources/{resource_id}

GET /api/resources/{resource_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "heeler_id": {
    "heeler_id": "text",
    "resource_type": "text",
    "source_type": "text"
  },
  "name": "text",
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "properties": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Get Resource Details By Id

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

resource_idstringRequired

Responses

200

Successful Response

application/json

anyOptional

404

Not found

422

Validation Error

application/json

get

/api/resources/{resource_id}/details

GET /api/resources/{resource_id}/details HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Resource Attachments By Id

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

resource_idstringRequired

Responses

200

Successful Response

application/json

heeler_idstringRequired

resource_typestringRequired

provider_idstringRequired

resource_nameany ofRequired

stringOptional

or

nullOptional

regionany ofRequired

stringOptional

or

nullOptional

404

Not found

422

Validation Error

application/json

get

/api/resources/{resource_id}/attachments

GET /api/resources/{resource_id}/attachments HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "heeler_id": "text",
    "resource_type": "text",
    "provider_id": "text",
    "resource_name": "text",
    "region": "text"
  }
]

Get Events For Resource Id

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

resource_idstringRequired

Responses

200

Successful Response

application/json

messagestringRequired

timestampstringRequired

suspiciousbooleanOptionalDefault: false

account_idany ofOptional

stringOptional

or

nullOptional

account_nameany ofOptional

stringOptional

or

nullOptional

heeler_idsany ofOptional

string[]Optional

or

nullOptional

404

Not found

422

Validation Error

application/json

get

/api/resources/{resource_id}/events

GET /api/resources/{resource_id}/events HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "message": "text",
    "timestamp": "text",
    "suspicious": false,
    "account_id": "text",
    "account_name": "text",
    "heeler_ids": [
      "text"
    ]
  }
]

Get Deployment Graph

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

connection_idstringRequired

Bodystring[]

string[]Optional

Responses

200

Successful Response

application/json

anyOptional

404

Not found

422

Validation Error

application/json

get

/api/resources/graphs/deployment

GET /api/resources/graphs/deployment?connection_id=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]

No content

Get Resources Graph

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful Response

application/json

anyOptional

404

Not found

get

/api/resources/graphs/resources

GET /api/resources/graphs/resources HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Resource Attributes

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

resource_idstringRequired

Responses

200

Successful Response

application/json

attribute_namestringRequired

attribute_valuestringRequired

404

Not found

422

Validation Error

application/json

get

/api/resources/{resource_id}/attributes

GET /api/resources/{resource_id}/attributes HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "attribute_name": "text",
    "attribute_value": "text"
  }
]

Get Resource Deployments

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

resource_idstringRequired

Responses

200

Successful Response

application/json

service_idintegerRequired

service_namestringRequired

application_paramsstringRequired

deployment_idintegerRequired

changesetstringRequired

environmentstringRequired

404

Not found

422

Validation Error

application/json

get

/api/resources/{resource_id}/deployments

GET /api/resources/{resource_id}/deployments HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "service_id": 1,
    "service_name": "text",
    "application_params": "text",
    "deployment_id": 1,
    "changeset": "text",
    "environment": "text"
  }
]

Get Service Graph

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

service_idintegerRequired

Responses

200

Successful Response

application/json

anyOptional

404

Not found

422

Validation Error

application/json

get

/api/resources/{service_id}/service_graph

GET /api/resources/{service_id}/service_graph HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Service Connections

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

resource_idstringRequiredPattern: ^h4r>>

Responses

200

Successful Response

application/json

idintegerRequired

namestringRequired

heeler_idstringRequired

repositorystringRequired

repository_providerstringRequired

statusstringRequired

application_pathstringRequired

paramany ofOptional

stringOptional

or

nullOptional

source_typeany ofOptional

stringOptional

or

nullOptional

code_root_idintegerRequired

code_root_pathstringRequired

source_versionsstring[]Optional

sourceany ofOptional

or

nullOptional

severitystringRequired

tierany ofOptional

string · enumOptionalPossible values:

or

nullOptional

critical_findings_countintegerRequired

high_findings_countintegerRequired

medium_findings_countintegerRequired

low_findings_countintegerRequired

info_findings_countintegerRequired

findings_countintegerRequired

num_deploymentsintegerRequired

cloud_typesany ofRequired

or

nullOptional

accountsany ofRequired

or

nullOptional

latest_deployment_heeler_idany ofOptional

stringOptional

or

nullOptional

latest_deployed_timeany ofOptional

stringOptional

or

nullOptional

latest_csetany ofOptional

stringOptional

or

nullOptional

latest_tagsany ofOptional

or

nullOptional

applicationsany ofOptional

or

nullOptional

annotationsany ofOptional

or

nullOptional

createdstringRequired

updatedstringRequired

descriptionany ofOptional

stringOptional

or

nullOptional

projectany ofOptional

or

nullOptional

teamany ofOptional

or

nullOptional

project_ticket_typeany ofOptional

or

nullOptional

channelany ofOptional

or

nullOptional

urgentany ofOptionalDefault: 0

integerOptional

or

nullOptional

planany ofOptionalDefault: 0

integerOptional

or

nullOptional

deferany ofOptionalDefault: 0

integerOptional

or

nullOptional

404

Not found

422

Validation Error

application/json

get

/api/resources/{resource_id}/connections

GET /api/resources/{resource_id}/connections HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "heeler_id": "text",
    "repository": "text",
    "repository_provider": "text",
    "status": "text",
    "application_path": "text",
    "param": "text",
    "source_type": "text",
    "code_root_id": 1,
    "code_root_path": "text",
    "source_versions": [
      "text"
    ],
    "source": {
      "id": 1,
      "owner": {
        "id": 1,
        "login": "text",
        "url": "text",
        "html_url": "text",
        "avatars_url": "text"
      },
      "name": "text",
      "full_name": "text",
      "org": "text",
      "description": "text",
      "default_branch": "text",
      "master_branch": "text",
      "created_at": "text",
      "updated_at": "text",
      "git_url": "text",
      "ssh_url": "text",
      "html_url": "text",
      "language": "text",
      "fork": true,
      "open_issues_count": 1,
      "size": 1,
      "archived": true,
      "disabled": true,
      "private": true,
      "git_commits_url": "text",
      "branch_count": 0,
      "githubContributors": [
        {
          "login": "text",
          "name": "text",
          "avatar_url": "text",
          "contributions": 1,
          "url": "text"
        }
      ],
      "heeler_id": "text"
    },
    "severity": "text",
    "tier": "TIER_4",
    "critical_findings_count": 1,
    "high_findings_count": 1,
    "medium_findings_count": 1,
    "low_findings_count": 1,
    "info_findings_count": 1,
    "findings_count": 1,
    "num_deployments": 1,
    "cloud_types": [],
    "accounts": [],
    "tech_leads": [
      {
        "id": 1,
        "name": "text",
        "email": "text",
        "alternate_emails": [
          "text"
        ],
        "is_hidden": true
      }
    ],
    "security_leads": [
      {
        "id": 1,
        "name": "text",
        "email": "text",
        "alternate_emails": [
          "text"
        ],
        "is_hidden": true
      }
    ],
    "heeler_teams": [
      {
        "team_id": 1,
        "name": "text",
        "source": "text",
        "repository_count": 0
      }
    ],
    "latest_deployment_heeler_id": "text",
    "latest_deployed_time": "text",
    "latest_cset": "text",
    "latest_tags": [],
    "applications": [
      {
        "id": 1,
        "name": "text",
        "description": "text",
        "service_count": 0,
        "resource_count": 0,
        "business_impact": "HIGH",
        "tier": "TIER_1",
        "application_type": "static",
        "tech_leads": [
          {
            "id": 1,
            "name": "text",
            "email": "text",
            "alternate_emails": [
              "text"
            ],
            "is_hidden": true
          }
        ],
        "security_leads": [
          {
            "id": 1,
            "name": "text",
            "email": "text",
            "alternate_emails": [
              "text"
            ],
            "is_hidden": true
          }
        ],
        "heeler_teams": [
          {
            "team_id": 1,
            "name": "text",
            "source": "text",
            "repository_count": 0
          }
        ],
        "severity": "LOW",
        "created": "2026-03-18T20:53:11.279Z",
        "updated": "2026-03-18T20:53:11.279Z",
        "meta": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "services": [
          1
        ],
        "urgent": 0,
        "plan": 0,
        "defer": 0
      }
    ],
    "annotations": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "created": "text",
    "updated": "text",
    "description": "text",
    "project": {
      "project_id": "text",
      "name": "text",
      "key": "text",
      "source": "text",
      "connection_id": 1
    },
    "team": {
      "team_id": "text",
      "name": "text",
      "source": "text"
    },
    "project_ticket_type": {
      "ticket_type_id": "text",
      "name": "text",
      "image_url": "text"
    },
    "channel": {
      "name": "text",
      "source": "text",
      "connection_id": 1,
      "channel_id": "text"
    },
    "urgent": 0,
    "plan": 0,
    "defer": 0
  }
]

Get Resource Inventory Terms

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

categorystringOptionalDefault: compute

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/api/resources/inventory/_terms

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

{
  "terms": [
    {
      "name": "text",
      "lazy_load": false,
      "depends_on": [
        "text"
      ],
      "type": "Int",
      "terms": [
        {
          "lowerBound": 1,
          "upperBound": 1,
          "count": 1
        }
      ]
    }
  ]
}

Get Resource Categories

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

searchstringOptional

Bodyany of[]

or

Responses

200

Successful Response

application/json

itemsanyOptional

404

Not found

422

Validation Error

application/json

post

/api/resources/inventory/_categories

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

[
  {
    "name": "text",
    "lt": 1,
    "lte": 1,
    "gt": 1,
    "gte": 1,
    "equals": 1
  }
]

[]

Get Resource Inventory

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

categorystringOptionalDefault: compute

pageintegerOptionalDefault: 0

limitinteger · min: 1OptionalDefault: 100

orderany ofOptional

stringOptional

or

nullOptional

ordersany ofOptional

string[]Optional

or

nullOptional

directionany ofOptional

stringOptional

or

nullOptional

searchany ofOptional

stringOptional

or

nullOptional

Bodyany of[]

or

Responses

200

Successful Response

application/json

totalintegerRequired

pagesintegerRequired

page_sizeintegerRequired

page_numberintegerRequired

404

Not found

422

Validation Error

application/json

post

/api/resources/inventory/_search

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

[
  {
    "name": "text",
    "lt": 1,
    "lte": 1,
    "gt": 1,
    "gte": 1,
    "equals": 1
  }
]

{
  "items": [
    {
      "resource_type": "text",
      "provider_id": "text",
      "region": "text",
      "source_id": "text",
      "source_name": "text",
      "source": "text",
      "name": "text",
      "category": "text",
      "unique_id": "text",
      "heeler_id": "text",
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

hashtagGet Resource By Id

hashtagGet Resource Details By Id

hashtagGet Resource Attachments By Id

hashtagGet Events For Resource Id

hashtagGet Deployment Graph

hashtagGet Resources Graph

hashtagGet Resource Attributes

hashtagGet Resource Deployments

hashtagGet Service Graph

hashtagGet Service Connections

hashtagGet Resource Inventory Terms

hashtagGet Resource Categories

hashtagGet Resource Inventory

Get Resource By Id

Get Resource Details By Id

Get Resource Attachments By Id

Get Events For Resource Id

Get Deployment Graph

Get Resources Graph

Get Resource Attributes

Get Resource Deployments

Get Service Graph

Get Service Connections

Get Resource Inventory Terms

Get Resource Categories

Get Resource Inventory