Resources

Get Resource By Id

get
Authorizations
Path parameters
resource_idstringRequired
Responses
200
Successful Response
application/json
Responseany of
or
nullOptional
get
GET /api/resources/{resource_id} HTTP/1.1
Host: 
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
Path parameters
resource_idstringRequired
Responses
200
Successful Response
application/json
Responseany
get
GET /api/resources/{resource_id}/details HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Resource Attachments By Id

get
Authorizations
Path parameters
resource_idstringRequired
Responses
200
Successful Response
application/json
get
GET /api/resources/{resource_id}/attachments HTTP/1.1
Host: 
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
Path parameters
resource_idstringRequired
Responses
200
Successful Response
application/json
get
GET /api/resources/{resource_id}/events HTTP/1.1
Host: 
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
Query parameters
connection_idstringRequired
Body
string[]Optional
Responses
200
Successful Response
application/json
Responseany
get
GET /api/resources/graphs/deployment?connection_id=text HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]
No content

Get Resources Graph

get
Authorizations
Responses
200
Successful Response
application/json
Responseany
get
GET /api/resources/graphs/resources HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Resource Attributes

get
Authorizations
Path parameters
resource_idstringRequired
Responses
200
Successful Response
application/json
get
GET /api/resources/{resource_id}/attributes HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Get Resource Deployments

get
Authorizations
Path parameters
resource_idstringRequired
Responses
200
Successful Response
application/json
get
GET /api/resources/{resource_id}/deployments HTTP/1.1
Host: 
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
Path parameters
service_idintegerRequired
Responses
200
Successful Response
application/json
Responseany
get
GET /api/resources/{service_id}/service_graph HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Service Connections

get
Authorizations
Path parameters
resource_idstringRequiredPattern: ^h4r>>
Responses
200
Successful Response
application/json
get
GET /api/resources/{resource_id}/connections HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "heeler_id": "text",
    "repository": "text",
    "status": "text",
    "application_path": "text",
    "param": "text",
    "source_type": "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
      }
    ],
    "suggested_tech_leads": [
      {
        "identity": {
          "id": 1,
          "name": "text",
          "email": "text",
          "alternate_emails": [
            "text"
          ],
          "is_hidden": true
        },
        "lines_of_code": 1,
        "last_commit_time": "2025-06-27T12:25:39.077Z"
      }
    ],
    "security_leads": [
      {
        "id": 1,
        "name": "text",
        "email": "text",
        "alternate_emails": [
          "text"
        ],
        "is_hidden": true
      }
    ],
    "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
          }
        ],
        "severity": "LOW",
        "created": "2025-06-27T12:25:39.077Z",
        "updated": "2025-06-27T12:25:39.077Z",
        "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
Query parameters
categorystringOptionalDefault: compute
Responses
200
Successful Response
application/json
get
GET /api/resources/inventory/_terms HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Get Resource Categories

post
Authorizations
Query parameters
searchstringOptional
Body
itemsany ofOptional
or
or
Responses
200
Successful Response
application/json
post
POST /api/resources/inventory/_categories HTTP/1.1
Host: 
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
Query parameters
categorystringOptionalDefault: compute
pageintegerOptionalDefault: 0
limitintegerOptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Body
itemsany ofOptional
or
or
Responses
200
Successful Response
application/json
post
POST /api/resources/inventory/_search HTTP/1.1
Host: 
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
}
PreviousNotesNextRemediations

Was this helpful?