Coolify Octri Demo
PATCH/destinations/{uuid}

Update a destination

Updates the name of a Docker network destination. Supply name to change the destination name; you cannot change the network through this operation.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
uuidstringrequired
The UUID of the destination to update.

Destination fields to update. The network cannot be changed through this operation.

namestringoptional
The destination's new name, up to 255 characters.

4 status codes
200Returns the updated destination object, including its UUID, network, name, server UUID, type, and creation and update timestamps.
created_atstringoptional
namestringoptional
networkstringoptional
server_uuidstringoptional
typestringoptional
Allowed:standaloneswarm
updated_atstringoptional
uuidstringoptional
401Returned when the request is unauthenticated.
messagestringoptional
404Returned when the destination cannot be found.
messagestringoptional
422Returned when the destination update fails validation.
errorsobjectoptional
messagestringoptional

Error handling

A 401 is returned when the request is unauthenticated. A 404 is returned when the destination identified by the uuid path parameter is not found. A 422 is returned when validation fails; name can be no more than 255 characters.