Applications

Get Application Terms

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

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

Create Application

post
Authorizations
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
post
POST /api/applications/ HTTP/1.1
Host: 
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
    }
  ],
  "severity": "LOW",
  "created": "2025-06-27T12:19:04.764Z",
  "updated": "2025-06-27T12:19:04.764Z",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "services": [
    1
  ],
  "urgent": 0,
  "plan": 0,
  "defer": 0
}

Update Application Info

put
Authorizations
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
put
PUT /api/applications/ HTTP/1.1
Host: 
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
Path parameters
application_idintegerRequired
Body
integer[]Optional
Responses
200
Successful Response
application/json
post
POST /api/applications/{application_id}/service HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 3

[
  1
]
{
  "ok": true,
  "message": "text"
}

Remove Service From Application

delete
Authorizations
Path parameters
application_idintegerRequired
service_idintegerRequired
Responses
200
Successful Response
application/json
delete
DELETE /api/applications/{application_id}/service/{service_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Assign Tier To Application

post
Authorizations
Path parameters
application_idintegerRequired
Body
tierstringRequiredExample: TIER_1
Responses
200
Successful Response
application/json
Responseany
post
POST /api/applications/{application_id}/tier HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "tier": "TIER_1"
}
No content

Get Applications

get
Authorizations
Query parameters
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
get
GET /api/applications 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": [
    {
      "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:19:04.764Z",
      "updated": "2025-06-27T12:19:04.764Z",
      "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
Query parameters
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/applications 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": [
    {
      "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:19:04.764Z",
      "updated": "2025-06-27T12:19:04.764Z",
      "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
Path parameters
application_idintegerRequired
Body
environmentany ofRequired
stringOptional
or
nullOptional
coderootsany ofRequired
string[]Optional
or
nullOptional
Responses
200
Successful Response
application/json
Responseany
post
POST /api/applications/{application_id}/sbom HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43

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

Get Application

get
Authorizations
Path parameters
application_idintegerRequired
Responses
200
Successful Response
application/json
get
GET /api/applications/{application_id} HTTP/1.1
Host: 
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
    }
  ],
  "severity": "LOW",
  "created": "2025-06-27T12:19:04.764Z",
  "updated": "2025-06-27T12:19:04.764Z",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "services": [
    1
  ],
  "urgent": 0,
  "plan": 0,
  "defer": 0
}

Delete Application

delete
Authorizations
Path parameters
application_idintegerRequired
Responses
200
Successful Response
application/json
delete
DELETE /api/applications/{application_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Get Application Resources

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

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

Get Application Graph Resources

get
Authorizations
Path parameters
application_idintegerRequired
Query parameters
categoryany ofOptional
stringOptional
or
nullOptional
pageintegerOptionalDefault: 0
limitintegerOptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Responses
200
Successful Response
application/json
get
GET /api/applications/{application_id}/graph_resources HTTP/1.1
Host: 
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
Path parameters
application_idintegerRequired
Responses
200
Successful Response
application/json
Responseany
get
GET /api/applications/{application_id}/graph HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update App Graph

put
Authorizations
Body
string[]Optional
Responses
200
Successful Response
application/json
Responseany
put
PUT /api/applications/{application_id}/graph HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]
No content

Set Application Owners

post
Authorizations
Path parameters
application_idintegerRequired
owner_typestring · enumRequiredPossible values:
Body
Responses
200
Successful Response
application/json
post
POST /api/applications/{application_id}/owners/{owner_type} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "owners": [
    {
      "identity_id": 1
    }
  ]
}
{
  "ok": true,
  "message": "text"
}
PreviousSchedulesNextAnnotations

Was this helpful?