Skip to main content

Coolify

@shrug/coolifyv2026.07.12.3· 19d agoMODELS
01README

Manage a Coolify instance over its REST API v1: list/get services (incl. docker_compose_raw) and applications, patch a service's compose, start/stop/restart applications, add persistent (named-volume) application storage, and trigger deploys/restarts. Mutations are audited, confirm-gated, and preceded by a live reachability pre-flight check.

02Models1
@shrug/coolifyv2026.07.12.3coolify.ts
fn listServices()
List all services on the Coolify instance.
fn getService(uuid: string)
Fetch one service by uuid and snapshot it, including its docker_compose_raw.
ArgumentTypeDescription
uuidstringService uuid
fn updateServiceCompose(uuid: string)
Replace a service's docker_compose_raw (base64-encoded on the wire) via PATCH. Gated behind confirm:true. Records an audit attempt on both paths.
ArgumentTypeDescription
uuidstringService uuid
fn deploy(uuid: string)
Trigger a (re)deploy of a service by uuid. Gated behind confirm:true. Records an audit attempt.
ArgumentTypeDescription
uuidstringService uuid to deploy
fn restartService(uuid: string)
Restart a service (optionally pulling latest images). Records an audit attempt.
ArgumentTypeDescription
uuidstringService uuid
fn listApplications()
List all applications on the Coolify instance.
fn getApplication(uuid: string)
Fetch one application by uuid and snapshot it.
ArgumentTypeDescription
uuidstringApplication uuid
fn controlApplication(uuid: string)
Start, stop, or restart an application by uuid. Gated behind confirm:true for all three actions (one predictable rule, even though `start` is arguably safe). Records an audit attempt on both paths. NOTE: to pick up a freshly built image, use `deploy` — there is no `?latest=` pull-latest param on the application restart endpoint (that exists only for services); `restart` recreates the app from its current image/build without pulling.
ArgumentTypeDescription
uuidstringApplication uuid
fn createApplicationStorage(uuid: string, name: string)
Add a persistent (named-volume) storage to an application so its data survives redeploys. POST /applications/{uuid}/storages. Gated behind confirm:true; records an audit attempt on both paths. Takes effect on the next deploy.
ArgumentTypeDescription
uuidstringApplication uuid
namestringStorage name (label in Coolify)

Resources

services(infinite)— Snapshot of all services on the instance
service(infinite)— Snapshot of one service, including its docker_compose_raw
applications(30d)— Snapshot of all applications on the instance
application(infinite)— Snapshot of one application
deployment(infinite)— Record of a triggered deploy
attempt(infinite)— Audit record of a mutation attempt (request + result/error + timestamp). Written on both success and failure.
03Previous Versions6
2026.07.12.2

v2026.07.12.2: getApplication captures the full Coolify application record verbatim (raw) plus curated fields incl. dockerImageTag/buildPack; listApplications summary gains dockerImageTag.

2026.07.12.1

v2026.07.12.1: application surface — listApplications, getApplication, controlApplication (start/stop/restart, confirm-gated, audited). deploy remains the app pull-latest path. Additive; services unchanged.

Modified 1 models

2026.07.11.4
2026.07.11.3
2026.07.11.2
2026.07.11.1
04Stats
A
100 / 100
Downloads
1
Archive size
14.0 KB
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License declared1/1earned
  • Verified public repository2/2earned
05Platforms
06Labels