2.0 KiB
2.0 KiB
Return to top
Stop
========================================================================================
GET
/services/{uuid}/stop
Stop service. Post request is also accepted.
Authorizations
bearerAuth
Go to Keys & Tokens / API tokens and create a new token. Use the token as the bearer token.
Type
HTTP (bearer)
Parameters
Path Parameters
uuid*
UUID of the service.
Type
string
Required
Query Parameters
docker_cleanup
Perform docker cleanup (prune networks, volumes, etc.).
Type
boolean
Default
true
Responses
200400401404
Stop service.
Content-Type
application/json
SchemaJSON
JSON
{
"message": "Service stopping request queued."
}
GET
/services/{uuid}/stop
Playground
Authorization
bearerAuth
Variables
Key
Value
uuid*
docker_cleanup
Try it out
Samples
Powered by VitePress OpenAPI