Stackurity Start free trial

API reference Automatic fixes

Automatic fixes

9 operations. Base URL https://app.stackurity.dev/api/v1 on Stackurity Cloud; see authentication.

Remediation plans (licensed edition)

GET /remediation/plans

Role: viewer

Plans and their per-asset actions

Parameters

ParameterInTypeDescription
statusquerystring

Responses

StatusMeaningBody
2XXSuccessobject
4XXAn errorError
5XXAn errorError

One remediation plan with its actions (licensed edition)

GET /remediation/plans/{id}

Role: viewer Licensed build only

Plans and their per-asset actions

Parameters

ParameterInTypeDescription
id requiredpathstring

Responses

StatusMeaningBody
2XXSuccessobject
4XXAn errorError
5XXAn errorError

Approve or decline a remediation plan (licensed edition)

POST /remediation/plans/{id}/decision

Role: security (admin for major)

{"decision": "approve" | "reject" | "cancel", "note": "..."}

Parameters

ParameterInTypeDescription
id requiredpathstring

Request body

application/json, required: object

Responses

StatusMeaningBody
2XXSuccessobject
4XXAn errorError
5XXAn errorError

Remediation policies (licensed edition)

GET /remediation/policies

Role: security

Remediation policies

Responses

StatusMeaningBody
2XXSuccessobject
4XXAn errorError
5XXAn errorError

Create a remediation policy (licensed edition)

POST /remediation/policies

Role: admin

Manage policies (remediation.md)

Request body

application/json, required: object

Responses

StatusMeaningBody
2XXSuccessobject
4XXAn errorError
5XXAn errorError

Preview what a remediation policy would plan (licensed edition)

POST /remediation/policies/preview

Role: admin Licensed build only

Which fixable packages and assets a proposed policy would authorise or stop authorising, without saving (remediation.md)

Parameters

ParameterInTypeDescription
idquerystring

Request body

application/json, required: object

Responses

StatusMeaningBody
2XXSuccessobject
4XXAn errorError
5XXAn errorError

Replace a remediation policy (licensed edition)

PUT /remediation/policies/{id}

Role: admin Licensed build only

Manage policies (remediation.md)

Parameters

ParameterInTypeDescription
id requiredpathstring

Request body

application/json, required: object

Responses

StatusMeaningBody
2XXSuccessobject
4XXAn errorError
5XXAn errorError

Delete a remediation policy (licensed edition)

DELETE /remediation/policies/{id}

Role: admin Licensed build only

Manage policies (remediation.md)

Parameters

ParameterInTypeDescription
id requiredpathstring

Responses

StatusMeaningBody
2XXSuccess (usually 204 No Content)no body
4XXAn errorError
5XXAn errorError

Renovate configuration from approved remediation plans (licensed edition)

GET /remediation/renovate.json

Role: collector, engineer

Renovate rules for approved repository plans

Parameters

ParameterInTypeDescription
repositoryquerystring
modequerystring

Responses

StatusMeaningBody
2XXSuccessobject
4XXAn errorError
5XXAn errorError