discovery-runs

Cancel a discovery run

Changed on

Cancel every queued, claimed, or running job belonging to a discovery run.

Use this discovery operation to create, synchronize, lease, inspect, or cancel research work. Treat discovered actors as reviewable leads until their source evidence and visibility state are checked.

post/api/discovery-runs/{run_id}/cancel

Request

  • Base URL: https://atlas.rebuildingus.org
  • URL: https://atlas.rebuildingus.org/api/discovery-runs/{run_id}/cancel
  • Auth: none declared

Path parameters

run_idstring required

Headers

x-api-keystring nullable

Response

Successful Response

jobs_cancelledinteger required

Number of non-terminal jobs moved to cancelled

run_idstring required

The discovery run whose jobs were cancelled

Changes

  • 6ea72ce93d40Revision changes
    • warning

      deleted the header request parameter x-atlas-actor-email

    • warning

      deleted the header request parameter x-atlas-actor-id

    • warning

      deleted the header request parameter x-atlas-internal-secret

    • warning

      deleted the header request parameter x-atlas-organization-id