Coolify logoCoolify
Cloud

Update service application

API server

https://app.coolify.io/api/v1

Choose where to send API requests

This changes the request URL and code examples on every endpoint page.

API server type

Requests will use

https://app.coolify.io/api/v1

Use only a Coolify URL you trust. Sending a test request also sends the API token you enter.

PATCH
/services/{uuid}/applications/{app_uuid}

Update fields for a compose service application. Use url for comma-separated public URLs (same rules as urls[].url on PATCH /services/{uuid}).

Authorization

bearerAuth
AuthorizationBearer <token>

Go to Keys & Tokens / API tokens and create a new token. Use the token as the bearer token.

In: header

Path Parameters

uuid*string

Service UUID.

app_uuid*string

Service application UUID.

Query Parameters

force_domain_override?boolean

When true, allow duplicate URLs in the request and proceed despite domain conflicts (same as service PATCH).

Defaultfalse

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

url?|

Comma-separated list of URLs (e.g. "http://app.example.com:8080,https://app2.example.com"). Stored as fqdn.

noindex_domains?array<string>|

The subset of the service application domains served with an X-Robots-Tag: noindex, nofollow response header, keeping them out of search engines. Entries that are not among the domains are ignored.

human_name?string|null
description?string|null
image?string|null
exclude_from_status?boolean|null
is_log_drain_enabled?boolean|null
is_gzip_enabled?boolean|null
traefik_certificate_resolver?|

Traefik certificate resolver for this service application. Null uses the server setting, "none" uses no resolver.

is_stripprefix_enabled?boolean|null
is_force_https_enabled?boolean|null
is_permanent_redirect_enabled?|

Use permanent redirects (301/308) instead of temporary (302/307) for the HTTP to HTTPS and www redirects. Defaults to false.

redirect?string

How to handle www and non-www domains. "www" redirects non-www to www, "non-www" redirects www to non-www. Both need a www and a non-www domain in url.

Value in"both" | "www" | "non-www"
max_restart_count?|

Maximum Docker restart count before Coolify stops the container. Set to 0 to disable the limit.

Range0 <= value

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://app.coolify.io/api/v1/services/string/applications/string" \  -H "Content-Type: application/json" \  -d '{}'
{}
{  "message": "Unauthenticated."}
{  "message": "Resource not found."}
Empty
{  "message": "Validation error.",  "errors": {    "name": [      "The name field is required."    ],    "api_url": [      "The api url field is required.",      "The api url format is invalid."    ]  }}

List service applications GET

List compose service applications (containers) for a single service.

Restart service application container POST

Restarts a single compose service container.