Cancel a security remediation run (browser session)

Stops a live run; the pull request and any running pipeline are left for their reviewers. A finished run is answered unchanged.

POST /org/security/remediations/{run_id}/cancel

Cancel a security remediation run (browser session)

Python

import requests

url = "https://api.platform.ankra.app/org/security/remediations/{run_id}/cancel"

headers = {"cookie": "ankra_session="}

response = requests.post(url, headers=headers)

print(response.text)

200

{
  "finding_ids": [
    "<string>"
  ],
  "findings": [
    {
      "from": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "package": "<string>",
      "severity": "<string>",
      "to": "<string>",
      "vulnerability_id": "<string>"
    }
  ],
  "kind": "image_rebuild",
  "proposal_key": "<string>",
  "started_by": "person",
  "title": "<string>",
  "trigger": "<string>",
  "application_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "application_name": "<string>",
  "attempts": 123,
  "branch": "<string>",
  "cluster_ids": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "deadline_at": "2023-11-07T05:31:56Z",
  "failed_head_shas": [
    "<string>"
  ],
  "finding_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "image_repositories": [
    "<string>"
  ],
  "last_head_sha": "<string>",
  "last_outcome": "<string>",
  "last_pipeline_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "max_attempts": 123,
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pipeline_concluded_at": "2023-11-07T05:31:56Z",
  "pipeline_repository_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pull_request_number": 123,
  "pull_request_url": "<string>",
  "repository": "<string>",
  "requested_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "working",
  "status_reason": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "verified_at": "2023-11-07T05:31:56Z",
  "verified_head_sha": "<string>"
}

Authorizations

ankra_session · string · cookie · required

Browser session. Mutations also require X-Ankra-CSRF.

Path Parameters

run_id · string<uuid> · required

Response

200

application/json

Successful response

One remediation case for one fix pull request on one application (a finding's image rebuild, a base-image fix or a dependency bump): its fix pull request, the pipeline runs of its exact commits, and the rescan-based verification. verified needs a rescan of every affected cluster after the fix with no active occurrence; uncertain is a deadline passing without proof and never reads as clean.

finding_ids · string[] · required

Every finding the pull request fixes; what verification reads.

findings · object[] · required

Show child attributes

kind · enum<string> · required

Available options: image_rebuild, base_image_proposal, dependency_bump

proposal_key · string | null · required

The fix's identity inside its application: finding: for a finding's rebuild, the pull request's branch for an application-batched fix.

started_by · enum<string> · required

Available options: person, ankra

title · string · required

trigger · string | null · required

What made Ankra start the run; null for a person's.

application_id · string<uuid> · required

application_name · string · required

attempts · integer · required

branch · string · required

cluster_ids · string[] · required

created_at · string<date-time> · required

deadline_at · string<date-time> · required

failed_head_shas · string[] · required

finding_id · string<uuid> | null · required

The one finding a per-finding fix is for; null for an application-batched fix.

id · string<uuid> · required

image_repositories · string[] · required

last_head_sha · string | null · required

last_outcome · string | null · required

last_pipeline_run_id · string<uuid> | null · required

max_attempts · integer · required

organisation_id · string<uuid> · required

pipeline_concluded_at · string<date-time> | null · required

pipeline_repository_id · string<uuid> | null · required

pull_request_number · integer | null · required

pull_request_url · string · required

repository · string · required

requested_by · string<uuid> | null · required

status · enum<string> · required

Available options: working, verifying, verified, needs_human, uncertain, failed, cancelled

status_reason · string · required

updated_at · string<date-time> · required

verified_at · string<date-time> | null · required

verified_head_sha · string | null · required