Remediations

Get Remediation Details

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

Successful Response

application/json

Intended to be called only to display the front end remediation details page.

idintegerRequired

Unique identifier for this remediation.

package_namestringRequired

The name of the package that this remediation offers solutions for.

package_ecosystemstring · enumRequired

The package ecosystem that this package is a part of.

Possible values:
titlestringRequired

The title of the remediation.

createdstring · date-timeRequired

The time when the remediation was created.

assigneeany ofRequired

The identity assigned to perform this remediation.

or
nullOptional
is_automatablebooleanOptional

Whether the remediation is automatable.

Default: false
is_direct_dependencybooleanRequired

Whether the remediation is on a direct dependency.

code_root_idintegerRequired

The code root id that this remediation is for.

service_idintegerRequired

The service id of the service this remediation is for.

service_namestringRequired

The name of the service this remediation is for.

affected_deployment_idsinteger[]Required

Specific deployments that this remediation affects.

slo_seconds_remainingintegerRequired

The remaining time in seconds to meet the SLO. It is taken as the MINIMUM of all the findings.

slo_seconds_totalintegerRequired

The total time in seconds to meet the SLO. It is taken as the MAXIMUM of all the findings.

prioritystring · enumRequired

The priority of the remediation. It is taken as the MAXIMUM of all the findings.

Possible values:
resource_countintegerRequired

The number of resources affected by this remediation.

source_typeany ofOptional

The language of the service

stringOptional
or
nullOptional
application_pathany ofOptional

The service application path.

stringOptional
or
nullOptional
application_paramsany ofOptional

The service application params.

stringOptional
or
nullOptional
fixabilityany ofRequired

The fixability of the remediation.

string · enumOptionalPossible values:
or
nullOptional
is_maintainedany ofRequired
booleanOptional
or
nullOptional
get
/api/services/remediations/{remediation_id}

Set Remediation Assignee

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
remediation_idintegerRequired
Body
identity_idintegerRequired
Responses
chevron-right
200

Successful Response

application/json
okbooleanRequired
messageany ofOptional
stringOptional
or
nullOptional
post
/api/services/remediations/{remediation_id}/assignee

Delete Remediation Assignee

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

Successful Response

application/json
okbooleanRequired
messageany ofOptional
stringOptional
or
nullOptional
delete
/api/services/remediations/{remediation_id}/assignee

Create Jira Issue For Remediation

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
remediation_idintegerRequired
solution_idintegerRequired
Body
or
Responses
chevron-right
200

Successful Response

application/json
issue_idintegerRequired
namestringRequired
statusstringRequired
status_categorystringRequired
issue_typestringRequired
issue_type_icon_urlany ofRequired
stringOptional
or
nullOptional
urlany ofRequired
stringOptional
or
nullOptional
summarystringRequired
connection_typestringOptionalDefault: jira
remediation_idany ofOptional
integerOptional
or
nullOptional
post
/api/services/remediations/{remediation_id}/solutions/{solution_id}/issue

Get Suggested Jira Issue Fields

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
remediation_idintegerRequired
solution_idintegerRequired
Query parameters
connection_typeany ofOptional
stringOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
or
get
/api/services/remediations/{remediation_id}/solution/{solution_id}/issue

Delete Ticket From Remediation

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
remediation_idintegerRequired
Body
connection_typestringRequired
issue_idintegerRequired
finding_idany ofOptional
integerOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
anyOptional
post
/api/services/remediations/{remediation_id}/unlink

No content

Link Ticket To Remediation

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
remediation_idintegerRequired
solution_idintegerRequired
Body
connection_typestringRequired
issue_idintegerRequired
finding_idany ofOptional
integerOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
anyOptional
post
/api/services/remediations/{remediation_id}/solution/{solution_id}/link

No content

Get Remediation Term Data

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
term_namestringRequired
code_root_idany ofOptional
integerOptional
or
nullOptional
service_idany ofOptional
integerOptional
or
nullOptional
Bodyany of[]
or
or
Responses
chevron-right
200

Successful Response

application/json
or
or
or
or
get
/api/remediations/_terms/data

Get Remediation Term Data

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
term_namestringRequired
code_root_idany ofOptional
integerOptional
or
nullOptional
service_idany ofOptional
integerOptional
or
nullOptional
Bodyany of[]
or
or
Responses
chevron-right
200

Successful Response

application/json
or
or
or
or
post
/api/remediations/_terms/data

Get Remediation Terms

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
code_root_idany ofOptional
integerOptional
or
nullOptional
service_idany ofOptional
integerOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
get
/api/remediations/_terms

Get Remediations

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
code_root_idany ofOptional
integerOptional
or
nullOptional
service_idany ofOptional
integerOptional
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
Bodyany of[]
or
or
Responses
chevron-right
200

Successful Response

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

Get Remediations

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
code_root_idany ofOptional
integerOptional
or
nullOptional
service_idany ofOptional
integerOptional
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
Bodyany of[]
or
or
Responses
chevron-right
200

Successful Response

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

Last updated

Was this helpful?