Skip to content
Ona Docs

StopService

POST/gitpod.v1.EnvironmentAutomationService/StopService

Stops an automation service. This call does not block until the service is stopped. This call will not error if the service is already stopped or has been stopped.

Use this method to:

  • Pause service operations
  • Gracefully stop services
  • Prepare for updates

Examples

  • Stop service:

    Gracefully stops a running service.

    id: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
Body ParametersJSONExpand Collapse
id: optional string
formatuuid

StopService

curl https://app.gitpod.io/api/gitpod.v1.EnvironmentAutomationService/StopService \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $GITPOD_API_KEY" \
    -d '{}'
{}
Returns Examples
{}