1528 lines
50 KiB
JSON
1528 lines
50 KiB
JSON
{
|
|
"generated_at": "2026-04-15T21:32:31.984Z",
|
|
"total_endpoints": 107,
|
|
"categories": {
|
|
"Applications": [
|
|
{
|
|
"id": "create-dockercompose-application",
|
|
"method": "POST",
|
|
"path": "/applications/dockercompose",
|
|
"description": "Deprecated: Use POST /api/v1/services instead. application/json",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "create-dockerfile-application",
|
|
"method": "POST",
|
|
"path": "/applications/dockerfile",
|
|
"description": "Create new application based on a simple Dockerfile (without git). application/json",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "create-dockerimage-application",
|
|
"method": "POST",
|
|
"path": "/applications/dockerimage",
|
|
"description": "Create new application based on a prebuilt docker image (without git). application/json",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "create-env-by-application-uuid",
|
|
"method": "POST",
|
|
"path": "/applications/{uuid}/envs",
|
|
"description": "Create env by application UUID. UUID of the application.",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "create-private-deploy-key-application",
|
|
"method": "POST",
|
|
"path": "/applications/private-deploy-key",
|
|
"description": "Create new application based on a private repository through a Deploy Key. application/json",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "create-private-github-app-application",
|
|
"method": "POST",
|
|
"path": "/applications/private-github-app",
|
|
"description": "Create new application based on a private repository through a Github App. application/json",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "create-public-application",
|
|
"method": "POST",
|
|
"path": "/applications/public",
|
|
"description": "Create new application based on a public git repository. application/json",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "delete-application-by-uuid",
|
|
"method": "DELETE",
|
|
"path": "/applications/{uuid}",
|
|
"description": "Delete application by UUID. UUID of the application.",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "delete-env-by-application-uuid",
|
|
"method": "DELETE",
|
|
"path": "/applications/{uuid}/envs/{env\\_uuid}",
|
|
"description": "Delete env by UUID. UUID of the application.",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "get-application-by-uuid",
|
|
"method": "GET",
|
|
"path": "/applications/{uuid}",
|
|
"description": "Get application by UUID. UUID of the application.",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "get-application-logs-by-uuid",
|
|
"method": "GET",
|
|
"path": "/applications/{uuid}/logs",
|
|
"description": "Get application logs by UUID. UUID of the application.",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "list-applications",
|
|
"method": "GET",
|
|
"path": "/applications",
|
|
"description": "List all applications. Filter applications by tag name.",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "list-deployments-by-app-uuid",
|
|
"method": "GET",
|
|
"path": "/deployments/applications/{uuid}",
|
|
"description": "List application deployments by using the app uuid UUID of the application.",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "list-envs-by-application-uuid",
|
|
"method": "GET",
|
|
"path": "/applications/{uuid}/envs",
|
|
"description": "List all envs by application UUID. UUID of the application.",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "restart-application-by-uuid",
|
|
"method": "GET",
|
|
"path": "/applications/{uuid}/restart",
|
|
"description": "Restart application. `Post` request is also accepted. UUID of the application.",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "start-application-by-uuid",
|
|
"method": "GET",
|
|
"path": "/applications/{uuid}/start",
|
|
"description": "Start application. `Post` request is also accepted. UUID of the application.",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "stop-application-by-uuid",
|
|
"method": "GET",
|
|
"path": "/applications/{uuid}/stop",
|
|
"description": "Stop application. `Post` request is also accepted. UUID of the application.",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "update-application-by-uuid",
|
|
"method": "PATCH",
|
|
"path": "/applications/{uuid}",
|
|
"description": "Update application by UUID. UUID of the application.",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "update-env-by-application-uuid",
|
|
"method": "PATCH",
|
|
"path": "/applications/{uuid}/envs",
|
|
"description": "Update env by application UUID. UUID of the application.",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "update-envs-by-application-uuid",
|
|
"method": "PATCH",
|
|
"path": "/applications/{uuid}/envs/bulk",
|
|
"description": "Update multiple envs by application UUID. UUID of the application.",
|
|
"category": "Applications"
|
|
}
|
|
],
|
|
"Databases": [
|
|
{
|
|
"id": "create-database-backup",
|
|
"method": "POST",
|
|
"path": "/databases/{uuid}/backups",
|
|
"description": "Create a new scheduled backup configuration for a database UUID of the database.",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "create-database-clickhouse",
|
|
"method": "POST",
|
|
"path": "/databases/clickhouse",
|
|
"description": "Create a new Clickhouse database. application/json",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "create-database-dragonfly",
|
|
"method": "POST",
|
|
"path": "/databases/dragonfly",
|
|
"description": "Create a new DragonFly database. application/json",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "create-database-keydb",
|
|
"method": "POST",
|
|
"path": "/databases/keydb",
|
|
"description": "Create a new KeyDB database. application/json",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "create-database-mariadb",
|
|
"method": "POST",
|
|
"path": "/databases/mariadb",
|
|
"description": "Create a new MariaDB database. application/json",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "create-database-mongodb",
|
|
"method": "POST",
|
|
"path": "/databases/mongodb",
|
|
"description": "Create a new MongoDB database. application/json",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "create-database-mysql",
|
|
"method": "POST",
|
|
"path": "/databases/mysql",
|
|
"description": "Create a new MySQL database. application/json",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "create-database-postgresql",
|
|
"method": "POST",
|
|
"path": "/databases/postgresql",
|
|
"description": "Create a new PostgreSQL database. application/json",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "create-database-redis",
|
|
"method": "POST",
|
|
"path": "/databases/redis",
|
|
"description": "Create a new Redis database. application/json",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "delete-backup-configuration-by-uuid",
|
|
"method": "DELETE",
|
|
"path": "/databases/{uuid}/backups/{scheduled\\_backup\\_uuid}",
|
|
"description": "Deletes a backup configuration and all its executions. UUID of the database",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "delete-backup-execution-by-uuid",
|
|
"method": "DELETE",
|
|
"path": "/databases/{uuid}/backups/{scheduled\\_backup\\_uuid}/executions/{execution\\_uuid}",
|
|
"description": "Deletes a specific backup execution. UUID of the database",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "delete-database-by-uuid",
|
|
"method": "DELETE",
|
|
"path": "/databases/{uuid}",
|
|
"description": "Delete database by UUID. UUID of the database.",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "get-database-backups-by-uuid",
|
|
"method": "GET",
|
|
"path": "/databases/{uuid}/backups",
|
|
"description": "Get backups details by database UUID. UUID of the database.",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "get-database-by-uuid",
|
|
"method": "GET",
|
|
"path": "/databases/{uuid}",
|
|
"description": "Get database by UUID. UUID of the database.",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "list-backup-executions",
|
|
"method": "GET",
|
|
"path": "/databases/{uuid}/backups/{scheduled\\_backup\\_uuid}/executions",
|
|
"description": "Get all executions for a specific backup configuration. UUID of the database",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "list-databases",
|
|
"method": "GET",
|
|
"path": "/databases",
|
|
"description": "List all databases. Get all databases",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "restart-database-by-uuid",
|
|
"method": "GET",
|
|
"path": "/databases/{uuid}/restart",
|
|
"description": "Restart database. `Post` request is also accepted. UUID of the database.",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "start-database-by-uuid",
|
|
"method": "GET",
|
|
"path": "/databases/{uuid}/start",
|
|
"description": "Start database. `Post` request is also accepted. UUID of the database.",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "stop-database-by-uuid",
|
|
"method": "GET",
|
|
"path": "/databases/{uuid}/stop",
|
|
"description": "Stop database. `Post` request is also accepted. UUID of the database.",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "update-database-backup",
|
|
"method": "PATCH",
|
|
"path": "/databases/{uuid}/backups/{scheduled\\_backup\\_uuid}",
|
|
"description": "Update a specific backup configuration for a given database, identified by its UUID and the backup ID UUID of the database.",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "update-database-by-uuid",
|
|
"method": "PATCH",
|
|
"path": "/databases/{uuid}",
|
|
"description": "Update database by UUID. UUID of the database.",
|
|
"category": "Databases"
|
|
}
|
|
],
|
|
"Deployments": [
|
|
{
|
|
"id": "cancel-deployment-by-uuid",
|
|
"method": "POST",
|
|
"path": "/deployments/{uuid}/cancel",
|
|
"description": "Cancel a deployment by UUID. Deployment cancelled successfully.",
|
|
"category": "Deployments"
|
|
},
|
|
{
|
|
"id": "deploy-by-tag-or-uuid",
|
|
"method": "GET",
|
|
"path": "/deploy",
|
|
"description": "Deploy by tag or uuid. `Post` request also accepted with `uuid` and `tag` json body. Tag name(s). Comma separated list is also accepted.",
|
|
"category": "Deployments"
|
|
},
|
|
{
|
|
"id": "get-deployment-by-uuid",
|
|
"method": "GET",
|
|
"path": "/deployments/{uuid}",
|
|
"description": "Get deployment by UUID. Get deployment by UUID.",
|
|
"category": "Deployments"
|
|
},
|
|
{
|
|
"id": "list-deployments",
|
|
"method": "GET",
|
|
"path": "/deployments",
|
|
"description": "List currently running deployments Get all currently running deployments.",
|
|
"category": "Deployments"
|
|
}
|
|
],
|
|
"Environments": [
|
|
{
|
|
"id": "create-environment",
|
|
"method": "POST",
|
|
"path": "/projects/{uuid}/environments",
|
|
"description": "Create environment in project. application/json",
|
|
"category": "Environments"
|
|
},
|
|
{
|
|
"id": "delete-environment",
|
|
"method": "DELETE",
|
|
"path": "/projects/{uuid}/environments/{environment\\_name\\_or\\_uuid}",
|
|
"description": "Delete environment by name or UUID. Environment must be empty. environment\\_name\\_or\\_uuid\\*",
|
|
"category": "Environments"
|
|
},
|
|
{
|
|
"id": "get-environment-by-name-or-uuid",
|
|
"method": "GET",
|
|
"path": "/projects/{uuid}/{environment\\_name\\_or\\_uuid}",
|
|
"description": "Get environment by name or UUID. environment\\_name\\_or\\_uuid\\*",
|
|
"category": "Environments"
|
|
},
|
|
{
|
|
"id": "get-environments",
|
|
"method": "GET",
|
|
"path": "/projects/{uuid}/environments",
|
|
"description": "List all environments in a project. List of environments",
|
|
"category": "Environments"
|
|
}
|
|
],
|
|
"GitHub": [
|
|
{
|
|
"id": "create-github-app",
|
|
"method": "POST",
|
|
"path": "/github-apps",
|
|
"description": "Create a new GitHub app. application/json",
|
|
"category": "GitHub"
|
|
},
|
|
{
|
|
"id": "deleteGithubApp",
|
|
"method": "DELETE",
|
|
"path": "/github-apps/{github\\_app\\_id}",
|
|
"description": "Delete a GitHub app if it's not being used by any applications. github\\_app\\_id\\*",
|
|
"category": "GitHub"
|
|
},
|
|
{
|
|
"id": "list-github-apps",
|
|
"method": "GET",
|
|
"path": "/github-apps",
|
|
"description": "List all GitHub apps. List of GitHub apps.",
|
|
"category": "GitHub"
|
|
},
|
|
{
|
|
"id": "load-branches",
|
|
"method": "GET",
|
|
"path": "/github-apps/{github\\_app\\_id}/repositories/{owner}/{repo}/branches",
|
|
"description": "Fetch branches from GitHub for a given repository. github\\_app\\_id\\*",
|
|
"category": "GitHub"
|
|
},
|
|
{
|
|
"id": "load-repositories",
|
|
"method": "GET",
|
|
"path": "/github-apps/{github\\_app\\_id}/repositories",
|
|
"description": "Fetch repositories from GitHub for a given GitHub app. github\\_app\\_id\\*",
|
|
"category": "GitHub"
|
|
},
|
|
{
|
|
"id": "updateGithubApp",
|
|
"method": "PATCH",
|
|
"path": "/github-apps/{github\\_app\\_id}",
|
|
"description": "Update an existing GitHub app. github\\_app\\_id\\*",
|
|
"category": "GitHub"
|
|
}
|
|
],
|
|
"Other": [
|
|
{
|
|
"id": "healthcheck",
|
|
"method": "GET",
|
|
"path": "/health",
|
|
"description": "Healthcheck endpoint. Healthcheck endpoint.",
|
|
"category": "Other"
|
|
},
|
|
{
|
|
"id": "version",
|
|
"method": "GET",
|
|
"path": "/version",
|
|
"description": "Get Coolify version. Returns the version of the application",
|
|
"category": "Other"
|
|
}
|
|
],
|
|
"Projects": [
|
|
{
|
|
"id": "create-project",
|
|
"method": "POST",
|
|
"path": "/projects",
|
|
"description": "application/json \"name\": \"string\",",
|
|
"category": "Projects"
|
|
},
|
|
{
|
|
"id": "delete-project-by-uuid",
|
|
"method": "DELETE",
|
|
"path": "/projects/{uuid}",
|
|
"description": "Delete project by UUID. UUID of the application.",
|
|
"category": "Projects"
|
|
},
|
|
{
|
|
"id": "get-project-by-uuid",
|
|
"method": "GET",
|
|
"path": "/projects/{uuid}",
|
|
"description": "Get project by UUID. application/json",
|
|
"category": "Projects"
|
|
},
|
|
{
|
|
"id": "list-projects",
|
|
"method": "GET",
|
|
"path": "/projects",
|
|
"description": "Get all projects. application/json",
|
|
"category": "Projects"
|
|
},
|
|
{
|
|
"id": "update-project-by-uuid",
|
|
"method": "PATCH",
|
|
"path": "/projects/{uuid}",
|
|
"description": "UUID of the project. application/json",
|
|
"category": "Projects"
|
|
}
|
|
],
|
|
"Security": [
|
|
{
|
|
"id": "create-cloud-token",
|
|
"method": "POST",
|
|
"path": "/cloud-tokens",
|
|
"description": "Create a new cloud provider token. The token will be validated before being stored. application/json",
|
|
"category": "Security"
|
|
},
|
|
{
|
|
"id": "create-private-key",
|
|
"method": "POST",
|
|
"path": "/security/keys",
|
|
"description": "Create a new private key. application/json",
|
|
"category": "Security"
|
|
},
|
|
{
|
|
"id": "delete-cloud-token-by-uuid",
|
|
"method": "DELETE",
|
|
"path": "/cloud-tokens/{uuid}",
|
|
"description": "Delete cloud provider token by UUID. Cannot delete if token is used by any servers. UUID of the cloud provider token.",
|
|
"category": "Security"
|
|
},
|
|
{
|
|
"id": "delete-private-key-by-uuid",
|
|
"method": "DELETE",
|
|
"path": "/security/keys/{uuid}",
|
|
"description": "Delete a private key. Private Key UUID",
|
|
"category": "Security"
|
|
},
|
|
{
|
|
"id": "disable-api",
|
|
"method": "GET",
|
|
"path": "/disable",
|
|
"description": "Disable API (only with root permissions). application/json",
|
|
"category": "Security"
|
|
},
|
|
{
|
|
"id": "enable-api",
|
|
"method": "GET",
|
|
"path": "/enable",
|
|
"description": "Enable API (only with root permissions). application/json",
|
|
"category": "Security"
|
|
},
|
|
{
|
|
"id": "get-cloud-token-by-uuid",
|
|
"method": "GET",
|
|
"path": "/cloud-tokens/{uuid}",
|
|
"description": "Get cloud provider token by UUID. Get cloud provider token by UUID",
|
|
"category": "Security"
|
|
},
|
|
{
|
|
"id": "get-private-key-by-uuid",
|
|
"method": "GET",
|
|
"path": "/security/keys/{uuid}",
|
|
"description": "Get key by UUID. Private Key UUID",
|
|
"category": "Security"
|
|
},
|
|
{
|
|
"id": "list-cloud-tokens",
|
|
"method": "GET",
|
|
"path": "/cloud-tokens",
|
|
"description": "List all cloud provider tokens for the authenticated team. Get all cloud provider tokens.",
|
|
"category": "Security"
|
|
},
|
|
{
|
|
"id": "list-private-keys",
|
|
"method": "GET",
|
|
"path": "/security/keys",
|
|
"description": "List all private keys. Get all private keys.",
|
|
"category": "Security"
|
|
},
|
|
{
|
|
"id": "update-cloud-token-by-uuid",
|
|
"method": "PATCH",
|
|
"path": "/cloud-tokens/{uuid}",
|
|
"description": "Update cloud provider token name. application/json",
|
|
"category": "Security"
|
|
},
|
|
{
|
|
"id": "update-private-key",
|
|
"method": "PATCH",
|
|
"path": "/security/keys",
|
|
"description": "Update a private key. application/json",
|
|
"category": "Security"
|
|
},
|
|
{
|
|
"id": "validate-cloud-token-by-uuid",
|
|
"method": "POST",
|
|
"path": "/cloud-tokens/{uuid}/validate",
|
|
"description": "Validate a cloud provider token against the provider API. Token validation result.",
|
|
"category": "Security"
|
|
}
|
|
],
|
|
"Servers": [
|
|
{
|
|
"id": "create-hetzner-server",
|
|
"method": "POST",
|
|
"path": "/servers/hetzner",
|
|
"description": "Create a new server on Hetzner and register it in Coolify. application/json",
|
|
"category": "Servers"
|
|
},
|
|
{
|
|
"id": "create-server",
|
|
"method": "POST",
|
|
"path": "/servers",
|
|
"description": "application/json \"name\": \"My Server\",",
|
|
"category": "Servers"
|
|
},
|
|
{
|
|
"id": "delete-server-by-uuid",
|
|
"method": "DELETE",
|
|
"path": "/servers/{uuid}",
|
|
"description": "Delete server by UUID. UUID of the server.",
|
|
"category": "Servers"
|
|
},
|
|
{
|
|
"id": "get-domains-by-server-uuid",
|
|
"method": "GET",
|
|
"path": "/servers/{uuid}/domains",
|
|
"description": "Get domains by server. Get domains by server",
|
|
"category": "Servers"
|
|
},
|
|
{
|
|
"id": "get-hetzner-images",
|
|
"method": "GET",
|
|
"path": "/hetzner/images",
|
|
"description": "Get all available Hetzner system images (operating systems). cloud\\_provider\\_token\\_uuid",
|
|
"category": "Servers"
|
|
},
|
|
{
|
|
"id": "get-hetzner-locations",
|
|
"method": "GET",
|
|
"path": "/hetzner/locations",
|
|
"description": "Get all available Hetzner datacenter locations. cloud\\_provider\\_token\\_uuid",
|
|
"category": "Servers"
|
|
},
|
|
{
|
|
"id": "get-hetzner-server-types",
|
|
"method": "GET",
|
|
"path": "/hetzner/server-types",
|
|
"description": "Get all available Hetzner server types (instance sizes). cloud\\_provider\\_token\\_uuid",
|
|
"category": "Servers"
|
|
},
|
|
{
|
|
"id": "get-hetzner-ssh-keys",
|
|
"method": "GET",
|
|
"path": "/hetzner/ssh-keys",
|
|
"description": "Get all SSH keys stored in the Hetzner account. cloud\\_provider\\_token\\_uuid",
|
|
"category": "Servers"
|
|
},
|
|
{
|
|
"id": "get-resources-by-server-uuid",
|
|
"method": "GET",
|
|
"path": "/servers/{uuid}/resources",
|
|
"description": "Get resources by server. Get resources by server",
|
|
"category": "Servers"
|
|
},
|
|
{
|
|
"id": "get-server-by-uuid",
|
|
"method": "GET",
|
|
"path": "/servers/{uuid}",
|
|
"description": "Get server by UUID. Get server by UUID",
|
|
"category": "Servers"
|
|
},
|
|
{
|
|
"id": "list-resources",
|
|
"method": "GET",
|
|
"path": "/resources",
|
|
"description": "Get all resources. Get all resources",
|
|
"category": "Servers"
|
|
},
|
|
{
|
|
"id": "list-servers",
|
|
"method": "GET",
|
|
"path": "/servers",
|
|
"description": "List all servers. Get all servers.",
|
|
"category": "Servers"
|
|
},
|
|
{
|
|
"id": "update-server-by-uuid",
|
|
"method": "PATCH",
|
|
"path": "/servers/{uuid}",
|
|
"description": "application/json \"name\": \"string\",",
|
|
"category": "Servers"
|
|
},
|
|
{
|
|
"id": "validate-server-by-uuid",
|
|
"method": "GET",
|
|
"path": "/servers/{uuid}/validate",
|
|
"description": "Validate server by UUID. Server validation started.",
|
|
"category": "Servers"
|
|
}
|
|
],
|
|
"Services": [
|
|
{
|
|
"id": "create-env-by-service-uuid",
|
|
"method": "POST",
|
|
"path": "/services/{uuid}/envs",
|
|
"description": "Create env by service UUID. UUID of the service.",
|
|
"category": "Services"
|
|
},
|
|
{
|
|
"id": "create-service",
|
|
"method": "POST",
|
|
"path": "/services",
|
|
"description": "Create a one-click / custom service application/json",
|
|
"category": "Services"
|
|
},
|
|
{
|
|
"id": "delete-env-by-service-uuid",
|
|
"method": "DELETE",
|
|
"path": "/services/{uuid}/envs/{env\\_uuid}",
|
|
"description": "Delete env by UUID. UUID of the service.",
|
|
"category": "Services"
|
|
},
|
|
{
|
|
"id": "delete-service-by-uuid",
|
|
"method": "DELETE",
|
|
"path": "/services/{uuid}",
|
|
"description": "Delete service by UUID. delete\\_configurations",
|
|
"category": "Services"
|
|
},
|
|
{
|
|
"id": "get-service-by-uuid",
|
|
"method": "GET",
|
|
"path": "/services/{uuid}",
|
|
"description": "Get service by UUID. Get a service by UUID.",
|
|
"category": "Services"
|
|
},
|
|
{
|
|
"id": "list-envs-by-service-uuid",
|
|
"method": "GET",
|
|
"path": "/services/{uuid}/envs",
|
|
"description": "List all envs by service UUID. UUID of the service.",
|
|
"category": "Services"
|
|
},
|
|
{
|
|
"id": "list-services",
|
|
"method": "GET",
|
|
"path": "/services",
|
|
"description": "List all services. Get all services",
|
|
"category": "Services"
|
|
},
|
|
{
|
|
"id": "restart-service-by-uuid",
|
|
"method": "GET",
|
|
"path": "/services/{uuid}/restart",
|
|
"description": "Restart service. `Post` request is also accepted. UUID of the service.",
|
|
"category": "Services"
|
|
},
|
|
{
|
|
"id": "start-service-by-uuid",
|
|
"method": "GET",
|
|
"path": "/services/{uuid}/start",
|
|
"description": "Start service. `Post` request is also accepted. UUID of the service.",
|
|
"category": "Services"
|
|
},
|
|
{
|
|
"id": "stop-service-by-uuid",
|
|
"method": "GET",
|
|
"path": "/services/{uuid}/stop",
|
|
"description": "Stop service. `Post` request is also accepted. UUID of the service.",
|
|
"category": "Services"
|
|
},
|
|
{
|
|
"id": "update-env-by-service-uuid",
|
|
"method": "PATCH",
|
|
"path": "/services/{uuid}/envs",
|
|
"description": "Update env by service UUID. UUID of the service.",
|
|
"category": "Services"
|
|
},
|
|
{
|
|
"id": "update-envs-by-service-uuid",
|
|
"method": "PATCH",
|
|
"path": "/services/{uuid}/envs/bulk",
|
|
"description": "Update multiple envs by service UUID. UUID of the service.",
|
|
"category": "Services"
|
|
},
|
|
{
|
|
"id": "update-service-by-uuid",
|
|
"method": "PATCH",
|
|
"path": "/services/{uuid}",
|
|
"description": "Update service by UUID. UUID of the service.",
|
|
"category": "Services"
|
|
}
|
|
],
|
|
"Teams": [
|
|
{
|
|
"id": "get-current-team-members",
|
|
"method": "GET",
|
|
"path": "/teams/current/members",
|
|
"description": "Get currently authenticated team members. Currently authenticated team members.",
|
|
"category": "Teams"
|
|
},
|
|
{
|
|
"id": "get-current-team",
|
|
"method": "GET",
|
|
"path": "/teams/current",
|
|
"description": "Get currently authenticated team. application/json",
|
|
"category": "Teams"
|
|
},
|
|
{
|
|
"id": "get-members-by-team-id",
|
|
"method": "GET",
|
|
"path": "/teams/{id}/members",
|
|
"description": "Get members by TeamId. List of members.",
|
|
"category": "Teams"
|
|
},
|
|
{
|
|
"id": "get-team-by-id",
|
|
"method": "GET",
|
|
"path": "/teams/{id}",
|
|
"description": "Get team by TeamId. application/json",
|
|
"category": "Teams"
|
|
},
|
|
{
|
|
"id": "list-teams",
|
|
"method": "GET",
|
|
"path": "/teams",
|
|
"description": "application/json \"name\": \"string\",\\",
|
|
"category": "Teams"
|
|
}
|
|
]
|
|
},
|
|
"endpoints": [
|
|
{
|
|
"id": "cancel-deployment-by-uuid",
|
|
"method": "POST",
|
|
"path": "/deployments/{uuid}/cancel",
|
|
"description": "Cancel a deployment by UUID. Deployment cancelled successfully.",
|
|
"category": "Deployments"
|
|
},
|
|
{
|
|
"id": "create-cloud-token",
|
|
"method": "POST",
|
|
"path": "/cloud-tokens",
|
|
"description": "Create a new cloud provider token. The token will be validated before being stored. application/json",
|
|
"category": "Security"
|
|
},
|
|
{
|
|
"id": "create-database-backup",
|
|
"method": "POST",
|
|
"path": "/databases/{uuid}/backups",
|
|
"description": "Create a new scheduled backup configuration for a database UUID of the database.",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "create-database-clickhouse",
|
|
"method": "POST",
|
|
"path": "/databases/clickhouse",
|
|
"description": "Create a new Clickhouse database. application/json",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "create-database-dragonfly",
|
|
"method": "POST",
|
|
"path": "/databases/dragonfly",
|
|
"description": "Create a new DragonFly database. application/json",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "create-database-keydb",
|
|
"method": "POST",
|
|
"path": "/databases/keydb",
|
|
"description": "Create a new KeyDB database. application/json",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "create-database-mariadb",
|
|
"method": "POST",
|
|
"path": "/databases/mariadb",
|
|
"description": "Create a new MariaDB database. application/json",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "create-database-mongodb",
|
|
"method": "POST",
|
|
"path": "/databases/mongodb",
|
|
"description": "Create a new MongoDB database. application/json",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "create-database-mysql",
|
|
"method": "POST",
|
|
"path": "/databases/mysql",
|
|
"description": "Create a new MySQL database. application/json",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "create-database-postgresql",
|
|
"method": "POST",
|
|
"path": "/databases/postgresql",
|
|
"description": "Create a new PostgreSQL database. application/json",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "create-database-redis",
|
|
"method": "POST",
|
|
"path": "/databases/redis",
|
|
"description": "Create a new Redis database. application/json",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "create-dockercompose-application",
|
|
"method": "POST",
|
|
"path": "/applications/dockercompose",
|
|
"description": "Deprecated: Use POST /api/v1/services instead. application/json",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "create-dockerfile-application",
|
|
"method": "POST",
|
|
"path": "/applications/dockerfile",
|
|
"description": "Create new application based on a simple Dockerfile (without git). application/json",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "create-dockerimage-application",
|
|
"method": "POST",
|
|
"path": "/applications/dockerimage",
|
|
"description": "Create new application based on a prebuilt docker image (without git). application/json",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "create-env-by-application-uuid",
|
|
"method": "POST",
|
|
"path": "/applications/{uuid}/envs",
|
|
"description": "Create env by application UUID. UUID of the application.",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "create-env-by-service-uuid",
|
|
"method": "POST",
|
|
"path": "/services/{uuid}/envs",
|
|
"description": "Create env by service UUID. UUID of the service.",
|
|
"category": "Services"
|
|
},
|
|
{
|
|
"id": "create-environment",
|
|
"method": "POST",
|
|
"path": "/projects/{uuid}/environments",
|
|
"description": "Create environment in project. application/json",
|
|
"category": "Environments"
|
|
},
|
|
{
|
|
"id": "create-github-app",
|
|
"method": "POST",
|
|
"path": "/github-apps",
|
|
"description": "Create a new GitHub app. application/json",
|
|
"category": "GitHub"
|
|
},
|
|
{
|
|
"id": "create-hetzner-server",
|
|
"method": "POST",
|
|
"path": "/servers/hetzner",
|
|
"description": "Create a new server on Hetzner and register it in Coolify. application/json",
|
|
"category": "Servers"
|
|
},
|
|
{
|
|
"id": "create-private-deploy-key-application",
|
|
"method": "POST",
|
|
"path": "/applications/private-deploy-key",
|
|
"description": "Create new application based on a private repository through a Deploy Key. application/json",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "create-private-github-app-application",
|
|
"method": "POST",
|
|
"path": "/applications/private-github-app",
|
|
"description": "Create new application based on a private repository through a Github App. application/json",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "create-private-key",
|
|
"method": "POST",
|
|
"path": "/security/keys",
|
|
"description": "Create a new private key. application/json",
|
|
"category": "Security"
|
|
},
|
|
{
|
|
"id": "create-project",
|
|
"method": "POST",
|
|
"path": "/projects",
|
|
"description": "application/json \"name\": \"string\",",
|
|
"category": "Projects"
|
|
},
|
|
{
|
|
"id": "create-public-application",
|
|
"method": "POST",
|
|
"path": "/applications/public",
|
|
"description": "Create new application based on a public git repository. application/json",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "create-server",
|
|
"method": "POST",
|
|
"path": "/servers",
|
|
"description": "application/json \"name\": \"My Server\",",
|
|
"category": "Servers"
|
|
},
|
|
{
|
|
"id": "create-service",
|
|
"method": "POST",
|
|
"path": "/services",
|
|
"description": "Create a one-click / custom service application/json",
|
|
"category": "Services"
|
|
},
|
|
{
|
|
"id": "delete-application-by-uuid",
|
|
"method": "DELETE",
|
|
"path": "/applications/{uuid}",
|
|
"description": "Delete application by UUID. UUID of the application.",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "delete-backup-configuration-by-uuid",
|
|
"method": "DELETE",
|
|
"path": "/databases/{uuid}/backups/{scheduled\\_backup\\_uuid}",
|
|
"description": "Deletes a backup configuration and all its executions. UUID of the database",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "delete-backup-execution-by-uuid",
|
|
"method": "DELETE",
|
|
"path": "/databases/{uuid}/backups/{scheduled\\_backup\\_uuid}/executions/{execution\\_uuid}",
|
|
"description": "Deletes a specific backup execution. UUID of the database",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "delete-cloud-token-by-uuid",
|
|
"method": "DELETE",
|
|
"path": "/cloud-tokens/{uuid}",
|
|
"description": "Delete cloud provider token by UUID. Cannot delete if token is used by any servers. UUID of the cloud provider token.",
|
|
"category": "Security"
|
|
},
|
|
{
|
|
"id": "delete-database-by-uuid",
|
|
"method": "DELETE",
|
|
"path": "/databases/{uuid}",
|
|
"description": "Delete database by UUID. UUID of the database.",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "delete-env-by-application-uuid",
|
|
"method": "DELETE",
|
|
"path": "/applications/{uuid}/envs/{env\\_uuid}",
|
|
"description": "Delete env by UUID. UUID of the application.",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "delete-env-by-service-uuid",
|
|
"method": "DELETE",
|
|
"path": "/services/{uuid}/envs/{env\\_uuid}",
|
|
"description": "Delete env by UUID. UUID of the service.",
|
|
"category": "Services"
|
|
},
|
|
{
|
|
"id": "delete-environment",
|
|
"method": "DELETE",
|
|
"path": "/projects/{uuid}/environments/{environment\\_name\\_or\\_uuid}",
|
|
"description": "Delete environment by name or UUID. Environment must be empty. environment\\_name\\_or\\_uuid\\*",
|
|
"category": "Environments"
|
|
},
|
|
{
|
|
"id": "delete-private-key-by-uuid",
|
|
"method": "DELETE",
|
|
"path": "/security/keys/{uuid}",
|
|
"description": "Delete a private key. Private Key UUID",
|
|
"category": "Security"
|
|
},
|
|
{
|
|
"id": "delete-project-by-uuid",
|
|
"method": "DELETE",
|
|
"path": "/projects/{uuid}",
|
|
"description": "Delete project by UUID. UUID of the application.",
|
|
"category": "Projects"
|
|
},
|
|
{
|
|
"id": "delete-server-by-uuid",
|
|
"method": "DELETE",
|
|
"path": "/servers/{uuid}",
|
|
"description": "Delete server by UUID. UUID of the server.",
|
|
"category": "Servers"
|
|
},
|
|
{
|
|
"id": "delete-service-by-uuid",
|
|
"method": "DELETE",
|
|
"path": "/services/{uuid}",
|
|
"description": "Delete service by UUID. delete\\_configurations",
|
|
"category": "Services"
|
|
},
|
|
{
|
|
"id": "deleteGithubApp",
|
|
"method": "DELETE",
|
|
"path": "/github-apps/{github\\_app\\_id}",
|
|
"description": "Delete a GitHub app if it's not being used by any applications. github\\_app\\_id\\*",
|
|
"category": "GitHub"
|
|
},
|
|
{
|
|
"id": "deploy-by-tag-or-uuid",
|
|
"method": "GET",
|
|
"path": "/deploy",
|
|
"description": "Deploy by tag or uuid. `Post` request also accepted with `uuid` and `tag` json body. Tag name(s). Comma separated list is also accepted.",
|
|
"category": "Deployments"
|
|
},
|
|
{
|
|
"id": "disable-api",
|
|
"method": "GET",
|
|
"path": "/disable",
|
|
"description": "Disable API (only with root permissions). application/json",
|
|
"category": "Security"
|
|
},
|
|
{
|
|
"id": "enable-api",
|
|
"method": "GET",
|
|
"path": "/enable",
|
|
"description": "Enable API (only with root permissions). application/json",
|
|
"category": "Security"
|
|
},
|
|
{
|
|
"id": "get-application-by-uuid",
|
|
"method": "GET",
|
|
"path": "/applications/{uuid}",
|
|
"description": "Get application by UUID. UUID of the application.",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "get-application-logs-by-uuid",
|
|
"method": "GET",
|
|
"path": "/applications/{uuid}/logs",
|
|
"description": "Get application logs by UUID. UUID of the application.",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "get-cloud-token-by-uuid",
|
|
"method": "GET",
|
|
"path": "/cloud-tokens/{uuid}",
|
|
"description": "Get cloud provider token by UUID. Get cloud provider token by UUID",
|
|
"category": "Security"
|
|
},
|
|
{
|
|
"id": "get-current-team-members",
|
|
"method": "GET",
|
|
"path": "/teams/current/members",
|
|
"description": "Get currently authenticated team members. Currently authenticated team members.",
|
|
"category": "Teams"
|
|
},
|
|
{
|
|
"id": "get-current-team",
|
|
"method": "GET",
|
|
"path": "/teams/current",
|
|
"description": "Get currently authenticated team. application/json",
|
|
"category": "Teams"
|
|
},
|
|
{
|
|
"id": "get-database-backups-by-uuid",
|
|
"method": "GET",
|
|
"path": "/databases/{uuid}/backups",
|
|
"description": "Get backups details by database UUID. UUID of the database.",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "get-database-by-uuid",
|
|
"method": "GET",
|
|
"path": "/databases/{uuid}",
|
|
"description": "Get database by UUID. UUID of the database.",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "get-deployment-by-uuid",
|
|
"method": "GET",
|
|
"path": "/deployments/{uuid}",
|
|
"description": "Get deployment by UUID. Get deployment by UUID.",
|
|
"category": "Deployments"
|
|
},
|
|
{
|
|
"id": "get-domains-by-server-uuid",
|
|
"method": "GET",
|
|
"path": "/servers/{uuid}/domains",
|
|
"description": "Get domains by server. Get domains by server",
|
|
"category": "Servers"
|
|
},
|
|
{
|
|
"id": "get-environment-by-name-or-uuid",
|
|
"method": "GET",
|
|
"path": "/projects/{uuid}/{environment\\_name\\_or\\_uuid}",
|
|
"description": "Get environment by name or UUID. environment\\_name\\_or\\_uuid\\*",
|
|
"category": "Environments"
|
|
},
|
|
{
|
|
"id": "get-environments",
|
|
"method": "GET",
|
|
"path": "/projects/{uuid}/environments",
|
|
"description": "List all environments in a project. List of environments",
|
|
"category": "Environments"
|
|
},
|
|
{
|
|
"id": "get-hetzner-images",
|
|
"method": "GET",
|
|
"path": "/hetzner/images",
|
|
"description": "Get all available Hetzner system images (operating systems). cloud\\_provider\\_token\\_uuid",
|
|
"category": "Servers"
|
|
},
|
|
{
|
|
"id": "get-hetzner-locations",
|
|
"method": "GET",
|
|
"path": "/hetzner/locations",
|
|
"description": "Get all available Hetzner datacenter locations. cloud\\_provider\\_token\\_uuid",
|
|
"category": "Servers"
|
|
},
|
|
{
|
|
"id": "get-hetzner-server-types",
|
|
"method": "GET",
|
|
"path": "/hetzner/server-types",
|
|
"description": "Get all available Hetzner server types (instance sizes). cloud\\_provider\\_token\\_uuid",
|
|
"category": "Servers"
|
|
},
|
|
{
|
|
"id": "get-hetzner-ssh-keys",
|
|
"method": "GET",
|
|
"path": "/hetzner/ssh-keys",
|
|
"description": "Get all SSH keys stored in the Hetzner account. cloud\\_provider\\_token\\_uuid",
|
|
"category": "Servers"
|
|
},
|
|
{
|
|
"id": "get-members-by-team-id",
|
|
"method": "GET",
|
|
"path": "/teams/{id}/members",
|
|
"description": "Get members by TeamId. List of members.",
|
|
"category": "Teams"
|
|
},
|
|
{
|
|
"id": "get-private-key-by-uuid",
|
|
"method": "GET",
|
|
"path": "/security/keys/{uuid}",
|
|
"description": "Get key by UUID. Private Key UUID",
|
|
"category": "Security"
|
|
},
|
|
{
|
|
"id": "get-project-by-uuid",
|
|
"method": "GET",
|
|
"path": "/projects/{uuid}",
|
|
"description": "Get project by UUID. application/json",
|
|
"category": "Projects"
|
|
},
|
|
{
|
|
"id": "get-resources-by-server-uuid",
|
|
"method": "GET",
|
|
"path": "/servers/{uuid}/resources",
|
|
"description": "Get resources by server. Get resources by server",
|
|
"category": "Servers"
|
|
},
|
|
{
|
|
"id": "get-server-by-uuid",
|
|
"method": "GET",
|
|
"path": "/servers/{uuid}",
|
|
"description": "Get server by UUID. Get server by UUID",
|
|
"category": "Servers"
|
|
},
|
|
{
|
|
"id": "get-service-by-uuid",
|
|
"method": "GET",
|
|
"path": "/services/{uuid}",
|
|
"description": "Get service by UUID. Get a service by UUID.",
|
|
"category": "Services"
|
|
},
|
|
{
|
|
"id": "get-team-by-id",
|
|
"method": "GET",
|
|
"path": "/teams/{id}",
|
|
"description": "Get team by TeamId. application/json",
|
|
"category": "Teams"
|
|
},
|
|
{
|
|
"id": "healthcheck",
|
|
"method": "GET",
|
|
"path": "/health",
|
|
"description": "Healthcheck endpoint. Healthcheck endpoint.",
|
|
"category": "Other"
|
|
},
|
|
{
|
|
"id": "list-applications",
|
|
"method": "GET",
|
|
"path": "/applications",
|
|
"description": "List all applications. Filter applications by tag name.",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "list-backup-executions",
|
|
"method": "GET",
|
|
"path": "/databases/{uuid}/backups/{scheduled\\_backup\\_uuid}/executions",
|
|
"description": "Get all executions for a specific backup configuration. UUID of the database",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "list-cloud-tokens",
|
|
"method": "GET",
|
|
"path": "/cloud-tokens",
|
|
"description": "List all cloud provider tokens for the authenticated team. Get all cloud provider tokens.",
|
|
"category": "Security"
|
|
},
|
|
{
|
|
"id": "list-databases",
|
|
"method": "GET",
|
|
"path": "/databases",
|
|
"description": "List all databases. Get all databases",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "list-deployments-by-app-uuid",
|
|
"method": "GET",
|
|
"path": "/deployments/applications/{uuid}",
|
|
"description": "List application deployments by using the app uuid UUID of the application.",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "list-deployments",
|
|
"method": "GET",
|
|
"path": "/deployments",
|
|
"description": "List currently running deployments Get all currently running deployments.",
|
|
"category": "Deployments"
|
|
},
|
|
{
|
|
"id": "list-envs-by-application-uuid",
|
|
"method": "GET",
|
|
"path": "/applications/{uuid}/envs",
|
|
"description": "List all envs by application UUID. UUID of the application.",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "list-envs-by-service-uuid",
|
|
"method": "GET",
|
|
"path": "/services/{uuid}/envs",
|
|
"description": "List all envs by service UUID. UUID of the service.",
|
|
"category": "Services"
|
|
},
|
|
{
|
|
"id": "list-github-apps",
|
|
"method": "GET",
|
|
"path": "/github-apps",
|
|
"description": "List all GitHub apps. List of GitHub apps.",
|
|
"category": "GitHub"
|
|
},
|
|
{
|
|
"id": "list-private-keys",
|
|
"method": "GET",
|
|
"path": "/security/keys",
|
|
"description": "List all private keys. Get all private keys.",
|
|
"category": "Security"
|
|
},
|
|
{
|
|
"id": "list-projects",
|
|
"method": "GET",
|
|
"path": "/projects",
|
|
"description": "Get all projects. application/json",
|
|
"category": "Projects"
|
|
},
|
|
{
|
|
"id": "list-resources",
|
|
"method": "GET",
|
|
"path": "/resources",
|
|
"description": "Get all resources. Get all resources",
|
|
"category": "Servers"
|
|
},
|
|
{
|
|
"id": "list-servers",
|
|
"method": "GET",
|
|
"path": "/servers",
|
|
"description": "List all servers. Get all servers.",
|
|
"category": "Servers"
|
|
},
|
|
{
|
|
"id": "list-services",
|
|
"method": "GET",
|
|
"path": "/services",
|
|
"description": "List all services. Get all services",
|
|
"category": "Services"
|
|
},
|
|
{
|
|
"id": "list-teams",
|
|
"method": "GET",
|
|
"path": "/teams",
|
|
"description": "application/json \"name\": \"string\",\\",
|
|
"category": "Teams"
|
|
},
|
|
{
|
|
"id": "load-branches",
|
|
"method": "GET",
|
|
"path": "/github-apps/{github\\_app\\_id}/repositories/{owner}/{repo}/branches",
|
|
"description": "Fetch branches from GitHub for a given repository. github\\_app\\_id\\*",
|
|
"category": "GitHub"
|
|
},
|
|
{
|
|
"id": "load-repositories",
|
|
"method": "GET",
|
|
"path": "/github-apps/{github\\_app\\_id}/repositories",
|
|
"description": "Fetch repositories from GitHub for a given GitHub app. github\\_app\\_id\\*",
|
|
"category": "GitHub"
|
|
},
|
|
{
|
|
"id": "restart-application-by-uuid",
|
|
"method": "GET",
|
|
"path": "/applications/{uuid}/restart",
|
|
"description": "Restart application. `Post` request is also accepted. UUID of the application.",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "restart-database-by-uuid",
|
|
"method": "GET",
|
|
"path": "/databases/{uuid}/restart",
|
|
"description": "Restart database. `Post` request is also accepted. UUID of the database.",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "restart-service-by-uuid",
|
|
"method": "GET",
|
|
"path": "/services/{uuid}/restart",
|
|
"description": "Restart service. `Post` request is also accepted. UUID of the service.",
|
|
"category": "Services"
|
|
},
|
|
{
|
|
"id": "start-application-by-uuid",
|
|
"method": "GET",
|
|
"path": "/applications/{uuid}/start",
|
|
"description": "Start application. `Post` request is also accepted. UUID of the application.",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "start-database-by-uuid",
|
|
"method": "GET",
|
|
"path": "/databases/{uuid}/start",
|
|
"description": "Start database. `Post` request is also accepted. UUID of the database.",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "start-service-by-uuid",
|
|
"method": "GET",
|
|
"path": "/services/{uuid}/start",
|
|
"description": "Start service. `Post` request is also accepted. UUID of the service.",
|
|
"category": "Services"
|
|
},
|
|
{
|
|
"id": "stop-application-by-uuid",
|
|
"method": "GET",
|
|
"path": "/applications/{uuid}/stop",
|
|
"description": "Stop application. `Post` request is also accepted. UUID of the application.",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "stop-database-by-uuid",
|
|
"method": "GET",
|
|
"path": "/databases/{uuid}/stop",
|
|
"description": "Stop database. `Post` request is also accepted. UUID of the database.",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "stop-service-by-uuid",
|
|
"method": "GET",
|
|
"path": "/services/{uuid}/stop",
|
|
"description": "Stop service. `Post` request is also accepted. UUID of the service.",
|
|
"category": "Services"
|
|
},
|
|
{
|
|
"id": "update-application-by-uuid",
|
|
"method": "PATCH",
|
|
"path": "/applications/{uuid}",
|
|
"description": "Update application by UUID. UUID of the application.",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "update-cloud-token-by-uuid",
|
|
"method": "PATCH",
|
|
"path": "/cloud-tokens/{uuid}",
|
|
"description": "Update cloud provider token name. application/json",
|
|
"category": "Security"
|
|
},
|
|
{
|
|
"id": "update-database-backup",
|
|
"method": "PATCH",
|
|
"path": "/databases/{uuid}/backups/{scheduled\\_backup\\_uuid}",
|
|
"description": "Update a specific backup configuration for a given database, identified by its UUID and the backup ID UUID of the database.",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "update-database-by-uuid",
|
|
"method": "PATCH",
|
|
"path": "/databases/{uuid}",
|
|
"description": "Update database by UUID. UUID of the database.",
|
|
"category": "Databases"
|
|
},
|
|
{
|
|
"id": "update-env-by-application-uuid",
|
|
"method": "PATCH",
|
|
"path": "/applications/{uuid}/envs",
|
|
"description": "Update env by application UUID. UUID of the application.",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "update-env-by-service-uuid",
|
|
"method": "PATCH",
|
|
"path": "/services/{uuid}/envs",
|
|
"description": "Update env by service UUID. UUID of the service.",
|
|
"category": "Services"
|
|
},
|
|
{
|
|
"id": "update-envs-by-application-uuid",
|
|
"method": "PATCH",
|
|
"path": "/applications/{uuid}/envs/bulk",
|
|
"description": "Update multiple envs by application UUID. UUID of the application.",
|
|
"category": "Applications"
|
|
},
|
|
{
|
|
"id": "update-envs-by-service-uuid",
|
|
"method": "PATCH",
|
|
"path": "/services/{uuid}/envs/bulk",
|
|
"description": "Update multiple envs by service UUID. UUID of the service.",
|
|
"category": "Services"
|
|
},
|
|
{
|
|
"id": "update-private-key",
|
|
"method": "PATCH",
|
|
"path": "/security/keys",
|
|
"description": "Update a private key. application/json",
|
|
"category": "Security"
|
|
},
|
|
{
|
|
"id": "update-project-by-uuid",
|
|
"method": "PATCH",
|
|
"path": "/projects/{uuid}",
|
|
"description": "UUID of the project. application/json",
|
|
"category": "Projects"
|
|
},
|
|
{
|
|
"id": "update-server-by-uuid",
|
|
"method": "PATCH",
|
|
"path": "/servers/{uuid}",
|
|
"description": "application/json \"name\": \"string\",",
|
|
"category": "Servers"
|
|
},
|
|
{
|
|
"id": "update-service-by-uuid",
|
|
"method": "PATCH",
|
|
"path": "/services/{uuid}",
|
|
"description": "Update service by UUID. UUID of the service.",
|
|
"category": "Services"
|
|
},
|
|
{
|
|
"id": "updateGithubApp",
|
|
"method": "PATCH",
|
|
"path": "/github-apps/{github\\_app\\_id}",
|
|
"description": "Update an existing GitHub app. github\\_app\\_id\\*",
|
|
"category": "GitHub"
|
|
},
|
|
{
|
|
"id": "validate-cloud-token-by-uuid",
|
|
"method": "POST",
|
|
"path": "/cloud-tokens/{uuid}/validate",
|
|
"description": "Validate a cloud provider token against the provider API. Token validation result.",
|
|
"category": "Security"
|
|
},
|
|
{
|
|
"id": "validate-server-by-uuid",
|
|
"method": "GET",
|
|
"path": "/servers/{uuid}/validate",
|
|
"description": "Validate server by UUID. Server validation started.",
|
|
"category": "Servers"
|
|
},
|
|
{
|
|
"id": "version",
|
|
"method": "GET",
|
|
"path": "/version",
|
|
"description": "Get Coolify version. Returns the version of the application",
|
|
"category": "Other"
|
|
}
|
|
]
|
|
} |