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

Operation: stopJob.

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

Endpoint

POST https://amplerun-api.spiry.org/api/v1/jobs/{id}/stop

Authentication

Use the credential and scope required by this operation. For programmatic renter/host calls: Authorization: Bearer $AMPLERUN_API_KEY. A host-agent signature or other specialized proof is required where the description specifies it.

Parameters

Name	Location	Presence	Type	Description
id	path	Required	UUID
Idempotency-Key	header	Required	UUID	UUID scoped to authenticated principal, route and canonical request hash.

Request body

Required body.

application/json

Field	Type	Presence	Description
reason	string	Required

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "reason"
  ],
  "properties": {
    "reason": {
      "type": "string",
      "minLength": 1
    }
  }
}

Contract example:

{
  "reason": "training finished"
}

Responses

202

STOPPING or original terminal result.

application/json

Field	Type	Presence	Description
job_id	UUID	Required
state	“STOPPING” / “STOPPED” / “CLEANING” / “CLOSED”	Required

{
  "type": "object",
  "required": [
    "job_id",
    "state"
  ],
  "properties": {
    "job_id": {
      "$ref": "#/components/schemas/UUID"
    },
    "state": {
      "enum": [
        "STOPPING",
        "STOPPED",
        "CLEANING",
        "CLOSED"
      ]
    }
  }
}

default

Error envelope. 401 unauthenticated, 403/404 forbidden, 409 conflict, 422 invalid input, 429 rate limited (code UNAVAILABLE, retryable:true, no Retry-After header), 503 unavailable money/provider state with retryable:true.

application/json

Field	Type	Presence	Description
error	object	Required

{
  "$ref": "#/components/schemas/ErrorEnvelope"
}

Static request outline

Replace path/query placeholders and provide the required JSON body, headers and credential from the sections above. This is a request outline, not a command that chooses an amount or starts a rental for you.

curl --request POST 'https://amplerun-api.spiry.org/api/v1/jobs/{id}/stop' \
  --header "Authorization: Bearer $AMPLERUN_API_KEY"

Schema definitions · Download OpenAPI · Authentication · Errors and recovery