Applications | API Documentation

Get Application Terms

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful Response

application/json

404

Not found

get

/api/applications/_terms

GET /api/applications/_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
        }
      ]
    }
  ]
}

Create Application

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

namestringRequiredExample: My Application

descriptionany ofOptionalDefault: An application created by Heeler.

stringOptional

or

nullOptional

tierany ofOptionalDefault: TIER_1

stringOptional

or

nullOptional

application_typeany ofOptionalDefault: static

string · enumOptionalPossible values:

or

nullOptional

ownerany ofOptionalExample: {"login":"[email protected]","name":"John Doe"}

or

nullOptional

source_idintegerOptionalDefault: 0

metaany ofOptionalExample: {"env":"production"}

or

nullOptional

service_idsany ofOptional

integer[]Optional

or

nullOptional

Responses

200

Successful Response

application/json

idany ofOptional

integerOptional

or

nullOptional

namestringRequired

descriptionany ofOptional

stringOptional

or

nullOptional

service_countany ofOptionalDefault: 0

integerOptional

or

nullOptional

resource_countany ofOptionalDefault: 0

integerOptional

or

nullOptional

business_impactstring · enumOptionalDefault: HIGHPossible values:

tierstring · enumOptionalDefault: TIER_1Possible values:

application_typeany ofOptionalDefault: static

string · enumOptionalPossible values:

or

nullOptional

severityany ofOptionalDefault: LOW

string · enumOptionalPossible values:

or

nullOptional

createdany ofOptional

string · date-timeOptional

or

nullOptional

updatedany ofOptional

string · date-timeOptional

or

nullOptional

metaany ofOptionalDefault: {}

or

nullOptional

servicesany ofOptional

integer[]Optional

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

post

/api/applications/

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

{
  "name": "My Application",
  "description": "An application created by Heeler.",
  "tier": "TIER_1",
  "application_type": "static",
  "owner": {
    "login": "[email protected]",
    "name": "John Doe"
  },
  "source_id": 0,
  "meta": {
    "env": "production"
  },
  "service_ids": [
    1
  ]
}

{
  "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-18T21:49:33.123Z",
  "updated": "2026-03-18T21:49:33.123Z",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "services": [
    1
  ],
  "urgent": 0,
  "plan": 0,
  "defer": 0
}

Update Application Info

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

idintegerRequired

namestringRequired

descriptionany ofRequired

stringOptional

or

nullOptional

tierany ofRequired

stringOptional

or

nullOptional

service_idsany ofOptional

integer[]Optional

or

nullOptional

Responses

200

Successful Response

application/json

okbooleanRequired

messageany ofOptional

stringOptional

or

nullOptional

404

Not found

422

Validation Error

application/json

put

/api/applications/

PUT /api/applications/ HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "id": 1,
  "name": "text",
  "description": "text",
  "tier": "text",
  "service_ids": [
    1
  ]
}

{
  "ok": true,
  "message": "text"
}

Assign Services To Application

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

application_idintegerRequired

Bodyinteger[]

integer[]Optional

Responses

200

Successful Response

application/json

okbooleanRequired

messageany ofOptional

stringOptional

or

nullOptional

404

Not found

422

Validation Error

application/json

post

/api/applications/{application_id}/service

POST /api/applications/{application_id}/service HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3

[
  1
]

{
  "ok": true,
  "message": "text"
}

Remove Service From Application

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

application_idintegerRequired

service_idintegerRequired

Responses

200

Successful Response

application/json

okbooleanRequired

messageany ofOptional

stringOptional

or

nullOptional

404

Not found

422

Validation Error

application/json

delete

/api/applications/{application_id}/service/{service_id}

DELETE /api/applications/{application_id}/service/{service_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ok": true,
  "message": "text"
}

Assign Tier To Application

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

application_idintegerRequired

Body

tierstringRequiredExample: TIER_1

Responses

200

Successful Response

application/json

anyOptional

404

Not found

422

Validation Error

application/json

post

/api/applications/{application_id}/tier

POST /api/applications/{application_id}/tier HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "tier": "TIER_1"
}

No content

Get Applications

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

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

get

/api/applications

GET /api/applications 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": [
    {
      "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-18T21:49:33.123Z",
      "updated": "2026-03-18T21:49:33.123Z",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "services": [
        1
      ],
      "urgent": 0,
      "plan": 0,
      "defer": 0
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Applications

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

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/applications

POST /api/applications 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": [
    {
      "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-18T21:49:33.123Z",
      "updated": "2026-03-18T21:49:33.123Z",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "services": [
        1
      ],
      "urgent": 0,
      "plan": 0,
      "defer": 0
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Generate Sbom

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

application_idintegerRequired

Body

environmentany ofRequired

stringOptional

or

nullOptional

coderootsany ofRequired

string[]Optional

or

nullOptional

Responses

200

Successful Response

application/json

Represents a CycloneDX SBOM (Software Bill of Materials) format.

See: https://cyclonedx.org/docs/1.6/json/

bomFormatstringRequired

serialNumberany ofOptional

stringOptional

or

nullOptional

specVersionstringOptionalDefault: 1.6

versionany ofOptional

integerOptional

or

nullOptional

404

Not found

422

Validation Error

application/json

post

/api/applications/{application_id}/sbom

POST /api/applications/{application_id}/sbom HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "environment": "text",
  "coderoots": [
    "text"
  ]
}

{
  "bomFormat": "text",
  "components": [
    {
      "type": "application",
      "name": "text",
      "version": "text",
      "bom-ref": "text",
      "purl": "text",
      "group": "text",
      "properties": [
        {
          "name": "text",
          "value": "text"
        }
      ],
      "components": [
        {
          "type": "application",
          "name": "text",
          "version": "text",
          "bom-ref": "text",
          "purl": "text",
          "group": "text",
          "properties": [
            {
              "name": "text",
              "value": "text"
            }
          ],
          "components": [
            "[Circular Reference]"
          ]
        }
      ]
    }
  ],
  "dependencies": [
    {
      "ref": "text",
      "dependsOn": [
        "text"
      ]
    }
  ],
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "serialNumber": "text",
  "specVersion": "1.6",
  "version": 1
}

Get Application

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

application_idintegerRequired

Responses

200

Successful Response

application/json

idany ofOptional

integerOptional

or

nullOptional

namestringRequired

descriptionany ofOptional

stringOptional

or

nullOptional

service_countany ofOptionalDefault: 0

integerOptional

or

nullOptional

resource_countany ofOptionalDefault: 0

integerOptional

or

nullOptional

business_impactstring · enumOptionalDefault: HIGHPossible values:

tierstring · enumOptionalDefault: TIER_1Possible values:

application_typeany ofOptionalDefault: static

string · enumOptionalPossible values:

or

nullOptional

severityany ofOptionalDefault: LOW

string · enumOptionalPossible values:

or

nullOptional

createdany ofOptional

string · date-timeOptional

or

nullOptional

updatedany ofOptional

string · date-timeOptional

or

nullOptional

metaany ofOptionalDefault: {}

or

nullOptional

servicesany ofOptional

integer[]Optional

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/applications/{application_id}

GET /api/applications/{application_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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-18T21:49:33.123Z",
  "updated": "2026-03-18T21:49:33.123Z",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "services": [
    1
  ],
  "urgent": 0,
  "plan": 0,
  "defer": 0
}

Delete Application

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

application_idintegerRequired

Responses

200

Successful Response

application/json

okbooleanRequired

messageany ofOptional

stringOptional

or

nullOptional

404

Not found

422

Validation Error

application/json

delete

/api/applications/{application_id}

DELETE /api/applications/{application_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ok": true,
  "message": "text"
}

Get Application Resources

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

application_idintegerRequired

Responses

200

Successful Response

application/json

heeler_idstringRequired

resource_typestringRequired

source_typeany ofOptional

stringOptional

or

nullOptional

404

Not found

422

Validation Error

application/json

get

/api/applications/{application_id}/resources

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

[
  {
    "heeler_id": "text",
    "resource_type": "text",
    "source_type": "text"
  }
]

Get Application Graph Resources

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

application_idintegerRequired

Query parameters

categoryany ofOptional

stringOptional

or

nullOptional

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

Responses

200

Successful Response

application/json

totalintegerRequired

pagesintegerRequired

page_sizeintegerRequired

page_numberintegerRequired

404

Not found

422

Validation Error

application/json

get

/api/applications/{application_id}/graph_resources

GET /api/applications/{application_id}/graph_resources HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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
}

Get App Graph

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

application_idintegerRequired

Responses

200

Successful Response

application/json

anyOptional

404

Not found

422

Validation Error

application/json

get

/api/applications/{application_id}/graph

GET /api/applications/{application_id}/graph HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update App Graph

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodystring[]

string[]Optional

Responses

200

Successful Response

application/json

anyOptional

404

Not found

422

Validation Error

application/json

put

/api/applications/{application_id}/graph

PUT /api/applications/{application_id}/graph HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]

No content

Set Application Owners

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

application_idintegerRequired

owner_typestring · enumRequiredPossible values:

Body

Responses

200

Successful Response

application/json

okbooleanRequired

messageany ofOptional

stringOptional

or

nullOptional

404

Not found

422

Validation Error

application/json

post

/api/applications/{application_id}/owners/{owner_type}

POST /api/applications/{application_id}/owners/{owner_type} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "owners": [
    {
      "identity_id": 1
    }
  ]
}

{
  "ok": true,
  "message": "text"
}

hashtagGet Application Terms

hashtagCreate Application

hashtagUpdate Application Info

hashtagAssign Services To Application

hashtagRemove Service From Application

hashtagAssign Tier To Application

hashtagGet Applications

hashtagGet Applications

hashtagGenerate Sbom

hashtagGet Application

hashtagDelete Application

hashtagGet Application Resources

hashtagGet Application Graph Resources

hashtagGet App Graph

hashtagUpdate App Graph

hashtagSet Application Owners

Get Application Terms

Create Application

Update Application Info

Assign Services To Application

Remove Service From Application

Assign Tier To Application

Get Applications

Get Applications

Generate Sbom

Get Application

Delete Application

Get Application Resources

Get Application Graph Resources

Get App Graph

Update App Graph

Set Application Owners