Deployments

[Internal] Stop a deployment via container exit hook

Internal endpoint called by ExternalHooksManager when a container exits and the AppVersion restart policy requires the deployment to be stopped. Not intended for direct client use.

post/v1/hooks/stop/{request_id}

Request

  • Base URL: https://api.edgegap.com
  • URL: https://api.edgegap.com/v1/hooks/stop/{request_id}
  • Auth: API key in header authorization

Path parameters

request_idstring required

Unique identifier of the deployment to stop

Request body

exit_codeinteger required

Exit code returned by the container process

exit_reasonstring required

Human-readable reason for the container exit as reported by Kubeless

restart_policy'always' | 'never' | 'on_failure' required

Restart policy configured on the AppVersion that triggered this stop

Example request

{
  "exit_code": 137,
  "exit_reason": "error",
  "restart_policy": "never"
}

Response

Stop initiated

request_idstring required

Unique identifier of the deployment being stopped

messagestring required

Confirmation message

Example response

{
  "request_id": "c0653765de3b",
  "message": "stop initiated"
}

Changes

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