Applications

Get Application Terms

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
chevron-right
200

Successful Response

application/json
get
/api/applications/_terms

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
chevron-right
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
post
/api/applications/

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
chevron-right
200

Successful Response

application/json
okbooleanRequired
messageany ofOptional
stringOptional
or
nullOptional
put
/api/applications/

Assign Services To Application

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
application_idintegerRequired
Bodyinteger[]
integer[]Optional
Responses
chevron-right
200

Successful Response

application/json
okbooleanRequired
messageany ofOptional
stringOptional
or
nullOptional
post
/api/applications/{application_id}/service

Remove Service From Application

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
application_idintegerRequired
service_idintegerRequired
Responses
chevron-right
200

Successful Response

application/json
okbooleanRequired
messageany ofOptional
stringOptional
or
nullOptional
delete
/api/applications/{application_id}/service/{service_id}

Assign Tier To Application

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
application_idintegerRequired
Body
tierstringRequiredExample: TIER_1
Responses
chevron-right
200

Successful Response

application/json
anyOptional
post
/api/applications/{application_id}/tier

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
or
Responses
chevron-right
200

Successful Response

application/json
totalintegerRequired
pagesintegerRequired
page_sizeintegerRequired
page_numberintegerRequired
get
/api/applications

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
or
Responses
chevron-right
200

Successful Response

application/json
totalintegerRequired
pagesintegerRequired
page_sizeintegerRequired
page_numberintegerRequired
post
/api/applications

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
chevron-right
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
post
/api/applications/{application_id}/sbom

Get Application

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
application_idintegerRequired
Responses
chevron-right
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
get
/api/applications/{application_id}

Delete Application

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
application_idintegerRequired
Responses
chevron-right
200

Successful Response

application/json
okbooleanRequired
messageany ofOptional
stringOptional
or
nullOptional
delete
/api/applications/{application_id}

Get Application Resources

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
application_idintegerRequired
Responses
chevron-right
200

Successful Response

application/json
heeler_idstringRequired
resource_typestringRequired
source_typeany ofOptional
stringOptional
or
nullOptional
get
/api/applications/{application_id}/resources

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
chevron-right
200

Successful Response

application/json
totalintegerRequired
pagesintegerRequired
page_sizeintegerRequired
page_numberintegerRequired
get
/api/applications/{application_id}/graph_resources

Get App Graph

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
application_idintegerRequired
Responses
chevron-right
200

Successful Response

application/json
anyOptional
get
/api/applications/{application_id}/graph

No content

Update App Graph

put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Bodystring[]
string[]Optional
Responses
chevron-right
200

Successful Response

application/json
anyOptional
put
/api/applications/{application_id}/graph

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
chevron-right
200

Successful Response

application/json
okbooleanRequired
messageany ofOptional
stringOptional
or
nullOptional
post
/api/applications/{application_id}/owners/{owner_type}

Last updated

Was this helpful?