Coolify Octri Demo
POST/servers/{server_uuid}/destinations

Create a server destination

Creates a Docker network destination on a server owned by the authenticated team. Supply a new network name; Docker's built-in networks and networks already present on a standalone server are not accepted. The proxy connects to the destination network.

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

1 parameter · 3 body fields
server_uuidstringrequired
The UUID of the server on which to create the destination.

Docker network destination details. network is required.

namestringoptional
A destination name, up to 255 characters.
networkstringrequired
Name of a new Docker network. Must not be bridge, host, none, or a network that already exists on the server.
typestringoptional
Destination type: `standalone` or `swarm`.
Allowed:standaloneswarm

5 status codes
201Returns the created 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 server cannot be found.
messagestringoptional
409Returned when a destination with the specified network already exists.
422Returned when validation fails, the network is reserved or already exists on the server, or the server cannot be checked.

Error handling

A 401 is returned when the request is unauthenticated. A 404 is returned when the server identified by the server_uuid path parameter is not found, and a 409 is returned when a destination with the same network already exists. A 422 is returned when validation fails, the network is reserved or already exists on the server, or the server cannot be checked; network must match the specified name pattern and be no more than 255 characters, and type must be standalone or swarm when provided.