96 lines
2.0 KiB
Markdown
96 lines
2.0 KiB
Markdown
[Skip to content](https://coolify.io/docs/api-reference/api/operations/cancel-deployment-by-uuid#VPContent)
|
||
|
||
Return to top
|
||
|
||
Cancel[](https://coolify.io/docs/api-reference/api/operations/cancel-deployment-by-uuid#cancel)
|
||
|
||
=================================================================================================
|
||
|
||
POST
|
||
|
||
/deployments/{uuid}/cancel
|
||
|
||
Cancel a deployment by UUID.
|
||
|
||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/cancel-deployment-by-uuid#authorizations)
|
||
|
||
-----------------------------------------------------------------------------------------------------------------
|
||
|
||
bearerAuth
|
||
|
||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||
|
||
Type
|
||
|
||
HTTP (bearer)
|
||
|
||
Parameters[](https://coolify.io/docs/api-reference/api/operations/cancel-deployment-by-uuid#parameters)
|
||
|
||
---------------------------------------------------------------------------------------------------------
|
||
|
||
### Path Parameters
|
||
|
||
uuid\*
|
||
|
||
Deployment UUID
|
||
|
||
Type
|
||
|
||
string
|
||
|
||
Required
|
||
|
||
Responses[](https://coolify.io/docs/api-reference/api/operations/cancel-deployment-by-uuid#responses)
|
||
|
||
-------------------------------------------------------------------------------------------------------
|
||
|
||
200400401403404
|
||
|
||
Deployment cancelled successfully.
|
||
|
||
Content-Type
|
||
|
||
application/json
|
||
|
||
SchemaJSON
|
||
|
||
JSON
|
||
|
||
{
|
||
|
||
"message": "Deployment cancelled successfully.",
|
||
|
||
"deployment\_uuid": "cm37r6cqj000008jm0veg5tkm",
|
||
|
||
"status": "cancelled-by-user"
|
||
|
||
}
|
||
|
||
POST
|
||
|
||
/deployments/{uuid}/cancel
|
||
|
||
Playground[](https://coolify.io/docs/api-reference/api/operations/cancel-deployment-by-uuid#playground)
|
||
|
||
---------------------------------------------------------------------------------------------------------
|
||
|
||
Authorization
|
||
|
||
bearerAuth
|
||
|
||
Variables
|
||
|
||
Key
|
||
|
||
Value
|
||
|
||
uuid\*
|
||
|
||
Try it out
|
||
|
||
Samples[](https://coolify.io/docs/api-reference/api/operations/cancel-deployment-by-uuid#samples)
|
||
|
||
---------------------------------------------------------------------------------------------------
|
||
|
||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|