jobs

Stop job (renter owner/admin); repeat is idempotent

post/api/v1/jobs/{id}/stop

Request

  • Base URL: https://amplerun-api.spiry.org
  • URL: https://amplerun-api.spiry.org/api/v1/jobs/{id}/stop
  • Auth: HTTP bearer

Path parameters

idstring uuid required
Example:3f0e2a55-8c1b-4d2e-9a6f-0b7c1d2e3f40

Headers

Idempotency-Keystring uuid required
Example:3f0e2a55-8c1b-4d2e-9a6f-0b7c1d2e3f40

UUID scoped to authenticated principal, route and canonical request hash.

Request body

reasonstring required

Response

STOPPING or original terminal result.

job_idstring uuid required
state'STOPPING' | 'STOPPED' | 'CLEANING' | 'CLOSED' required

Example response

{
  "job_id": "3f0e2a55-8c1b-4d2e-9a6f-0b7c1d2e3f40"
}

Changes

No recorded changes to this operation across all 1 revision of this API.