Commit inicial - estructura base del proyecto
This commit is contained in:
@@ -0,0 +1,87 @@
|
||||
---
|
||||
name: coolify-agent
|
||||
description: Operate the local self-hosted Coolify stack for this Proxmox and Coolify Manager project. Use when Codex needs to inspect Coolify, Docker containers inside LXC 102, applications, services, databases, deployments, logs, environment variables, or Coolify API resources on the local infrastructure.
|
||||
---
|
||||
|
||||
# Coolify Agent
|
||||
|
||||
Use this project-local skill for Coolify work in this repository. Keep actions
|
||||
grounded in the local Proxmox topology and prefer read-only diagnostics before
|
||||
changing production state.
|
||||
|
||||
## Startup Routine
|
||||
|
||||
1. Read `README.md`, `docs/proxmox-inventory.md`, and
|
||||
`docs/runbooks/coolify-docker.md`.
|
||||
2. For app-specific work, also read the matching runbook, for example
|
||||
`docs/runbooks/nextcloud.md`.
|
||||
3. Run `.\scripts\Test-ProxmoxConnection.ps1` before operational work.
|
||||
4. Discover current state before acting:
|
||||
`.\coolify_skill\scripts\Get-CoolifyDockerStatus.ps1 -All`.
|
||||
5. Use the Coolify API only when `COOLIFY_TOKEN` is loaded in the shell.
|
||||
|
||||
## Local Context
|
||||
|
||||
- Proxmox host: `192.168.0.200`.
|
||||
- Docker host: LXC `102` named `coolify`.
|
||||
- Docker is not managed directly on Proxmox; use
|
||||
`pct exec 102 -- docker ...` through `.\scripts\Invoke-ProxmoxSsh.ps1`.
|
||||
- Default Coolify API base URL:
|
||||
`https://coolify.urieljareth.org/api/v1`.
|
||||
- Secrets must live in local environment files or the OS secret store, never in
|
||||
Markdown or skill references.
|
||||
|
||||
## Safety Policy
|
||||
|
||||
- Default to read-only commands: list, inspect, logs, status, health checks.
|
||||
- Ask for explicit confirmation before `POST`, `PUT`, `PATCH`, `DELETE`, deploy,
|
||||
restart, stop, remove, compose up/down, environment writes, key/token changes,
|
||||
or edits to production config.
|
||||
- Do not print tokens, passwords, private keys, cookies, or full env dumps.
|
||||
- For database issues, verify connectivity without echoing credentials.
|
||||
- For risky changes, capture current state and state the rollback path first.
|
||||
|
||||
## Tooling
|
||||
|
||||
- Read `TOOLS.md` for command patterns.
|
||||
- Use `scripts/Invoke-CoolifyApi.ps1` for Coolify API calls from PowerShell.
|
||||
- Use `scripts/Get-CoolifyDockerStatus.ps1` for container status through Proxmox.
|
||||
- The original Bash API helper remains at `scripts/coolify.sh` for Linux/WSL
|
||||
sessions, but PowerShell helpers are preferred in this repo.
|
||||
|
||||
## API References
|
||||
|
||||
Load detailed API docs only when needed:
|
||||
|
||||
- `references/api-index.md`: how to find endpoint docs.
|
||||
- `references/API.md`: compiled high-level API notes.
|
||||
- `references/endpoints_compiled.json`: machine-readable endpoint index.
|
||||
- `references/ops/*.md`: per-operation docs.
|
||||
|
||||
Use `rg` to find the relevant operation instead of loading the whole reference
|
||||
tree.
|
||||
|
||||
## Common Workflows
|
||||
|
||||
Health check:
|
||||
|
||||
1. Run Proxmox smoke test.
|
||||
2. Run Docker status snapshot.
|
||||
3. If API token is loaded, call `/version`, `/projects`, `/servers`, and
|
||||
relevant resource list endpoints.
|
||||
4. Inspect container logs only for the affected service.
|
||||
|
||||
Deployment investigation:
|
||||
|
||||
1. Identify whether the target is an application, service, or database.
|
||||
2. List resources through the API if possible.
|
||||
3. Inspect Docker containers and recent deployment logs.
|
||||
4. Recommend or perform deploy/restart only after confirmation.
|
||||
|
||||
Database/connectivity issue:
|
||||
|
||||
1. Confirm the database container is running and healthy.
|
||||
2. Check service DNS from the app container with `getent hosts <service-name>`.
|
||||
3. Test TCP/auth using existing app config without printing passwords.
|
||||
4. Fix hostnames to Docker service names, not `localhost`, when containers are
|
||||
siblings on the same Docker network.
|
||||
@@ -0,0 +1,73 @@
|
||||
# Coolify Tooling
|
||||
|
||||
All commands assume PowerShell from the project root.
|
||||
|
||||
## Environment
|
||||
|
||||
Load private values from an ignored local file:
|
||||
|
||||
```powershell
|
||||
. .\.env.local.ps1
|
||||
```
|
||||
|
||||
Expected variables:
|
||||
|
||||
```powershell
|
||||
$env:COOLIFY_API_URL = "https://coolify.urieljareth.org/api/v1"
|
||||
$env:COOLIFY_TOKEN = "REPLACE_WITH_TOKEN"
|
||||
```
|
||||
|
||||
## Read-Only Diagnostics
|
||||
|
||||
```powershell
|
||||
.\scripts\Test-ProxmoxConnection.ps1
|
||||
.\coolify_skill\scripts\Get-CoolifyDockerStatus.ps1 -All
|
||||
.\coolify_skill\scripts\Get-CoolifyDockerStatus.ps1 -Filter "coolify|cloudflared|nextcloud|postgres|redis"
|
||||
```
|
||||
|
||||
```powershell
|
||||
.\scripts\Invoke-ProxmoxSsh.ps1 -Command "pct exec 102 -- docker stats --no-stream"
|
||||
.\scripts\Invoke-ProxmoxSsh.ps1 -Command "pct exec 102 -- docker network ls"
|
||||
.\scripts\Invoke-ProxmoxSsh.ps1 -Command "pct exec 102 -- docker volume ls"
|
||||
```
|
||||
|
||||
## Logs And Inspect
|
||||
|
||||
```powershell
|
||||
.\scripts\Invoke-ProxmoxSsh.ps1 -Command "pct exec 102 -- docker logs <container> --tail 100"
|
||||
.\scripts\Invoke-ProxmoxSsh.ps1 -Command "pct exec 102 -- docker inspect <container>"
|
||||
```
|
||||
|
||||
## Coolify API
|
||||
|
||||
```powershell
|
||||
.\coolify_skill\scripts\Invoke-CoolifyApi.ps1 -Path "/version"
|
||||
.\coolify_skill\scripts\Invoke-CoolifyApi.ps1 -Path "/projects"
|
||||
.\coolify_skill\scripts\Invoke-CoolifyApi.ps1 -Path "/servers"
|
||||
.\coolify_skill\scripts\Invoke-CoolifyApi.ps1 -Path "/applications"
|
||||
.\coolify_skill\scripts\Invoke-CoolifyApi.ps1 -Path "/services"
|
||||
.\coolify_skill\scripts\Invoke-CoolifyApi.ps1 -Path "/databases"
|
||||
.\coolify_skill\scripts\Invoke-CoolifyApi.ps1 -Path "/deployments"
|
||||
```
|
||||
|
||||
For write calls, prepare the JSON body first and ask for confirmation:
|
||||
|
||||
```powershell
|
||||
$body = @{ name = "example" } | ConvertTo-Json -Depth 20
|
||||
.\coolify_skill\scripts\Invoke-CoolifyApi.ps1 -Method POST -Path "/projects" -BodyJson $body
|
||||
```
|
||||
|
||||
## API Reference Search
|
||||
|
||||
```powershell
|
||||
rg -n "applications|deploy|database|environment" .\coolify_skill\references
|
||||
Get-Content .\coolify_skill\references\ops\list-applications.md
|
||||
Get-Content .\coolify_skill\references\ops\deploy-by-tag-or-uuid.md
|
||||
```
|
||||
|
||||
## Commands That Require Confirmation
|
||||
|
||||
- Coolify deploys and API writes: `POST`, `PUT`, `PATCH`, `DELETE`.
|
||||
- Docker lifecycle: `restart`, `stop`, `rm`, `compose up`, `compose down`.
|
||||
- Environment variable writes or full env exports.
|
||||
- Key, token, SSH, domain, proxy, server, network, or volume changes.
|
||||
@@ -0,0 +1,7 @@
|
||||
interface:
|
||||
display_name: "Coolify Agent"
|
||||
short_description: "Operate local Coolify through Proxmox"
|
||||
default_prompt: "Use $coolify-agent to inspect the local Coolify stack and recommend the next safe action."
|
||||
|
||||
policy:
|
||||
allow_implicit_invocation: true
|
||||
@@ -0,0 +1,706 @@
|
||||
# Coolify API Reference
|
||||
|
||||
> Generated from 107 operation pages
|
||||
|
||||
## Table of Contents
|
||||
- [Applications](#applications)
|
||||
- [Databases](#databases)
|
||||
- [Deployments](#deployments)
|
||||
- [Environments](#environments)
|
||||
- [GitHub](#github)
|
||||
- [Other](#other)
|
||||
- [Projects](#projects)
|
||||
- [Security](#security)
|
||||
- [Servers](#servers)
|
||||
- [Services](#services)
|
||||
- [Teams](#teams)
|
||||
|
||||
---
|
||||
|
||||
## Applications
|
||||
|
||||
### create-dockercompose-application
|
||||
- **Method:** POST
|
||||
- **Path:** `/api/v1/applications/dockercompose`
|
||||
- **Description:** Deprecated: Use POST /api/v1/services instead. application/json
|
||||
- **Category:** Applications
|
||||
|
||||
### create-dockerfile-application
|
||||
- **Method:** POST
|
||||
- **Path:** `/api/v1/applications/dockerfile`
|
||||
- **Description:** Create new application based on a simple Dockerfile (without git). application/json
|
||||
- **Category:** Applications
|
||||
|
||||
### create-dockerimage-application
|
||||
- **Method:** POST
|
||||
- **Path:** `/api/v1/applications/dockerimage`
|
||||
- **Description:** Create new application based on a prebuilt docker image (without git). application/json
|
||||
- **Category:** Applications
|
||||
|
||||
### create-env-by-application-uuid
|
||||
- **Method:** POST
|
||||
- **Path:** `/api/v1/applications/{uuid}/envs`
|
||||
- **Description:** Create env by application UUID. UUID of the application.
|
||||
- **Category:** Applications
|
||||
|
||||
### create-private-deploy-key-application
|
||||
- **Method:** POST
|
||||
- **Path:** `/api/v1/applications/private-deploy-key`
|
||||
- **Description:** Create new application based on a private repository through a Deploy Key. application/json
|
||||
- **Category:** Applications
|
||||
|
||||
### create-private-github-app-application
|
||||
- **Method:** POST
|
||||
- **Path:** `/api/v1/applications/private-github-app`
|
||||
- **Description:** Create new application based on a private repository through a Github App. application/json
|
||||
- **Category:** Applications
|
||||
|
||||
### create-public-application
|
||||
- **Method:** POST
|
||||
- **Path:** `/api/v1/applications/public`
|
||||
- **Description:** Create new application based on a public git repository. application/json
|
||||
- **Category:** Applications
|
||||
|
||||
### delete-application-by-uuid
|
||||
- **Method:** DELETE
|
||||
- **Path:** `/api/v1/applications/{uuid}`
|
||||
- **Description:** Delete application by UUID. UUID of the application.
|
||||
- **Category:** Applications
|
||||
|
||||
### delete-env-by-application-uuid
|
||||
- **Method:** DELETE
|
||||
- **Path:** `/api/v1/applications/{uuid}/envs/{env_uuid}`
|
||||
- **Description:** Delete env by UUID. UUID of the application.
|
||||
- **Category:** Applications
|
||||
|
||||
### get-application-by-uuid
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/applications/{uuid}`
|
||||
- **Description:** Get application by UUID. UUID of the application.
|
||||
- **Category:** Applications
|
||||
|
||||
### get-application-logs-by-uuid
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/applications/{uuid}/logs`
|
||||
- **Description:** Get application logs by UUID. UUID of the application.
|
||||
- **Category:** Applications
|
||||
|
||||
### list-applications
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/applications`
|
||||
- **Description:** List all applications. Filter applications by tag name.
|
||||
- **Category:** Applications
|
||||
|
||||
### list-deployments-by-app-uuid
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/deployments/applications/{uuid}`
|
||||
- **Description:** List application deployments by using the app uuid UUID of the application.
|
||||
- **Category:** Applications
|
||||
|
||||
### list-envs-by-application-uuid
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/applications/{uuid}/envs`
|
||||
- **Description:** List all envs by application UUID. UUID of the application.
|
||||
- **Category:** Applications
|
||||
|
||||
### restart-application-by-uuid
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/applications/{uuid}/restart`
|
||||
- **Description:** Restart application. `Post` request is also accepted. UUID of the application.
|
||||
- **Category:** Applications
|
||||
|
||||
### start-application-by-uuid
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/applications/{uuid}/start`
|
||||
- **Description:** Start application. `Post` request is also accepted. UUID of the application.
|
||||
- **Category:** Applications
|
||||
|
||||
### stop-application-by-uuid
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/applications/{uuid}/stop`
|
||||
- **Description:** Stop application. `Post` request is also accepted. UUID of the application.
|
||||
- **Category:** Applications
|
||||
|
||||
### update-application-by-uuid
|
||||
- **Method:** PATCH
|
||||
- **Path:** `/api/v1/applications/{uuid}`
|
||||
- **Description:** Update application by UUID. UUID of the application.
|
||||
- **Category:** Applications
|
||||
|
||||
### update-env-by-application-uuid
|
||||
- **Method:** PATCH
|
||||
- **Path:** `/api/v1/applications/{uuid}/envs`
|
||||
- **Description:** Update env by application UUID. UUID of the application.
|
||||
- **Category:** Applications
|
||||
|
||||
### update-envs-by-application-uuid
|
||||
- **Method:** PATCH
|
||||
- **Path:** `/api/v1/applications/{uuid}/envs/bulk`
|
||||
- **Description:** Update multiple envs by application UUID. UUID of the application.
|
||||
- **Category:** Applications
|
||||
|
||||
---
|
||||
|
||||
## Databases
|
||||
|
||||
### create-database-backup
|
||||
- **Method:** POST
|
||||
- **Path:** `/api/v1/databases/{uuid}/backups`
|
||||
- **Description:** Create a new scheduled backup configuration for a database UUID of the database.
|
||||
- **Category:** Databases
|
||||
|
||||
### create-database-clickhouse
|
||||
- **Method:** POST
|
||||
- **Path:** `/api/v1/databases/clickhouse`
|
||||
- **Description:** Create a new Clickhouse database. application/json
|
||||
- **Category:** Databases
|
||||
|
||||
### create-database-dragonfly
|
||||
- **Method:** POST
|
||||
- **Path:** `/api/v1/databases/dragonfly`
|
||||
- **Description:** Create a new DragonFly database. application/json
|
||||
- **Category:** Databases
|
||||
|
||||
### create-database-keydb
|
||||
- **Method:** POST
|
||||
- **Path:** `/api/v1/databases/keydb`
|
||||
- **Description:** Create a new KeyDB database. application/json
|
||||
- **Category:** Databases
|
||||
|
||||
### create-database-mariadb
|
||||
- **Method:** POST
|
||||
- **Path:** `/api/v1/databases/mariadb`
|
||||
- **Description:** Create a new MariaDB database. application/json
|
||||
- **Category:** Databases
|
||||
|
||||
### create-database-mongodb
|
||||
- **Method:** POST
|
||||
- **Path:** `/api/v1/databases/mongodb`
|
||||
- **Description:** Create a new MongoDB database. application/json
|
||||
- **Category:** Databases
|
||||
|
||||
### create-database-mysql
|
||||
- **Method:** POST
|
||||
- **Path:** `/api/v1/databases/mysql`
|
||||
- **Description:** Create a new MySQL database. application/json
|
||||
- **Category:** Databases
|
||||
|
||||
### create-database-postgresql
|
||||
- **Method:** POST
|
||||
- **Path:** `/api/v1/databases/postgresql`
|
||||
- **Description:** Create a new PostgreSQL database. application/json
|
||||
- **Category:** Databases
|
||||
|
||||
### create-database-redis
|
||||
- **Method:** POST
|
||||
- **Path:** `/api/v1/databases/redis`
|
||||
- **Description:** Create a new Redis database. application/json
|
||||
- **Category:** Databases
|
||||
|
||||
### delete-backup-configuration-by-uuid
|
||||
- **Method:** DELETE
|
||||
- **Path:** `/api/v1/databases/{uuid}/backups/{scheduled_backup_uuid}`
|
||||
- **Description:** Deletes a backup configuration and all its executions. UUID of the database
|
||||
- **Category:** Databases
|
||||
|
||||
### delete-backup-execution-by-uuid
|
||||
- **Method:** DELETE
|
||||
- **Path:** `/api/v1/databases/{uuid}/backups/{scheduled_backup_uuid}/executions/{execution_uuid}`
|
||||
- **Description:** Deletes a specific backup execution. UUID of the database
|
||||
- **Category:** Databases
|
||||
|
||||
### delete-database-by-uuid
|
||||
- **Method:** DELETE
|
||||
- **Path:** `/api/v1/databases/{uuid}`
|
||||
- **Description:** Delete database by UUID. UUID of the database.
|
||||
- **Category:** Databases
|
||||
|
||||
### get-database-backups-by-uuid
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/databases/{uuid}/backups`
|
||||
- **Description:** Get backups details by database UUID. UUID of the database.
|
||||
- **Category:** Databases
|
||||
|
||||
### get-database-by-uuid
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/databases/{uuid}`
|
||||
- **Description:** Get database by UUID. UUID of the database.
|
||||
- **Category:** Databases
|
||||
|
||||
### list-backup-executions
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/databases/{uuid}/backups/{scheduled_backup_uuid}/executions`
|
||||
- **Description:** Get all executions for a specific backup configuration. UUID of the database
|
||||
- **Category:** Databases
|
||||
|
||||
### list-databases
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/databases`
|
||||
- **Description:** List all databases. Get all databases
|
||||
- **Category:** Databases
|
||||
|
||||
### restart-database-by-uuid
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/databases/{uuid}/restart`
|
||||
- **Description:** Restart database. `Post` request is also accepted. UUID of the database.
|
||||
- **Category:** Databases
|
||||
|
||||
### start-database-by-uuid
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/databases/{uuid}/start`
|
||||
- **Description:** Start database. `Post` request is also accepted. UUID of the database.
|
||||
- **Category:** Databases
|
||||
|
||||
### stop-database-by-uuid
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/databases/{uuid}/stop`
|
||||
- **Description:** Stop database. `Post` request is also accepted. UUID of the database.
|
||||
- **Category:** Databases
|
||||
|
||||
### update-database-backup
|
||||
- **Method:** PATCH
|
||||
- **Path:** `/api/v1/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
|
||||
|
||||
### update-database-by-uuid
|
||||
- **Method:** PATCH
|
||||
- **Path:** `/api/v1/databases/{uuid}`
|
||||
- **Description:** Update database by UUID. UUID of the database.
|
||||
- **Category:** Databases
|
||||
|
||||
---
|
||||
|
||||
## Deployments
|
||||
|
||||
### cancel-deployment-by-uuid
|
||||
- **Method:** POST
|
||||
- **Path:** `/api/v1/deployments/{uuid}/cancel`
|
||||
- **Description:** Cancel a deployment by UUID. Deployment cancelled successfully.
|
||||
- **Category:** Deployments
|
||||
|
||||
### deploy-by-tag-or-uuid
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/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
|
||||
|
||||
### get-deployment-by-uuid
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/deployments/{uuid}`
|
||||
- **Description:** Get deployment by UUID. Get deployment by UUID.
|
||||
- **Category:** Deployments
|
||||
|
||||
### list-deployments
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/deployments`
|
||||
- **Description:** List currently running deployments Get all currently running deployments.
|
||||
- **Category:** Deployments
|
||||
|
||||
---
|
||||
|
||||
## Environments
|
||||
|
||||
### create-environment
|
||||
- **Method:** POST
|
||||
- **Path:** `/api/v1/projects/{uuid}/environments`
|
||||
- **Description:** Create environment in project. application/json
|
||||
- **Category:** Environments
|
||||
|
||||
### delete-environment
|
||||
- **Method:** DELETE
|
||||
- **Path:** `/api/v1/projects/{uuid}/environments/{environment_name_or_uuid}`
|
||||
- **Description:** Delete environment by name or UUID. Environment must be empty. environment_name_or_uuid*
|
||||
- **Category:** Environments
|
||||
|
||||
### get-environment-by-name-or-uuid
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/projects/{uuid}/{environment_name_or_uuid}`
|
||||
- **Description:** Get environment by name or UUID. environment_name_or_uuid*
|
||||
- **Category:** Environments
|
||||
|
||||
### get-environments
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/projects/{uuid}/environments`
|
||||
- **Description:** List all environments in a project. List of environments
|
||||
- **Category:** Environments
|
||||
|
||||
---
|
||||
|
||||
## GitHub
|
||||
|
||||
### create-github-app
|
||||
- **Method:** POST
|
||||
- **Path:** `/api/v1/github-apps`
|
||||
- **Description:** Create a new GitHub app. application/json
|
||||
- **Category:** GitHub
|
||||
|
||||
### deleteGithubApp
|
||||
- **Method:** DELETE
|
||||
- **Path:** `/api/v1/github-apps/{github_app_id}`
|
||||
- **Description:** Delete a GitHub app if it's not being used by any applications. github_app_id*
|
||||
- **Category:** GitHub
|
||||
|
||||
### list-github-apps
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/github-apps`
|
||||
- **Description:** List all GitHub apps. List of GitHub apps.
|
||||
- **Category:** GitHub
|
||||
|
||||
### load-branches
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/github-apps/{github_app_id}/repositories/{owner}/{repo}/branches`
|
||||
- **Description:** Fetch branches from GitHub for a given repository. github_app_id*
|
||||
- **Category:** GitHub
|
||||
|
||||
### load-repositories
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/github-apps/{github_app_id}/repositories`
|
||||
- **Description:** Fetch repositories from GitHub for a given GitHub app. github_app_id*
|
||||
- **Category:** GitHub
|
||||
|
||||
### updateGithubApp
|
||||
- **Method:** PATCH
|
||||
- **Path:** `/api/v1/github-apps/{github_app_id}`
|
||||
- **Description:** Update an existing GitHub app. github_app_id*
|
||||
- **Category:** GitHub
|
||||
|
||||
---
|
||||
|
||||
## Other
|
||||
|
||||
### healthcheck
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/health`
|
||||
- **Description:** Healthcheck endpoint. Healthcheck endpoint.
|
||||
- **Category:** Other
|
||||
|
||||
### version
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/version`
|
||||
- **Description:** Get Coolify version. Returns the version of the application
|
||||
- **Category:** Other
|
||||
|
||||
---
|
||||
|
||||
## Projects
|
||||
|
||||
### create-project
|
||||
- **Method:** POST
|
||||
- **Path:** `/api/v1/projects`
|
||||
- **Description:** application/json "name": "string",
|
||||
- **Category:** Projects
|
||||
|
||||
### delete-project-by-uuid
|
||||
- **Method:** DELETE
|
||||
- **Path:** `/api/v1/projects/{uuid}`
|
||||
- **Description:** Delete project by UUID. UUID of the application.
|
||||
- **Category:** Projects
|
||||
|
||||
### get-project-by-uuid
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/projects/{uuid}`
|
||||
- **Description:** Get project by UUID. application/json
|
||||
- **Category:** Projects
|
||||
|
||||
### list-projects
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/projects`
|
||||
- **Description:** Get all projects. application/json
|
||||
- **Category:** Projects
|
||||
|
||||
### update-project-by-uuid
|
||||
- **Method:** PATCH
|
||||
- **Path:** `/api/v1/projects/{uuid}`
|
||||
- **Description:** UUID of the project. application/json
|
||||
- **Category:** Projects
|
||||
|
||||
---
|
||||
|
||||
## Security
|
||||
|
||||
### create-cloud-token
|
||||
- **Method:** POST
|
||||
- **Path:** `/api/v1/cloud-tokens`
|
||||
- **Description:** Create a new cloud provider token. The token will be validated before being stored. application/json
|
||||
- **Category:** Security
|
||||
|
||||
### create-private-key
|
||||
- **Method:** POST
|
||||
- **Path:** `/api/v1/security/keys`
|
||||
- **Description:** Create a new private key. application/json
|
||||
- **Category:** Security
|
||||
|
||||
### delete-cloud-token-by-uuid
|
||||
- **Method:** DELETE
|
||||
- **Path:** `/api/v1/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
|
||||
|
||||
### delete-private-key-by-uuid
|
||||
- **Method:** DELETE
|
||||
- **Path:** `/api/v1/security/keys/{uuid}`
|
||||
- **Description:** Delete a private key. Private Key UUID
|
||||
- **Category:** Security
|
||||
|
||||
### disable-api
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/disable`
|
||||
- **Description:** Disable API (only with root permissions). application/json
|
||||
- **Category:** Security
|
||||
|
||||
### enable-api
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/enable`
|
||||
- **Description:** Enable API (only with root permissions). application/json
|
||||
- **Category:** Security
|
||||
|
||||
### get-cloud-token-by-uuid
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/cloud-tokens/{uuid}`
|
||||
- **Description:** Get cloud provider token by UUID. Get cloud provider token by UUID
|
||||
- **Category:** Security
|
||||
|
||||
### get-private-key-by-uuid
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/security/keys/{uuid}`
|
||||
- **Description:** Get key by UUID. Private Key UUID
|
||||
- **Category:** Security
|
||||
|
||||
### list-cloud-tokens
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/cloud-tokens`
|
||||
- **Description:** List all cloud provider tokens for the authenticated team. Get all cloud provider tokens.
|
||||
- **Category:** Security
|
||||
|
||||
### list-private-keys
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/security/keys`
|
||||
- **Description:** List all private keys. Get all private keys.
|
||||
- **Category:** Security
|
||||
|
||||
### update-cloud-token-by-uuid
|
||||
- **Method:** PATCH
|
||||
- **Path:** `/api/v1/cloud-tokens/{uuid}`
|
||||
- **Description:** Update cloud provider token name. application/json
|
||||
- **Category:** Security
|
||||
|
||||
### update-private-key
|
||||
- **Method:** PATCH
|
||||
- **Path:** `/api/v1/security/keys`
|
||||
- **Description:** Update a private key. application/json
|
||||
- **Category:** Security
|
||||
|
||||
### validate-cloud-token-by-uuid
|
||||
- **Method:** POST
|
||||
- **Path:** `/api/v1/cloud-tokens/{uuid}/validate`
|
||||
- **Description:** Validate a cloud provider token against the provider API. Token validation result.
|
||||
- **Category:** Security
|
||||
|
||||
---
|
||||
|
||||
## Servers
|
||||
|
||||
### create-hetzner-server
|
||||
- **Method:** POST
|
||||
- **Path:** `/api/v1/servers/hetzner`
|
||||
- **Description:** Create a new server on Hetzner and register it in Coolify. application/json
|
||||
- **Category:** Servers
|
||||
|
||||
### create-server
|
||||
- **Method:** POST
|
||||
- **Path:** `/api/v1/servers`
|
||||
- **Description:** application/json "name": "My Server",
|
||||
- **Category:** Servers
|
||||
|
||||
### delete-server-by-uuid
|
||||
- **Method:** DELETE
|
||||
- **Path:** `/api/v1/servers/{uuid}`
|
||||
- **Description:** Delete server by UUID. UUID of the server.
|
||||
- **Category:** Servers
|
||||
|
||||
### get-domains-by-server-uuid
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/servers/{uuid}/domains`
|
||||
- **Description:** Get domains by server. Get domains by server
|
||||
- **Category:** Servers
|
||||
|
||||
### get-hetzner-images
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/hetzner/images`
|
||||
- **Description:** Get all available Hetzner system images (operating systems). cloud_provider_token_uuid
|
||||
- **Category:** Servers
|
||||
|
||||
### get-hetzner-locations
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/hetzner/locations`
|
||||
- **Description:** Get all available Hetzner datacenter locations. cloud_provider_token_uuid
|
||||
- **Category:** Servers
|
||||
|
||||
### get-hetzner-server-types
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/hetzner/server-types`
|
||||
- **Description:** Get all available Hetzner server types (instance sizes). cloud_provider_token_uuid
|
||||
- **Category:** Servers
|
||||
|
||||
### get-hetzner-ssh-keys
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/hetzner/ssh-keys`
|
||||
- **Description:** Get all SSH keys stored in the Hetzner account. cloud_provider_token_uuid
|
||||
- **Category:** Servers
|
||||
|
||||
### get-resources-by-server-uuid
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/servers/{uuid}/resources`
|
||||
- **Description:** Get resources by server. Get resources by server
|
||||
- **Category:** Servers
|
||||
|
||||
### get-server-by-uuid
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/servers/{uuid}`
|
||||
- **Description:** Get server by UUID. Get server by UUID
|
||||
- **Category:** Servers
|
||||
|
||||
### list-resources
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/resources`
|
||||
- **Description:** Get all resources. Get all resources
|
||||
- **Category:** Servers
|
||||
|
||||
### list-servers
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/servers`
|
||||
- **Description:** List all servers. Get all servers.
|
||||
- **Category:** Servers
|
||||
|
||||
### update-server-by-uuid
|
||||
- **Method:** PATCH
|
||||
- **Path:** `/api/v1/servers/{uuid}`
|
||||
- **Description:** application/json "name": "string",
|
||||
- **Category:** Servers
|
||||
|
||||
### validate-server-by-uuid
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/servers/{uuid}/validate`
|
||||
- **Description:** Validate server by UUID. Server validation started.
|
||||
- **Category:** Servers
|
||||
|
||||
---
|
||||
|
||||
## Services
|
||||
|
||||
### create-env-by-service-uuid
|
||||
- **Method:** POST
|
||||
- **Path:** `/api/v1/services/{uuid}/envs`
|
||||
- **Description:** Create env by service UUID. UUID of the service.
|
||||
- **Category:** Services
|
||||
|
||||
### create-service
|
||||
- **Method:** POST
|
||||
- **Path:** `/api/v1/services`
|
||||
- **Description:** Create a one-click / custom service application/json
|
||||
- **Category:** Services
|
||||
|
||||
### delete-env-by-service-uuid
|
||||
- **Method:** DELETE
|
||||
- **Path:** `/api/v1/services/{uuid}/envs/{env_uuid}`
|
||||
- **Description:** Delete env by UUID. UUID of the service.
|
||||
- **Category:** Services
|
||||
|
||||
### delete-service-by-uuid
|
||||
- **Method:** DELETE
|
||||
- **Path:** `/api/v1/services/{uuid}`
|
||||
- **Description:** Delete service by UUID. delete_configurations
|
||||
- **Category:** Services
|
||||
|
||||
### get-service-by-uuid
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/services/{uuid}`
|
||||
- **Description:** Get service by UUID. Get a service by UUID.
|
||||
- **Category:** Services
|
||||
|
||||
### list-envs-by-service-uuid
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/services/{uuid}/envs`
|
||||
- **Description:** List all envs by service UUID. UUID of the service.
|
||||
- **Category:** Services
|
||||
|
||||
### list-services
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/services`
|
||||
- **Description:** List all services. Get all services
|
||||
- **Category:** Services
|
||||
|
||||
### restart-service-by-uuid
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/services/{uuid}/restart`
|
||||
- **Description:** Restart service. `Post` request is also accepted. UUID of the service.
|
||||
- **Category:** Services
|
||||
|
||||
### start-service-by-uuid
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/services/{uuid}/start`
|
||||
- **Description:** Start service. `Post` request is also accepted. UUID of the service.
|
||||
- **Category:** Services
|
||||
|
||||
### stop-service-by-uuid
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/services/{uuid}/stop`
|
||||
- **Description:** Stop service. `Post` request is also accepted. UUID of the service.
|
||||
- **Category:** Services
|
||||
|
||||
### update-env-by-service-uuid
|
||||
- **Method:** PATCH
|
||||
- **Path:** `/api/v1/services/{uuid}/envs`
|
||||
- **Description:** Update env by service UUID. UUID of the service.
|
||||
- **Category:** Services
|
||||
|
||||
### update-envs-by-service-uuid
|
||||
- **Method:** PATCH
|
||||
- **Path:** `/api/v1/services/{uuid}/envs/bulk`
|
||||
- **Description:** Update multiple envs by service UUID. UUID of the service.
|
||||
- **Category:** Services
|
||||
|
||||
### update-service-by-uuid
|
||||
- **Method:** PATCH
|
||||
- **Path:** `/api/v1/services/{uuid}`
|
||||
- **Description:** Update service by UUID. UUID of the service.
|
||||
- **Category:** Services
|
||||
|
||||
---
|
||||
|
||||
## Teams
|
||||
|
||||
### get-current-team
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/teams/current`
|
||||
- **Description:** Get currently authenticated team. application/json
|
||||
- **Category:** Teams
|
||||
|
||||
### get-current-team-members
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/teams/current/members`
|
||||
- **Description:** Get currently authenticated team members. Currently authenticated team members.
|
||||
- **Category:** Teams
|
||||
|
||||
### get-members-by-team-id
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/teams/{id}/members`
|
||||
- **Description:** Get members by TeamId. List of members.
|
||||
- **Category:** Teams
|
||||
|
||||
### get-team-by-id
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/teams/{id}`
|
||||
- **Description:** Get team by TeamId. application/json
|
||||
- **Category:** Teams
|
||||
|
||||
### list-teams
|
||||
- **Method:** GET
|
||||
- **Path:** `/api/v1/teams`
|
||||
- **Description:** application/json "name": "string",
|
||||
- **Category:** Teams
|
||||
|
||||
---
|
||||
|
||||
*Generated: 2026-04-15T21:32:31.984Z | Total: 107 endpoints | 11 categories*
|
||||
@@ -0,0 +1,41 @@
|
||||
# Coolify API Index
|
||||
|
||||
Use this file to find detailed API references without loading the full API
|
||||
corpus.
|
||||
|
||||
## Main Files
|
||||
|
||||
- `API.md`: compiled overview from the Coolify API docs.
|
||||
- `endpoints_compiled.json`: machine-readable endpoint inventory.
|
||||
- `ops/*.md`: one Markdown file per operation.
|
||||
|
||||
## Search Patterns
|
||||
|
||||
```powershell
|
||||
rg -n '"method"|"path"|applications|services|databases|deployments' .\coolify_skill\references\endpoints_compiled.json
|
||||
rg -n "List|Create|Update|Delete|Deploy|Start|Stop|Restart" .\coolify_skill\references\ops
|
||||
```
|
||||
|
||||
## Common Operation Files
|
||||
|
||||
- `ops/version.md`
|
||||
- `ops/healthcheck.md`
|
||||
- `ops/list-applications.md`
|
||||
- `ops/get-application-by-uuid.md`
|
||||
- `ops/get-application-logs-by-uuid.md`
|
||||
- `ops/deploy-by-tag-or-uuid.md`
|
||||
- `ops/list-services.md`
|
||||
- `ops/get-service-by-uuid.md`
|
||||
- `ops/list-databases.md`
|
||||
- `ops/get-database-by-uuid.md`
|
||||
- `ops/list-deployments.md`
|
||||
- `ops/list-deployments-by-app-uuid.md`
|
||||
- `ops/list-projects.md`
|
||||
- `ops/list-servers.md`
|
||||
- `ops/list-envs-by-application-uuid.md`
|
||||
- `ops/update-env-by-application-uuid.md`
|
||||
|
||||
## Rule
|
||||
|
||||
For write operations, read the specific `ops/*.md` file before sending the API
|
||||
request and ask the user for confirmation.
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,95 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/cancel-deployment-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Cancel[](https://coolify.io/docs/api-reference/api/operations/cancel-deployment-by-uuid#cancel)
|
||||
|
||||
=================================================================================================
|
||||
|
||||
POST
|
||||
|
||||
/deployments/{uuid}/cancel
|
||||
|
||||
Cancel a deployment by UUID.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/cancel-deployment-by-uuid#authorizations)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/cancel-deployment-by-uuid#parameters)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
Deployment UUID
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/cancel-deployment-by-uuid#responses)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401403404
|
||||
|
||||
Deployment cancelled successfully.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"message": "Deployment cancelled successfully.",
|
||||
|
||||
"deployment\_uuid": "cm37r6cqj000008jm0veg5tkm",
|
||||
|
||||
"status": "cancelled-by-user"
|
||||
|
||||
}
|
||||
|
||||
POST
|
||||
|
||||
/deployments/{uuid}/cancel
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/cancel-deployment-by-uuid#playground)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/cancel-deployment-by-uuid#samples)
|
||||
|
||||
---------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,89 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/create-cloud-token#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Create Cloud Provider Token[](https://coolify.io/docs/api-reference/api/operations/create-cloud-token#create-cloud-provider-token)
|
||||
|
||||
====================================================================================================================================
|
||||
|
||||
POST
|
||||
|
||||
/cloud-tokens
|
||||
|
||||
Create a new cloud provider token. The token will be validated before being stored.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/create-cloud-token#authorizations)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/create-cloud-token#request-body)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"provider": "hetzner",
|
||||
|
||||
"token": "your-api-token-here",
|
||||
|
||||
"name": "My Hetzner Token"
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/create-cloud-token#responses)
|
||||
|
||||
------------------------------------------------------------------------------------------------
|
||||
|
||||
201400401422
|
||||
|
||||
Cloud provider token created.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"uuid": "og888os"
|
||||
|
||||
}
|
||||
|
||||
POST
|
||||
|
||||
/cloud-tokens
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/create-cloud-token#playground)
|
||||
|
||||
--------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Body
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/create-cloud-token#samples)
|
||||
|
||||
--------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,137 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/create-database-backup#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Create Backup[](https://coolify.io/docs/api-reference/api/operations/create-database-backup#create-backup)
|
||||
|
||||
============================================================================================================
|
||||
|
||||
POST
|
||||
|
||||
/databases/{uuid}/backups
|
||||
|
||||
Create a new scheduled backup configuration for a database
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/create-database-backup#authorizations)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/create-database-backup#parameters)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the database.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/create-database-backup#request-body)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"frequency": "string",
|
||||
|
||||
"enabled": true,
|
||||
|
||||
"save\_s3": false,
|
||||
|
||||
"s3\_storage\_uuid": "string",
|
||||
|
||||
"databases\_to\_backup": "string",
|
||||
|
||||
"dump\_all": false,
|
||||
|
||||
"backup\_now": true,
|
||||
|
||||
"database\_backup\_retention\_amount\_locally": 0,
|
||||
|
||||
"database\_backup\_retention\_days\_locally": 0,
|
||||
|
||||
"database\_backup\_retention\_max\_storage\_locally": 0,
|
||||
|
||||
"database\_backup\_retention\_amount\_s3": 0,
|
||||
|
||||
"database\_backup\_retention\_days\_s3": 0,
|
||||
|
||||
"database\_backup\_retention\_max\_storage\_s3": 0,
|
||||
|
||||
"timeout": 3600
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/create-database-backup#responses)
|
||||
|
||||
----------------------------------------------------------------------------------------------------
|
||||
|
||||
201400401404422
|
||||
|
||||
Backup configuration created successfully
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"uuid": "550e8400-e29b-41d4-a716-446655440000",
|
||||
|
||||
"message": "Backup configuration created successfully."
|
||||
|
||||
}
|
||||
|
||||
POST
|
||||
|
||||
/databases/{uuid}/backups
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/create-database-backup#playground)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Body
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/create-database-backup#samples)
|
||||
|
||||
------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,111 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/create-database-clickhouse#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Create (Clickhouse)[](https://coolify.io/docs/api-reference/api/operations/create-database-clickhouse#create-clickhouse)
|
||||
|
||||
==========================================================================================================================
|
||||
|
||||
POST
|
||||
|
||||
/databases/clickhouse
|
||||
|
||||
Create a new Clickhouse database.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/create-database-clickhouse#authorizations)
|
||||
|
||||
------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/create-database-clickhouse#request-body)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"server\_uuid": "string",
|
||||
|
||||
"project\_uuid": "string",
|
||||
|
||||
"environment\_name": "string",
|
||||
|
||||
"environment\_uuid": "string",
|
||||
|
||||
"destination\_uuid": "string",
|
||||
|
||||
"clickhouse\_admin\_user": "string",
|
||||
|
||||
"clickhouse\_admin\_password": "string",
|
||||
|
||||
"name": "string",
|
||||
|
||||
"description": "string",
|
||||
|
||||
"image": "string",
|
||||
|
||||
"is\_public": true,
|
||||
|
||||
"public\_port": 0,
|
||||
|
||||
"public\_port\_timeout": 0,
|
||||
|
||||
"limits\_memory": "string",
|
||||
|
||||
"limits\_memory\_swap": "string",
|
||||
|
||||
"limits\_memory\_swappiness": 0,
|
||||
|
||||
"limits\_memory\_reservation": "string",
|
||||
|
||||
"limits\_cpus": "string",
|
||||
|
||||
"limits\_cpuset": "string",
|
||||
|
||||
"limits\_cpu\_shares": 0,
|
||||
|
||||
"instant\_deploy": true
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/create-database-clickhouse#responses)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401422
|
||||
|
||||
Database updated
|
||||
|
||||
POST
|
||||
|
||||
/databases/clickhouse
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/create-database-clickhouse#playground)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Body
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/create-database-clickhouse#samples)
|
||||
|
||||
----------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,109 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/create-database-dragonfly#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Create (DragonFly)[](https://coolify.io/docs/api-reference/api/operations/create-database-dragonfly#create-dragonfly)
|
||||
|
||||
=======================================================================================================================
|
||||
|
||||
POST
|
||||
|
||||
/databases/dragonfly
|
||||
|
||||
Create a new DragonFly database.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/create-database-dragonfly#authorizations)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/create-database-dragonfly#request-body)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"server\_uuid": "string",
|
||||
|
||||
"project\_uuid": "string",
|
||||
|
||||
"environment\_name": "string",
|
||||
|
||||
"environment\_uuid": "string",
|
||||
|
||||
"destination\_uuid": "string",
|
||||
|
||||
"dragonfly\_password": "string",
|
||||
|
||||
"name": "string",
|
||||
|
||||
"description": "string",
|
||||
|
||||
"image": "string",
|
||||
|
||||
"is\_public": true,
|
||||
|
||||
"public\_port": 0,
|
||||
|
||||
"public\_port\_timeout": 0,
|
||||
|
||||
"limits\_memory": "string",
|
||||
|
||||
"limits\_memory\_swap": "string",
|
||||
|
||||
"limits\_memory\_swappiness": 0,
|
||||
|
||||
"limits\_memory\_reservation": "string",
|
||||
|
||||
"limits\_cpus": "string",
|
||||
|
||||
"limits\_cpuset": "string",
|
||||
|
||||
"limits\_cpu\_shares": 0,
|
||||
|
||||
"instant\_deploy": true
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/create-database-dragonfly#responses)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401422
|
||||
|
||||
Database updated
|
||||
|
||||
POST
|
||||
|
||||
/databases/dragonfly
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/create-database-dragonfly#playground)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Body
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/create-database-dragonfly#samples)
|
||||
|
||||
---------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,111 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/create-database-keydb#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Create (KeyDB)[](https://coolify.io/docs/api-reference/api/operations/create-database-keydb#create-keydb)
|
||||
|
||||
===========================================================================================================
|
||||
|
||||
POST
|
||||
|
||||
/databases/keydb
|
||||
|
||||
Create a new KeyDB database.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/create-database-keydb#authorizations)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/create-database-keydb#request-body)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"server\_uuid": "string",
|
||||
|
||||
"project\_uuid": "string",
|
||||
|
||||
"environment\_name": "string",
|
||||
|
||||
"environment\_uuid": "string",
|
||||
|
||||
"destination\_uuid": "string",
|
||||
|
||||
"keydb\_password": "string",
|
||||
|
||||
"keydb\_conf": "string",
|
||||
|
||||
"name": "string",
|
||||
|
||||
"description": "string",
|
||||
|
||||
"image": "string",
|
||||
|
||||
"is\_public": true,
|
||||
|
||||
"public\_port": 0,
|
||||
|
||||
"public\_port\_timeout": 0,
|
||||
|
||||
"limits\_memory": "string",
|
||||
|
||||
"limits\_memory\_swap": "string",
|
||||
|
||||
"limits\_memory\_swappiness": 0,
|
||||
|
||||
"limits\_memory\_reservation": "string",
|
||||
|
||||
"limits\_cpus": "string",
|
||||
|
||||
"limits\_cpuset": "string",
|
||||
|
||||
"limits\_cpu\_shares": 0,
|
||||
|
||||
"instant\_deploy": true
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/create-database-keydb#responses)
|
||||
|
||||
---------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401422
|
||||
|
||||
Database updated
|
||||
|
||||
POST
|
||||
|
||||
/databases/keydb
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/create-database-keydb#playground)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Body
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/create-database-keydb#samples)
|
||||
|
||||
-----------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,117 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/create-database-mariadb#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Create (MariaDB)[](https://coolify.io/docs/api-reference/api/operations/create-database-mariadb#create-mariadb)
|
||||
|
||||
=================================================================================================================
|
||||
|
||||
POST
|
||||
|
||||
/databases/mariadb
|
||||
|
||||
Create a new MariaDB database.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/create-database-mariadb#authorizations)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/create-database-mariadb#request-body)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"server\_uuid": "string",
|
||||
|
||||
"project\_uuid": "string",
|
||||
|
||||
"environment\_name": "string",
|
||||
|
||||
"environment\_uuid": "string",
|
||||
|
||||
"destination\_uuid": "string",
|
||||
|
||||
"mariadb\_conf": "string",
|
||||
|
||||
"mariadb\_root\_password": "string",
|
||||
|
||||
"mariadb\_user": "string",
|
||||
|
||||
"mariadb\_password": "string",
|
||||
|
||||
"mariadb\_database": "string",
|
||||
|
||||
"name": "string",
|
||||
|
||||
"description": "string",
|
||||
|
||||
"image": "string",
|
||||
|
||||
"is\_public": true,
|
||||
|
||||
"public\_port": 0,
|
||||
|
||||
"public\_port\_timeout": 0,
|
||||
|
||||
"limits\_memory": "string",
|
||||
|
||||
"limits\_memory\_swap": "string",
|
||||
|
||||
"limits\_memory\_swappiness": 0,
|
||||
|
||||
"limits\_memory\_reservation": "string",
|
||||
|
||||
"limits\_cpus": "string",
|
||||
|
||||
"limits\_cpuset": "string",
|
||||
|
||||
"limits\_cpu\_shares": 0,
|
||||
|
||||
"instant\_deploy": true
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/create-database-mariadb#responses)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401422
|
||||
|
||||
Database updated
|
||||
|
||||
POST
|
||||
|
||||
/databases/mariadb
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/create-database-mariadb#playground)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Body
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/create-database-mariadb#samples)
|
||||
|
||||
-------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,111 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/create-database-mongodb#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Create (MongoDB)[](https://coolify.io/docs/api-reference/api/operations/create-database-mongodb#create-mongodb)
|
||||
|
||||
=================================================================================================================
|
||||
|
||||
POST
|
||||
|
||||
/databases/mongodb
|
||||
|
||||
Create a new MongoDB database.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/create-database-mongodb#authorizations)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/create-database-mongodb#request-body)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"server\_uuid": "string",
|
||||
|
||||
"project\_uuid": "string",
|
||||
|
||||
"environment\_name": "string",
|
||||
|
||||
"environment\_uuid": "string",
|
||||
|
||||
"destination\_uuid": "string",
|
||||
|
||||
"mongo\_conf": "string",
|
||||
|
||||
"mongo\_initdb\_root\_username": "string",
|
||||
|
||||
"name": "string",
|
||||
|
||||
"description": "string",
|
||||
|
||||
"image": "string",
|
||||
|
||||
"is\_public": true,
|
||||
|
||||
"public\_port": 0,
|
||||
|
||||
"public\_port\_timeout": 0,
|
||||
|
||||
"limits\_memory": "string",
|
||||
|
||||
"limits\_memory\_swap": "string",
|
||||
|
||||
"limits\_memory\_swappiness": 0,
|
||||
|
||||
"limits\_memory\_reservation": "string",
|
||||
|
||||
"limits\_cpus": "string",
|
||||
|
||||
"limits\_cpuset": "string",
|
||||
|
||||
"limits\_cpu\_shares": 0,
|
||||
|
||||
"instant\_deploy": true
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/create-database-mongodb#responses)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401422
|
||||
|
||||
Database updated
|
||||
|
||||
POST
|
||||
|
||||
/databases/mongodb
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/create-database-mongodb#playground)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Body
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/create-database-mongodb#samples)
|
||||
|
||||
-------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,117 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/create-database-mysql#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Create (MySQL)[](https://coolify.io/docs/api-reference/api/operations/create-database-mysql#create-mysql)
|
||||
|
||||
===========================================================================================================
|
||||
|
||||
POST
|
||||
|
||||
/databases/mysql
|
||||
|
||||
Create a new MySQL database.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/create-database-mysql#authorizations)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/create-database-mysql#request-body)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"server\_uuid": "string",
|
||||
|
||||
"project\_uuid": "string",
|
||||
|
||||
"environment\_name": "string",
|
||||
|
||||
"environment\_uuid": "string",
|
||||
|
||||
"destination\_uuid": "string",
|
||||
|
||||
"mysql\_root\_password": "string",
|
||||
|
||||
"mysql\_password": "string",
|
||||
|
||||
"mysql\_user": "string",
|
||||
|
||||
"mysql\_database": "string",
|
||||
|
||||
"mysql\_conf": "string",
|
||||
|
||||
"name": "string",
|
||||
|
||||
"description": "string",
|
||||
|
||||
"image": "string",
|
||||
|
||||
"is\_public": true,
|
||||
|
||||
"public\_port": 0,
|
||||
|
||||
"public\_port\_timeout": 0,
|
||||
|
||||
"limits\_memory": "string",
|
||||
|
||||
"limits\_memory\_swap": "string",
|
||||
|
||||
"limits\_memory\_swappiness": 0,
|
||||
|
||||
"limits\_memory\_reservation": "string",
|
||||
|
||||
"limits\_cpus": "string",
|
||||
|
||||
"limits\_cpuset": "string",
|
||||
|
||||
"limits\_cpu\_shares": 0,
|
||||
|
||||
"instant\_deploy": true
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/create-database-mysql#responses)
|
||||
|
||||
---------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401422
|
||||
|
||||
Database updated
|
||||
|
||||
POST
|
||||
|
||||
/databases/mysql
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/create-database-mysql#playground)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Body
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/create-database-mysql#samples)
|
||||
|
||||
-----------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,119 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/create-database-postgresql#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Create (PostgreSQL)[](https://coolify.io/docs/api-reference/api/operations/create-database-postgresql#create-postgresql)
|
||||
|
||||
==========================================================================================================================
|
||||
|
||||
POST
|
||||
|
||||
/databases/postgresql
|
||||
|
||||
Create a new PostgreSQL database.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/create-database-postgresql#authorizations)
|
||||
|
||||
------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/create-database-postgresql#request-body)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"server\_uuid": "string",
|
||||
|
||||
"project\_uuid": "string",
|
||||
|
||||
"environment\_name": "string",
|
||||
|
||||
"environment\_uuid": "string",
|
||||
|
||||
"postgres\_user": "string",
|
||||
|
||||
"postgres\_password": "string",
|
||||
|
||||
"postgres\_db": "string",
|
||||
|
||||
"postgres\_initdb\_args": "string",
|
||||
|
||||
"postgres\_host\_auth\_method": "string",
|
||||
|
||||
"postgres\_conf": "string",
|
||||
|
||||
"destination\_uuid": "string",
|
||||
|
||||
"name": "string",
|
||||
|
||||
"description": "string",
|
||||
|
||||
"image": "string",
|
||||
|
||||
"is\_public": true,
|
||||
|
||||
"public\_port": 0,
|
||||
|
||||
"public\_port\_timeout": 0,
|
||||
|
||||
"limits\_memory": "string",
|
||||
|
||||
"limits\_memory\_swap": "string",
|
||||
|
||||
"limits\_memory\_swappiness": 0,
|
||||
|
||||
"limits\_memory\_reservation": "string",
|
||||
|
||||
"limits\_cpus": "string",
|
||||
|
||||
"limits\_cpuset": "string",
|
||||
|
||||
"limits\_cpu\_shares": 0,
|
||||
|
||||
"instant\_deploy": true
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/create-database-postgresql#responses)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401422
|
||||
|
||||
Database updated
|
||||
|
||||
POST
|
||||
|
||||
/databases/postgresql
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/create-database-postgresql#playground)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Body
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/create-database-postgresql#samples)
|
||||
|
||||
----------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,111 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/create-database-redis#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Create (Redis)[](https://coolify.io/docs/api-reference/api/operations/create-database-redis#create-redis)
|
||||
|
||||
===========================================================================================================
|
||||
|
||||
POST
|
||||
|
||||
/databases/redis
|
||||
|
||||
Create a new Redis database.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/create-database-redis#authorizations)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/create-database-redis#request-body)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"server\_uuid": "string",
|
||||
|
||||
"project\_uuid": "string",
|
||||
|
||||
"environment\_name": "string",
|
||||
|
||||
"environment\_uuid": "string",
|
||||
|
||||
"destination\_uuid": "string",
|
||||
|
||||
"redis\_password": "string",
|
||||
|
||||
"redis\_conf": "string",
|
||||
|
||||
"name": "string",
|
||||
|
||||
"description": "string",
|
||||
|
||||
"image": "string",
|
||||
|
||||
"is\_public": true,
|
||||
|
||||
"public\_port": 0,
|
||||
|
||||
"public\_port\_timeout": 0,
|
||||
|
||||
"limits\_memory": "string",
|
||||
|
||||
"limits\_memory\_swap": "string",
|
||||
|
||||
"limits\_memory\_swappiness": 0,
|
||||
|
||||
"limits\_memory\_reservation": "string",
|
||||
|
||||
"limits\_cpus": "string",
|
||||
|
||||
"limits\_cpuset": "string",
|
||||
|
||||
"limits\_cpu\_shares": 0,
|
||||
|
||||
"instant\_deploy": true
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/create-database-redis#responses)
|
||||
|
||||
---------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401422
|
||||
|
||||
Database updated
|
||||
|
||||
POST
|
||||
|
||||
/databases/redis
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/create-database-redis#playground)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Body
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/create-database-redis#samples)
|
||||
|
||||
-----------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,111 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/create-dockercompose-application#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Deprecated
|
||||
|
||||
Create (Docker Compose)[](https://coolify.io/docs/api-reference/api/operations/create-dockercompose-application#create-docker-compose)
|
||||
|
||||
========================================================================================================================================
|
||||
|
||||
POST
|
||||
|
||||
/applications/dockercompose
|
||||
|
||||
Deprecated: Use POST /api/v1/services instead.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/create-dockercompose-application#authorizations)
|
||||
|
||||
------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/create-dockercompose-application#request-body)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"project\_uuid": "string",
|
||||
|
||||
"server\_uuid": "string",
|
||||
|
||||
"environment\_name": "string",
|
||||
|
||||
"environment\_uuid": "string",
|
||||
|
||||
"docker\_compose\_raw": "string",
|
||||
|
||||
"destination\_uuid": "string",
|
||||
|
||||
"name": "string",
|
||||
|
||||
"description": "string",
|
||||
|
||||
"instant\_deploy": true,
|
||||
|
||||
"use\_build\_server": true,
|
||||
|
||||
"connect\_to\_docker\_network": true,
|
||||
|
||||
"force\_domain\_override": true,
|
||||
|
||||
"is\_container\_label\_escape\_enabled": true
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/create-dockercompose-application#responses)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------
|
||||
|
||||
201400401409
|
||||
|
||||
Application created successfully.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"uuid": "string"
|
||||
|
||||
}
|
||||
|
||||
POST
|
||||
|
||||
/applications/dockercompose
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/create-dockercompose-application#playground)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Body
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/create-dockercompose-application#samples)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,193 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/create-dockerfile-application#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Create (Dockerfile without git)[](https://coolify.io/docs/api-reference/api/operations/create-dockerfile-application#create-dockerfile-without-git)
|
||||
|
||||
=====================================================================================================================================================
|
||||
|
||||
POST
|
||||
|
||||
/applications/dockerfile
|
||||
|
||||
Create new application based on a simple Dockerfile (without git).
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/create-dockerfile-application#authorizations)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/create-dockerfile-application#request-body)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"project\_uuid": "string",
|
||||
|
||||
"server\_uuid": "string",
|
||||
|
||||
"environment\_name": "string",
|
||||
|
||||
"environment\_uuid": "string",
|
||||
|
||||
"dockerfile": "string",
|
||||
|
||||
"build\_pack": "string",
|
||||
|
||||
"ports\_exposes": "string",
|
||||
|
||||
"destination\_uuid": "string",
|
||||
|
||||
"name": "string",
|
||||
|
||||
"description": "string",
|
||||
|
||||
"domains": "string",
|
||||
|
||||
"docker\_registry\_image\_name": "string",
|
||||
|
||||
"docker\_registry\_image\_tag": "string",
|
||||
|
||||
"ports\_mappings": "string",
|
||||
|
||||
"base\_directory": "string",
|
||||
|
||||
"health\_check\_enabled": true,
|
||||
|
||||
"health\_check\_path": "string",
|
||||
|
||||
"health\_check\_port": "string",
|
||||
|
||||
"health\_check\_host": "string",
|
||||
|
||||
"health\_check\_method": "string",
|
||||
|
||||
"health\_check\_return\_code": 0,
|
||||
|
||||
"health\_check\_scheme": "string",
|
||||
|
||||
"health\_check\_response\_text": "string",
|
||||
|
||||
"health\_check\_interval": 0,
|
||||
|
||||
"health\_check\_timeout": 0,
|
||||
|
||||
"health\_check\_retries": 0,
|
||||
|
||||
"health\_check\_start\_period": 0,
|
||||
|
||||
"limits\_memory": "string",
|
||||
|
||||
"limits\_memory\_swap": "string",
|
||||
|
||||
"limits\_memory\_swappiness": 0,
|
||||
|
||||
"limits\_memory\_reservation": "string",
|
||||
|
||||
"limits\_cpus": "string",
|
||||
|
||||
"limits\_cpuset": "string",
|
||||
|
||||
"limits\_cpu\_shares": 0,
|
||||
|
||||
"custom\_labels": "string",
|
||||
|
||||
"custom\_docker\_run\_options": "string",
|
||||
|
||||
"post\_deployment\_command": "string",
|
||||
|
||||
"post\_deployment\_command\_container": "string",
|
||||
|
||||
"pre\_deployment\_command": "string",
|
||||
|
||||
"pre\_deployment\_command\_container": "string",
|
||||
|
||||
"manual\_webhook\_secret\_github": "string",
|
||||
|
||||
"manual\_webhook\_secret\_gitlab": "string",
|
||||
|
||||
"manual\_webhook\_secret\_bitbucket": "string",
|
||||
|
||||
"manual\_webhook\_secret\_gitea": "string",
|
||||
|
||||
"redirect": "string",
|
||||
|
||||
"instant\_deploy": true,
|
||||
|
||||
"is\_force\_https\_enabled": true,
|
||||
|
||||
"use\_build\_server": true,
|
||||
|
||||
"is\_http\_basic\_auth\_enabled": true,
|
||||
|
||||
"http\_basic\_auth\_username": "string",
|
||||
|
||||
"http\_basic\_auth\_password": "string",
|
||||
|
||||
"connect\_to\_docker\_network": true,
|
||||
|
||||
"force\_domain\_override": true,
|
||||
|
||||
"autogenerate\_domain": true,
|
||||
|
||||
"is\_container\_label\_escape\_enabled": true
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/create-dockerfile-application#responses)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------------
|
||||
|
||||
201400401409
|
||||
|
||||
Application created successfully.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"uuid": "string"
|
||||
|
||||
}
|
||||
|
||||
POST
|
||||
|
||||
/applications/dockerfile
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/create-dockerfile-application#playground)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Body
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/create-dockerfile-application#samples)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,187 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/create-dockerimage-application#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Create (Docker Image without git)[](https://coolify.io/docs/api-reference/api/operations/create-dockerimage-application#create-docker-image-without-git)
|
||||
|
||||
==========================================================================================================================================================
|
||||
|
||||
POST
|
||||
|
||||
/applications/dockerimage
|
||||
|
||||
Create new application based on a prebuilt docker image (without git).
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/create-dockerimage-application#authorizations)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/create-dockerimage-application#request-body)
|
||||
|
||||
------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"project\_uuid": "string",
|
||||
|
||||
"server\_uuid": "string",
|
||||
|
||||
"environment\_name": "string",
|
||||
|
||||
"environment\_uuid": "string",
|
||||
|
||||
"docker\_registry\_image\_name": "string",
|
||||
|
||||
"docker\_registry\_image\_tag": "string",
|
||||
|
||||
"ports\_exposes": "string",
|
||||
|
||||
"destination\_uuid": "string",
|
||||
|
||||
"name": "string",
|
||||
|
||||
"description": "string",
|
||||
|
||||
"domains": "string",
|
||||
|
||||
"ports\_mappings": "string",
|
||||
|
||||
"health\_check\_enabled": true,
|
||||
|
||||
"health\_check\_path": "string",
|
||||
|
||||
"health\_check\_port": "string",
|
||||
|
||||
"health\_check\_host": "string",
|
||||
|
||||
"health\_check\_method": "string",
|
||||
|
||||
"health\_check\_return\_code": 0,
|
||||
|
||||
"health\_check\_scheme": "string",
|
||||
|
||||
"health\_check\_response\_text": "string",
|
||||
|
||||
"health\_check\_interval": 0,
|
||||
|
||||
"health\_check\_timeout": 0,
|
||||
|
||||
"health\_check\_retries": 0,
|
||||
|
||||
"health\_check\_start\_period": 0,
|
||||
|
||||
"limits\_memory": "string",
|
||||
|
||||
"limits\_memory\_swap": "string",
|
||||
|
||||
"limits\_memory\_swappiness": 0,
|
||||
|
||||
"limits\_memory\_reservation": "string",
|
||||
|
||||
"limits\_cpus": "string",
|
||||
|
||||
"limits\_cpuset": "string",
|
||||
|
||||
"limits\_cpu\_shares": 0,
|
||||
|
||||
"custom\_labels": "string",
|
||||
|
||||
"custom\_docker\_run\_options": "string",
|
||||
|
||||
"post\_deployment\_command": "string",
|
||||
|
||||
"post\_deployment\_command\_container": "string",
|
||||
|
||||
"pre\_deployment\_command": "string",
|
||||
|
||||
"pre\_deployment\_command\_container": "string",
|
||||
|
||||
"manual\_webhook\_secret\_github": "string",
|
||||
|
||||
"manual\_webhook\_secret\_gitlab": "string",
|
||||
|
||||
"manual\_webhook\_secret\_bitbucket": "string",
|
||||
|
||||
"manual\_webhook\_secret\_gitea": "string",
|
||||
|
||||
"redirect": "string",
|
||||
|
||||
"instant\_deploy": true,
|
||||
|
||||
"is\_force\_https\_enabled": true,
|
||||
|
||||
"use\_build\_server": true,
|
||||
|
||||
"is\_http\_basic\_auth\_enabled": true,
|
||||
|
||||
"http\_basic\_auth\_username": "string",
|
||||
|
||||
"http\_basic\_auth\_password": "string",
|
||||
|
||||
"connect\_to\_docker\_network": true,
|
||||
|
||||
"force\_domain\_override": true,
|
||||
|
||||
"autogenerate\_domain": true,
|
||||
|
||||
"is\_container\_label\_escape\_enabled": true
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/create-dockerimage-application#responses)
|
||||
|
||||
------------------------------------------------------------------------------------------------------------
|
||||
|
||||
201400401409
|
||||
|
||||
Application created successfully.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"uuid": "string"
|
||||
|
||||
}
|
||||
|
||||
POST
|
||||
|
||||
/applications/dockerimage
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/create-dockerimage-application#playground)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Body
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/create-dockerimage-application#samples)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,119 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/create-env-by-application-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Create Env[](https://coolify.io/docs/api-reference/api/operations/create-env-by-application-uuid#create-env)
|
||||
|
||||
==============================================================================================================
|
||||
|
||||
POST
|
||||
|
||||
/applications/{uuid}/envs
|
||||
|
||||
Create env by application UUID.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/create-env-by-application-uuid#authorizations)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/create-env-by-application-uuid#parameters)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the application.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/create-env-by-application-uuid#request-body)
|
||||
|
||||
------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"key": "string",
|
||||
|
||||
"value": "string",
|
||||
|
||||
"is\_preview": true,
|
||||
|
||||
"is\_literal": true,
|
||||
|
||||
"is\_multiline": true,
|
||||
|
||||
"is\_shown\_once": true
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/create-env-by-application-uuid#responses)
|
||||
|
||||
------------------------------------------------------------------------------------------------------------
|
||||
|
||||
201400401404
|
||||
|
||||
Environment variable created.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"uuid": "nc0k04gk8g0cgsk440g0koko"
|
||||
|
||||
}
|
||||
|
||||
POST
|
||||
|
||||
/applications/{uuid}/envs
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/create-env-by-application-uuid#playground)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Body
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/create-env-by-application-uuid#samples)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,119 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/create-env-by-service-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Create Env[](https://coolify.io/docs/api-reference/api/operations/create-env-by-service-uuid#create-env)
|
||||
|
||||
==========================================================================================================
|
||||
|
||||
POST
|
||||
|
||||
/services/{uuid}/envs
|
||||
|
||||
Create env by service UUID.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/create-env-by-service-uuid#authorizations)
|
||||
|
||||
------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/create-env-by-service-uuid#parameters)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the service.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/create-env-by-service-uuid#request-body)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"key": "string",
|
||||
|
||||
"value": "string",
|
||||
|
||||
"is\_preview": true,
|
||||
|
||||
"is\_literal": true,
|
||||
|
||||
"is\_multiline": true,
|
||||
|
||||
"is\_shown\_once": true
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/create-env-by-service-uuid#responses)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
201400401404422
|
||||
|
||||
Environment variable created.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"uuid": "nc0k04gk8g0cgsk440g0koko"
|
||||
|
||||
}
|
||||
|
||||
POST
|
||||
|
||||
/services/{uuid}/envs
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/create-env-by-service-uuid#playground)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Body
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/create-env-by-service-uuid#samples)
|
||||
|
||||
----------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,109 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/create-environment#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Create Environment[](https://coolify.io/docs/api-reference/api/operations/create-environment#create-environment)
|
||||
|
||||
==================================================================================================================
|
||||
|
||||
POST
|
||||
|
||||
/projects/{uuid}/environments
|
||||
|
||||
Create environment in project.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/create-environment#authorizations)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/create-environment#parameters)
|
||||
|
||||
--------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
Project UUID
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/create-environment#request-body)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"name": "string"
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/create-environment#responses)
|
||||
|
||||
------------------------------------------------------------------------------------------------
|
||||
|
||||
201
|
||||
|
||||
Environment created.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"uuid": "env123"
|
||||
|
||||
}
|
||||
|
||||
POST
|
||||
|
||||
/projects/{uuid}/environments
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/create-environment#playground)
|
||||
|
||||
--------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Body
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/create-environment#samples)
|
||||
|
||||
--------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,135 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/create-github-app#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Create GitHub App[](https://coolify.io/docs/api-reference/api/operations/create-github-app#create-github-app)
|
||||
|
||||
===============================================================================================================
|
||||
|
||||
POST
|
||||
|
||||
/github-apps
|
||||
|
||||
Create a new GitHub app.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/create-github-app#authorizations)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/create-github-app#request-body)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"name": "string",
|
||||
|
||||
"organization": "string",
|
||||
|
||||
"api\_url": "string",
|
||||
|
||||
"html\_url": "string",
|
||||
|
||||
"custom\_user": "string",
|
||||
|
||||
"custom\_port": 0,
|
||||
|
||||
"app\_id": 0,
|
||||
|
||||
"installation\_id": 0,
|
||||
|
||||
"client\_id": "string",
|
||||
|
||||
"client\_secret": "string",
|
||||
|
||||
"webhook\_secret": "string",
|
||||
|
||||
"private\_key\_uuid": "string",
|
||||
|
||||
"is\_system\_wide": true
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/create-github-app#responses)
|
||||
|
||||
-----------------------------------------------------------------------------------------------
|
||||
|
||||
201400401422
|
||||
|
||||
GitHub app created successfully.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"id": 0,
|
||||
|
||||
"uuid": "string",
|
||||
|
||||
"name": "string",
|
||||
|
||||
"organization": "string",
|
||||
|
||||
"api\_url": "string",
|
||||
|
||||
"html\_url": "string",
|
||||
|
||||
"custom\_user": "string",
|
||||
|
||||
"custom\_port": 0,
|
||||
|
||||
"app\_id": 0,
|
||||
|
||||
"installation\_id": 0,
|
||||
|
||||
"client\_id": "string",
|
||||
|
||||
"private\_key\_id": 0,
|
||||
|
||||
"is\_system\_wide": true,
|
||||
|
||||
"team\_id": 0
|
||||
|
||||
}
|
||||
|
||||
POST
|
||||
|
||||
/github-apps
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/create-github-app#playground)
|
||||
|
||||
-------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Body
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/create-github-app#samples)
|
||||
|
||||
-------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,331 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/create-hetzner-server#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Create Hetzner Server[](https://coolify.io/docs/api-reference/api/operations/create-hetzner-server#create-hetzner-server)
|
||||
|
||||
===========================================================================================================================
|
||||
|
||||
POST
|
||||
|
||||
/servers/hetzner
|
||||
|
||||
Create a new server on Hetzner and register it in Coolify.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/create-hetzner-server#authorizations)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/create-hetzner-server#request-body)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"cloud\_provider\_token\_uuid": "abc123",
|
||||
|
||||
"cloud\_provider\_token\_id": "abc123",
|
||||
|
||||
"location": "nbg1",
|
||||
|
||||
"server\_type": "cx11",
|
||||
|
||||
"image": 15512617,
|
||||
|
||||
"name": "my-server",
|
||||
|
||||
"private\_key\_uuid": "xyz789",
|
||||
|
||||
"enable\_ipv4": true,
|
||||
|
||||
"enable\_ipv6": true,
|
||||
|
||||
"hetzner\_ssh\_key\_ids": \[\
|
||||
\
|
||||
0\
|
||||
\
|
||||
\],
|
||||
|
||||
"cloud\_init\_script": "string",
|
||||
|
||||
"instant\_validate": false
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/create-hetzner-server#responses)
|
||||
|
||||
---------------------------------------------------------------------------------------------------
|
||||
|
||||
201
|
||||
|
||||
Hetzner server created.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"uuid": "og888os",
|
||||
|
||||
"hetzner\_server\_id": 0,
|
||||
|
||||
"ip": "string"
|
||||
|
||||
}
|
||||
|
||||
POST
|
||||
|
||||
/servers/hetzner
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/create-hetzner-server#playground)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Body
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
cloud\_provider\_token\_uuid
|
||||
|
||||
:
|
||||
|
||||
abc123
|
||||
|
||||
cloud\_provider\_token\_id
|
||||
|
||||
:
|
||||
|
||||
abc123
|
||||
|
||||
location
|
||||
|
||||
:
|
||||
|
||||
nbg1
|
||||
|
||||
server\_type
|
||||
|
||||
:
|
||||
|
||||
cx11
|
||||
|
||||
image
|
||||
|
||||
:
|
||||
|
||||
15512617
|
||||
|
||||
name
|
||||
|
||||
:
|
||||
|
||||
my-server
|
||||
|
||||
private\_key\_uuid
|
||||
|
||||
:
|
||||
|
||||
xyz789
|
||||
|
||||
enable\_ipv4
|
||||
|
||||
:
|
||||
|
||||
true
|
||||
|
||||
enable\_ipv6
|
||||
|
||||
:
|
||||
|
||||
true
|
||||
|
||||
hetzner\_ssh\_key\_ids
|
||||
|
||||
:
|
||||
|
||||
\[\
|
||||
\
|
||||
1 item \
|
||||
\
|
||||
0\
|
||||
\
|
||||
:\
|
||||
\
|
||||
0\
|
||||
\
|
||||
\]
|
||||
|
||||
cloud\_init\_script
|
||||
|
||||
:
|
||||
|
||||
string
|
||||
|
||||
instant\_validate
|
||||
|
||||
:
|
||||
|
||||
false
|
||||
|
||||
}
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/create-hetzner-server#samples)
|
||||
|
||||
-----------------------------------------------------------------------------------------------
|
||||
|
||||
BrunocURLJavaScriptPHPPython
|
||||
|
||||
Bruno
|
||||
|
||||
POST https://app.coolify.io/api/v1/servers/hetzner
|
||||
|
||||
Headers
|
||||
authorization: Token
|
||||
content-type: application/json
|
||||
|
||||
Body
|
||||
{
|
||||
"cloud_provider_token_uuid": "abc123",
|
||||
"cloud_provider_token_id": "abc123",
|
||||
"location": "nbg1",
|
||||
"server_type": "cx11",
|
||||
"image": 15512617,
|
||||
"name": "my-server",
|
||||
"private_key_uuid": "xyz789",
|
||||
"enable_ipv4": true,
|
||||
"enable_ipv6": true,
|
||||
"hetzner_ssh_key_ids": [\
|
||||
0\
|
||||
],
|
||||
"cloud_init_script": "string",
|
||||
"instant_validate": false
|
||||
}
|
||||
|
||||
cURL
|
||||
|
||||
curl https://app.coolify.io/api/v1/servers/hetzner \
|
||||
--request POST \
|
||||
--header 'Authorization: Token' \
|
||||
--header 'Content-Type: application/json' \
|
||||
--data '{
|
||||
"cloud_provider_token_uuid": "abc123",
|
||||
"cloud_provider_token_id": "abc123",
|
||||
"location": "nbg1",
|
||||
"server_type": "cx11",
|
||||
"image": 15512617,
|
||||
"name": "my-server",
|
||||
"private_key_uuid": "xyz789",
|
||||
"enable_ipv4": true,
|
||||
"enable_ipv6": true,
|
||||
"hetzner_ssh_key_ids": [\
|
||||
0\
|
||||
],
|
||||
"cloud_init_script": "string",
|
||||
"instant_validate": false
|
||||
}'
|
||||
|
||||
JavaScript
|
||||
|
||||
fetch('https://app.coolify.io/api/v1/servers/hetzner', {
|
||||
method: 'POST',
|
||||
headers: {
|
||||
Authorization: 'Token',
|
||||
'Content-Type': 'application/json'
|
||||
},
|
||||
body: JSON.stringify({
|
||||
cloud_provider_token_uuid: 'abc123',
|
||||
cloud_provider_token_id: 'abc123',
|
||||
location: 'nbg1',
|
||||
server_type: 'cx11',
|
||||
image: 15512617,
|
||||
name: 'my-server',
|
||||
private_key_uuid: 'xyz789',
|
||||
enable_ipv4: true,
|
||||
enable_ipv6: true,
|
||||
hetzner_ssh_key_ids: [0],
|
||||
cloud_init_script: 'string',
|
||||
instant_validate: false
|
||||
})
|
||||
})
|
||||
|
||||
PHP
|
||||
|
||||
$ch = curl_init("https://app.coolify.io/api/v1/servers/hetzner");
|
||||
|
||||
curl_setopt($ch, CURLOPT_POST, true);
|
||||
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Token', 'Content-Type: application/json']);
|
||||
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([\
|
||||
'cloud_provider_token_uuid' => 'abc123',\
|
||||
'cloud_provider_token_id' => 'abc123',\
|
||||
'location' => 'nbg1',\
|
||||
'server_type' => 'cx11',\
|
||||
'image' => 15512617,\
|
||||
'name' => 'my-server',\
|
||||
'private_key_uuid' => 'xyz789',\
|
||||
'enable_ipv4' => true,\
|
||||
'enable_ipv6' => true,\
|
||||
'hetzner_ssh_key_ids' => [\
|
||||
0\
|
||||
],\
|
||||
'cloud_init_script' => 'string',\
|
||||
'instant_validate' => false\
|
||||
]));
|
||||
|
||||
curl_exec($ch);
|
||||
|
||||
curl_close($ch);
|
||||
|
||||
Python
|
||||
|
||||
requests.post(
|
||||
"https://app.coolify.io/api/v1/servers/hetzner",
|
||||
headers={
|
||||
"Authorization": "Token",
|
||||
"Content-Type": "application/json"
|
||||
},
|
||||
json={
|
||||
"cloud_provider_token_uuid": "abc123",
|
||||
"cloud_provider_token_id": "abc123",
|
||||
"location": "nbg1",
|
||||
"server_type": "cx11",
|
||||
"image": 15512617,
|
||||
"name": "my-server",
|
||||
"private_key_uuid": "xyz789",
|
||||
"enable_ipv4": true,
|
||||
"enable_ipv6": true,
|
||||
"hetzner_ssh_key_ids": [\
|
||||
0\
|
||||
],
|
||||
"cloud_init_script": "string",
|
||||
"instant_validate": false
|
||||
}
|
||||
)
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,241 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/create-private-deploy-key-application#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Create (Private - Deploy Key)[](https://coolify.io/docs/api-reference/api/operations/create-private-deploy-key-application#create-private-deploy-key)
|
||||
|
||||
=======================================================================================================================================================
|
||||
|
||||
POST
|
||||
|
||||
/applications/private-deploy-key
|
||||
|
||||
Create new application based on a private repository through a Deploy Key.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/create-private-deploy-key-application#authorizations)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/create-private-deploy-key-application#request-body)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"project\_uuid": "string",
|
||||
|
||||
"server\_uuid": "string",
|
||||
|
||||
"environment\_name": "string",
|
||||
|
||||
"environment\_uuid": "string",
|
||||
|
||||
"private\_key\_uuid": "string",
|
||||
|
||||
"git\_repository": "string",
|
||||
|
||||
"git\_branch": "string",
|
||||
|
||||
"ports\_exposes": "string",
|
||||
|
||||
"destination\_uuid": "string",
|
||||
|
||||
"build\_pack": "string",
|
||||
|
||||
"name": "string",
|
||||
|
||||
"description": "string",
|
||||
|
||||
"domains": "string",
|
||||
|
||||
"git\_commit\_sha": "string",
|
||||
|
||||
"docker\_registry\_image\_name": "string",
|
||||
|
||||
"docker\_registry\_image\_tag": "string",
|
||||
|
||||
"is\_static": true,
|
||||
|
||||
"is\_spa": true,
|
||||
|
||||
"is\_auto\_deploy\_enabled": true,
|
||||
|
||||
"is\_force\_https\_enabled": true,
|
||||
|
||||
"static\_image": "string",
|
||||
|
||||
"install\_command": "string",
|
||||
|
||||
"build\_command": "string",
|
||||
|
||||
"start\_command": "string",
|
||||
|
||||
"ports\_mappings": "string",
|
||||
|
||||
"base\_directory": "string",
|
||||
|
||||
"publish\_directory": "string",
|
||||
|
||||
"health\_check\_enabled": true,
|
||||
|
||||
"health\_check\_path": "string",
|
||||
|
||||
"health\_check\_port": "string",
|
||||
|
||||
"health\_check\_host": "string",
|
||||
|
||||
"health\_check\_method": "string",
|
||||
|
||||
"health\_check\_return\_code": 0,
|
||||
|
||||
"health\_check\_scheme": "string",
|
||||
|
||||
"health\_check\_response\_text": "string",
|
||||
|
||||
"health\_check\_interval": 0,
|
||||
|
||||
"health\_check\_timeout": 0,
|
||||
|
||||
"health\_check\_retries": 0,
|
||||
|
||||
"health\_check\_start\_period": 0,
|
||||
|
||||
"limits\_memory": "string",
|
||||
|
||||
"limits\_memory\_swap": "string",
|
||||
|
||||
"limits\_memory\_swappiness": 0,
|
||||
|
||||
"limits\_memory\_reservation": "string",
|
||||
|
||||
"limits\_cpus": "string",
|
||||
|
||||
"limits\_cpuset": "string",
|
||||
|
||||
"limits\_cpu\_shares": 0,
|
||||
|
||||
"custom\_labels": "string",
|
||||
|
||||
"custom\_docker\_run\_options": "string",
|
||||
|
||||
"post\_deployment\_command": "string",
|
||||
|
||||
"post\_deployment\_command\_container": "string",
|
||||
|
||||
"pre\_deployment\_command": "string",
|
||||
|
||||
"pre\_deployment\_command\_container": "string",
|
||||
|
||||
"manual\_webhook\_secret\_github": "string",
|
||||
|
||||
"manual\_webhook\_secret\_gitlab": "string",
|
||||
|
||||
"manual\_webhook\_secret\_bitbucket": "string",
|
||||
|
||||
"manual\_webhook\_secret\_gitea": "string",
|
||||
|
||||
"redirect": "string",
|
||||
|
||||
"instant\_deploy": true,
|
||||
|
||||
"dockerfile": "string",
|
||||
|
||||
"dockerfile\_location": "string",
|
||||
|
||||
"docker\_compose\_location": "string",
|
||||
|
||||
"docker\_compose\_custom\_start\_command": "string",
|
||||
|
||||
"docker\_compose\_custom\_build\_command": "string",
|
||||
|
||||
"docker\_compose\_domains": \[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"name": "string",\
|
||||
\
|
||||
"domain": "string"\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\],
|
||||
|
||||
"watch\_paths": "string",
|
||||
|
||||
"use\_build\_server": true,
|
||||
|
||||
"is\_http\_basic\_auth\_enabled": true,
|
||||
|
||||
"http\_basic\_auth\_username": "string",
|
||||
|
||||
"http\_basic\_auth\_password": "string",
|
||||
|
||||
"connect\_to\_docker\_network": true,
|
||||
|
||||
"force\_domain\_override": true,
|
||||
|
||||
"autogenerate\_domain": true,
|
||||
|
||||
"is\_container\_label\_escape\_enabled": true,
|
||||
|
||||
"is\_preserve\_repository\_enabled": false
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/create-private-deploy-key-application#responses)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
201400401409
|
||||
|
||||
Application created successfully.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"uuid": "string"
|
||||
|
||||
}
|
||||
|
||||
POST
|
||||
|
||||
/applications/private-deploy-key
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/create-private-deploy-key-application#playground)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Body
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/create-private-deploy-key-application#samples)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,241 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/create-private-github-app-application#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Create (Private - GH App)[](https://coolify.io/docs/api-reference/api/operations/create-private-github-app-application#create-private-gh-app)
|
||||
|
||||
===============================================================================================================================================
|
||||
|
||||
POST
|
||||
|
||||
/applications/private-github-app
|
||||
|
||||
Create new application based on a private repository through a Github App.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/create-private-github-app-application#authorizations)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/create-private-github-app-application#request-body)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"project\_uuid": "string",
|
||||
|
||||
"server\_uuid": "string",
|
||||
|
||||
"environment\_name": "string",
|
||||
|
||||
"environment\_uuid": "string",
|
||||
|
||||
"github\_app\_uuid": "string",
|
||||
|
||||
"git\_repository": "string",
|
||||
|
||||
"git\_branch": "string",
|
||||
|
||||
"ports\_exposes": "string",
|
||||
|
||||
"destination\_uuid": "string",
|
||||
|
||||
"build\_pack": "string",
|
||||
|
||||
"name": "string",
|
||||
|
||||
"description": "string",
|
||||
|
||||
"domains": "string",
|
||||
|
||||
"git\_commit\_sha": "string",
|
||||
|
||||
"docker\_registry\_image\_name": "string",
|
||||
|
||||
"docker\_registry\_image\_tag": "string",
|
||||
|
||||
"is\_static": true,
|
||||
|
||||
"is\_spa": true,
|
||||
|
||||
"is\_auto\_deploy\_enabled": true,
|
||||
|
||||
"is\_force\_https\_enabled": true,
|
||||
|
||||
"static\_image": "string",
|
||||
|
||||
"install\_command": "string",
|
||||
|
||||
"build\_command": "string",
|
||||
|
||||
"start\_command": "string",
|
||||
|
||||
"ports\_mappings": "string",
|
||||
|
||||
"base\_directory": "string",
|
||||
|
||||
"publish\_directory": "string",
|
||||
|
||||
"health\_check\_enabled": true,
|
||||
|
||||
"health\_check\_path": "string",
|
||||
|
||||
"health\_check\_port": "string",
|
||||
|
||||
"health\_check\_host": "string",
|
||||
|
||||
"health\_check\_method": "string",
|
||||
|
||||
"health\_check\_return\_code": 0,
|
||||
|
||||
"health\_check\_scheme": "string",
|
||||
|
||||
"health\_check\_response\_text": "string",
|
||||
|
||||
"health\_check\_interval": 0,
|
||||
|
||||
"health\_check\_timeout": 0,
|
||||
|
||||
"health\_check\_retries": 0,
|
||||
|
||||
"health\_check\_start\_period": 0,
|
||||
|
||||
"limits\_memory": "string",
|
||||
|
||||
"limits\_memory\_swap": "string",
|
||||
|
||||
"limits\_memory\_swappiness": 0,
|
||||
|
||||
"limits\_memory\_reservation": "string",
|
||||
|
||||
"limits\_cpus": "string",
|
||||
|
||||
"limits\_cpuset": "string",
|
||||
|
||||
"limits\_cpu\_shares": 0,
|
||||
|
||||
"custom\_labels": "string",
|
||||
|
||||
"custom\_docker\_run\_options": "string",
|
||||
|
||||
"post\_deployment\_command": "string",
|
||||
|
||||
"post\_deployment\_command\_container": "string",
|
||||
|
||||
"pre\_deployment\_command": "string",
|
||||
|
||||
"pre\_deployment\_command\_container": "string",
|
||||
|
||||
"manual\_webhook\_secret\_github": "string",
|
||||
|
||||
"manual\_webhook\_secret\_gitlab": "string",
|
||||
|
||||
"manual\_webhook\_secret\_bitbucket": "string",
|
||||
|
||||
"manual\_webhook\_secret\_gitea": "string",
|
||||
|
||||
"redirect": "string",
|
||||
|
||||
"instant\_deploy": true,
|
||||
|
||||
"dockerfile": "string",
|
||||
|
||||
"dockerfile\_location": "string",
|
||||
|
||||
"docker\_compose\_location": "string",
|
||||
|
||||
"docker\_compose\_custom\_start\_command": "string",
|
||||
|
||||
"docker\_compose\_custom\_build\_command": "string",
|
||||
|
||||
"docker\_compose\_domains": \[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"name": "string",\
|
||||
\
|
||||
"domain": "string"\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\],
|
||||
|
||||
"watch\_paths": "string",
|
||||
|
||||
"use\_build\_server": true,
|
||||
|
||||
"is\_http\_basic\_auth\_enabled": true,
|
||||
|
||||
"http\_basic\_auth\_username": "string",
|
||||
|
||||
"http\_basic\_auth\_password": "string",
|
||||
|
||||
"connect\_to\_docker\_network": true,
|
||||
|
||||
"force\_domain\_override": true,
|
||||
|
||||
"autogenerate\_domain": true,
|
||||
|
||||
"is\_container\_label\_escape\_enabled": true,
|
||||
|
||||
"is\_preserve\_repository\_enabled": false
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/create-private-github-app-application#responses)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
201400401409
|
||||
|
||||
Application created successfully.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"uuid": "string"
|
||||
|
||||
}
|
||||
|
||||
POST
|
||||
|
||||
/applications/private-github-app
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/create-private-github-app-application#playground)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Body
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/create-private-github-app-application#samples)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,89 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/create-private-key#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Create[](https://coolify.io/docs/api-reference/api/operations/create-private-key#create)
|
||||
|
||||
==========================================================================================
|
||||
|
||||
POST
|
||||
|
||||
/security/keys
|
||||
|
||||
Create a new private key.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/create-private-key#authorizations)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/create-private-key#request-body)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"name": "string",
|
||||
|
||||
"description": "string",
|
||||
|
||||
"private\_key": "string"
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/create-private-key#responses)
|
||||
|
||||
------------------------------------------------------------------------------------------------
|
||||
|
||||
201400401422
|
||||
|
||||
The created private key's UUID.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"uuid": "string"
|
||||
|
||||
}
|
||||
|
||||
POST
|
||||
|
||||
/security/keys
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/create-private-key#playground)
|
||||
|
||||
--------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Body
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/create-private-key#samples)
|
||||
|
||||
--------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,87 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/create-project#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Create[](https://coolify.io/docs/api-reference/api/operations/create-project#create)
|
||||
|
||||
======================================================================================
|
||||
|
||||
POST
|
||||
|
||||
/projects
|
||||
|
||||
Create Project.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/create-project#authorizations)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/create-project#request-body)
|
||||
|
||||
--------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"name": "string",
|
||||
|
||||
"description": "string"
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/create-project#responses)
|
||||
|
||||
--------------------------------------------------------------------------------------------
|
||||
|
||||
201400401404422
|
||||
|
||||
Project created.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"uuid": "og888os"
|
||||
|
||||
}
|
||||
|
||||
POST
|
||||
|
||||
/projects
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/create-project#playground)
|
||||
|
||||
----------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Body
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/create-project#samples)
|
||||
|
||||
----------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,239 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/create-public-application#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Create (Public)[](https://coolify.io/docs/api-reference/api/operations/create-public-application#create-public)
|
||||
|
||||
=================================================================================================================
|
||||
|
||||
POST
|
||||
|
||||
/applications/public
|
||||
|
||||
Create new application based on a public git repository.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/create-public-application#authorizations)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/create-public-application#request-body)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"project\_uuid": "string",
|
||||
|
||||
"server\_uuid": "string",
|
||||
|
||||
"environment\_name": "string",
|
||||
|
||||
"environment\_uuid": "string",
|
||||
|
||||
"git\_repository": "string",
|
||||
|
||||
"git\_branch": "string",
|
||||
|
||||
"build\_pack": "string",
|
||||
|
||||
"ports\_exposes": "string",
|
||||
|
||||
"destination\_uuid": "string",
|
||||
|
||||
"name": "string",
|
||||
|
||||
"description": "string",
|
||||
|
||||
"domains": "string",
|
||||
|
||||
"git\_commit\_sha": "string",
|
||||
|
||||
"docker\_registry\_image\_name": "string",
|
||||
|
||||
"docker\_registry\_image\_tag": "string",
|
||||
|
||||
"is\_static": true,
|
||||
|
||||
"is\_spa": true,
|
||||
|
||||
"is\_auto\_deploy\_enabled": true,
|
||||
|
||||
"is\_force\_https\_enabled": true,
|
||||
|
||||
"static\_image": "string",
|
||||
|
||||
"install\_command": "string",
|
||||
|
||||
"build\_command": "string",
|
||||
|
||||
"start\_command": "string",
|
||||
|
||||
"ports\_mappings": "string",
|
||||
|
||||
"base\_directory": "string",
|
||||
|
||||
"publish\_directory": "string",
|
||||
|
||||
"health\_check\_enabled": true,
|
||||
|
||||
"health\_check\_path": "string",
|
||||
|
||||
"health\_check\_port": "string",
|
||||
|
||||
"health\_check\_host": "string",
|
||||
|
||||
"health\_check\_method": "string",
|
||||
|
||||
"health\_check\_return\_code": 0,
|
||||
|
||||
"health\_check\_scheme": "string",
|
||||
|
||||
"health\_check\_response\_text": "string",
|
||||
|
||||
"health\_check\_interval": 0,
|
||||
|
||||
"health\_check\_timeout": 0,
|
||||
|
||||
"health\_check\_retries": 0,
|
||||
|
||||
"health\_check\_start\_period": 0,
|
||||
|
||||
"limits\_memory": "string",
|
||||
|
||||
"limits\_memory\_swap": "string",
|
||||
|
||||
"limits\_memory\_swappiness": 0,
|
||||
|
||||
"limits\_memory\_reservation": "string",
|
||||
|
||||
"limits\_cpus": "string",
|
||||
|
||||
"limits\_cpuset": "string",
|
||||
|
||||
"limits\_cpu\_shares": 0,
|
||||
|
||||
"custom\_labels": "string",
|
||||
|
||||
"custom\_docker\_run\_options": "string",
|
||||
|
||||
"post\_deployment\_command": "string",
|
||||
|
||||
"post\_deployment\_command\_container": "string",
|
||||
|
||||
"pre\_deployment\_command": "string",
|
||||
|
||||
"pre\_deployment\_command\_container": "string",
|
||||
|
||||
"manual\_webhook\_secret\_github": "string",
|
||||
|
||||
"manual\_webhook\_secret\_gitlab": "string",
|
||||
|
||||
"manual\_webhook\_secret\_bitbucket": "string",
|
||||
|
||||
"manual\_webhook\_secret\_gitea": "string",
|
||||
|
||||
"redirect": "string",
|
||||
|
||||
"instant\_deploy": true,
|
||||
|
||||
"dockerfile": "string",
|
||||
|
||||
"dockerfile\_location": "string",
|
||||
|
||||
"docker\_compose\_location": "string",
|
||||
|
||||
"docker\_compose\_custom\_start\_command": "string",
|
||||
|
||||
"docker\_compose\_custom\_build\_command": "string",
|
||||
|
||||
"docker\_compose\_domains": \[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"name": "string",\
|
||||
\
|
||||
"domain": "string"\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\],
|
||||
|
||||
"watch\_paths": "string",
|
||||
|
||||
"use\_build\_server": true,
|
||||
|
||||
"is\_http\_basic\_auth\_enabled": true,
|
||||
|
||||
"http\_basic\_auth\_username": "string",
|
||||
|
||||
"http\_basic\_auth\_password": "string",
|
||||
|
||||
"connect\_to\_docker\_network": true,
|
||||
|
||||
"force\_domain\_override": true,
|
||||
|
||||
"autogenerate\_domain": true,
|
||||
|
||||
"is\_container\_label\_escape\_enabled": true,
|
||||
|
||||
"is\_preserve\_repository\_enabled": false
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/create-public-application#responses)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------
|
||||
|
||||
201400401409
|
||||
|
||||
Application created successfully.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"uuid": "string"
|
||||
|
||||
}
|
||||
|
||||
POST
|
||||
|
||||
/applications/public
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/create-public-application#playground)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Body
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/create-public-application#samples)
|
||||
|
||||
---------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,101 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/create-server#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Create[](https://coolify.io/docs/api-reference/api/operations/create-server#create)
|
||||
|
||||
=====================================================================================
|
||||
|
||||
POST
|
||||
|
||||
/servers
|
||||
|
||||
Create Server.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/create-server#authorizations)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/create-server#request-body)
|
||||
|
||||
-------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"name": "My Server",
|
||||
|
||||
"description": "My Server Description",
|
||||
|
||||
"ip": "127.0.0.1",
|
||||
|
||||
"port": 22,
|
||||
|
||||
"user": "root",
|
||||
|
||||
"private\_key\_uuid": "og888os",
|
||||
|
||||
"is\_build\_server": false,
|
||||
|
||||
"instant\_validate": false,
|
||||
|
||||
"proxy\_type": "traefik"
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/create-server#responses)
|
||||
|
||||
-------------------------------------------------------------------------------------------
|
||||
|
||||
201400401404422
|
||||
|
||||
Server created.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"uuid": "og888os"
|
||||
|
||||
}
|
||||
|
||||
POST
|
||||
|
||||
/servers
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/create-server#playground)
|
||||
|
||||
---------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Body
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/create-server#samples)
|
||||
|
||||
---------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,125 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/create-service#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Create service[](https://coolify.io/docs/api-reference/api/operations/create-service#create-service)
|
||||
|
||||
======================================================================================================
|
||||
|
||||
POST
|
||||
|
||||
/services
|
||||
|
||||
Create a one-click / custom service
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/create-service#authorizations)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/create-service#request-body)
|
||||
|
||||
--------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"type": "string",
|
||||
|
||||
"name": "string",
|
||||
|
||||
"description": "string",
|
||||
|
||||
"project\_uuid": "string",
|
||||
|
||||
"environment\_name": "string",
|
||||
|
||||
"environment\_uuid": "string",
|
||||
|
||||
"server\_uuid": "string",
|
||||
|
||||
"destination\_uuid": "string",
|
||||
|
||||
"instant\_deploy": false,
|
||||
|
||||
"docker\_compose\_raw": "string",
|
||||
|
||||
"urls": \[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"name": "string",\
|
||||
\
|
||||
"url": "string"\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\],
|
||||
|
||||
"force\_domain\_override": false,
|
||||
|
||||
"is\_container\_label\_escape\_enabled": true
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/create-service#responses)
|
||||
|
||||
--------------------------------------------------------------------------------------------
|
||||
|
||||
201400401409422
|
||||
|
||||
Service created successfully.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"uuid": "string",
|
||||
|
||||
"domains": \[\
|
||||
\
|
||||
"string"\
|
||||
\
|
||||
\]
|
||||
|
||||
}
|
||||
|
||||
POST
|
||||
|
||||
/services
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/create-service#playground)
|
||||
|
||||
----------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Body
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/create-service#samples)
|
||||
|
||||
----------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,149 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/delete-application-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Delete[](https://coolify.io/docs/api-reference/api/operations/delete-application-by-uuid#delete)
|
||||
|
||||
==================================================================================================
|
||||
|
||||
DELETE
|
||||
|
||||
/applications/{uuid}
|
||||
|
||||
Delete application by UUID.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/delete-application-by-uuid#authorizations)
|
||||
|
||||
------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/delete-application-by-uuid#parameters)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the application.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
### Query Parameters
|
||||
|
||||
delete\_configurations
|
||||
|
||||
Delete configurations.
|
||||
|
||||
Type
|
||||
|
||||
boolean
|
||||
|
||||
Default
|
||||
|
||||
`true`
|
||||
|
||||
delete\_volumes
|
||||
|
||||
Delete volumes.
|
||||
|
||||
Type
|
||||
|
||||
boolean
|
||||
|
||||
Default
|
||||
|
||||
`true`
|
||||
|
||||
docker\_cleanup
|
||||
|
||||
Run docker cleanup.
|
||||
|
||||
Type
|
||||
|
||||
boolean
|
||||
|
||||
Default
|
||||
|
||||
`true`
|
||||
|
||||
delete\_connected\_networks
|
||||
|
||||
Delete connected networks.
|
||||
|
||||
Type
|
||||
|
||||
boolean
|
||||
|
||||
Default
|
||||
|
||||
`true`
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/delete-application-by-uuid#responses)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
Application deleted.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"message": "Application deleted."
|
||||
|
||||
}
|
||||
|
||||
DELETE
|
||||
|
||||
/applications/{uuid}
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/delete-application-by-uuid#playground)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
delete\_configurations
|
||||
|
||||
delete\_volumes
|
||||
|
||||
docker\_cleanup
|
||||
|
||||
delete\_connected\_networks
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/delete-application-by-uuid#samples)
|
||||
|
||||
----------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,119 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/delete-backup-configuration-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Delete backup configuration[](https://coolify.io/docs/api-reference/api/operations/delete-backup-configuration-by-uuid#delete-backup-configuration)
|
||||
|
||||
=====================================================================================================================================================
|
||||
|
||||
DELETE
|
||||
|
||||
/databases/{uuid}/backups/{scheduled\_backup\_uuid}
|
||||
|
||||
Deletes a backup configuration and all its executions.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/delete-backup-configuration-by-uuid#authorizations)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/delete-backup-configuration-by-uuid#parameters)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the database
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
scheduled\_backup\_uuid\*
|
||||
|
||||
UUID of the backup configuration to delete
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
### Query Parameters
|
||||
|
||||
delete\_s3
|
||||
|
||||
Whether to delete all backup files from S3
|
||||
|
||||
Type
|
||||
|
||||
boolean
|
||||
|
||||
Default
|
||||
|
||||
`false`
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/delete-backup-configuration-by-uuid#responses)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------------------
|
||||
|
||||
200404
|
||||
|
||||
Backup configuration deleted.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"message": "Backup configuration and all executions deleted."
|
||||
|
||||
}
|
||||
|
||||
DELETE
|
||||
|
||||
/databases/{uuid}/backups/{scheduled\_backup\_uuid}
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/delete-backup-configuration-by-uuid#playground)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
scheduled\_backup\_uuid\*
|
||||
|
||||
delete\_s3
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/delete-backup-configuration-by-uuid#samples)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,131 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/delete-backup-execution-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Delete backup execution[](https://coolify.io/docs/api-reference/api/operations/delete-backup-execution-by-uuid#delete-backup-execution)
|
||||
|
||||
=========================================================================================================================================
|
||||
|
||||
DELETE
|
||||
|
||||
/databases/{uuid}/backups/{scheduled\_backup\_uuid}/executions/{execution\_uuid}
|
||||
|
||||
Deletes a specific backup execution.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/delete-backup-execution-by-uuid#authorizations)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/delete-backup-execution-by-uuid#parameters)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the database
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
scheduled\_backup\_uuid\*
|
||||
|
||||
UUID of the backup configuration
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
execution\_uuid\*
|
||||
|
||||
UUID of the backup execution to delete
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
### Query Parameters
|
||||
|
||||
delete\_s3
|
||||
|
||||
Whether to delete the backup from S3
|
||||
|
||||
Type
|
||||
|
||||
boolean
|
||||
|
||||
Default
|
||||
|
||||
`false`
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/delete-backup-execution-by-uuid#responses)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------
|
||||
|
||||
200404
|
||||
|
||||
Backup execution deleted.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"message": "Backup execution deleted."
|
||||
|
||||
}
|
||||
|
||||
DELETE
|
||||
|
||||
/databases/{uuid}/backups/{scheduled\_backup\_uuid}/executions/{execution\_uuid}
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/delete-backup-execution-by-uuid#playground)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
scheduled\_backup\_uuid\*
|
||||
|
||||
execution\_uuid\*
|
||||
|
||||
delete\_s3
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/delete-backup-execution-by-uuid#samples)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,91 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/delete-cloud-token-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Delete Cloud Provider Token[](https://coolify.io/docs/api-reference/api/operations/delete-cloud-token-by-uuid#delete-cloud-provider-token)
|
||||
|
||||
============================================================================================================================================
|
||||
|
||||
DELETE
|
||||
|
||||
/cloud-tokens/{uuid}
|
||||
|
||||
Delete cloud provider token by UUID. Cannot delete if token is used by any servers.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/delete-cloud-token-by-uuid#authorizations)
|
||||
|
||||
------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/delete-cloud-token-by-uuid#parameters)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the cloud provider token.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/delete-cloud-token-by-uuid#responses)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
Cloud provider token deleted.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"message": "Cloud provider token deleted."
|
||||
|
||||
}
|
||||
|
||||
DELETE
|
||||
|
||||
/cloud-tokens/{uuid}
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/delete-cloud-token-by-uuid#playground)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/delete-cloud-token-by-uuid#samples)
|
||||
|
||||
----------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,149 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/delete-database-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Delete[](https://coolify.io/docs/api-reference/api/operations/delete-database-by-uuid#delete)
|
||||
|
||||
===============================================================================================
|
||||
|
||||
DELETE
|
||||
|
||||
/databases/{uuid}
|
||||
|
||||
Delete database by UUID.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/delete-database-by-uuid#authorizations)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/delete-database-by-uuid#parameters)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the database.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
### Query Parameters
|
||||
|
||||
delete\_configurations
|
||||
|
||||
Delete configurations.
|
||||
|
||||
Type
|
||||
|
||||
boolean
|
||||
|
||||
Default
|
||||
|
||||
`true`
|
||||
|
||||
delete\_volumes
|
||||
|
||||
Delete volumes.
|
||||
|
||||
Type
|
||||
|
||||
boolean
|
||||
|
||||
Default
|
||||
|
||||
`true`
|
||||
|
||||
docker\_cleanup
|
||||
|
||||
Run docker cleanup.
|
||||
|
||||
Type
|
||||
|
||||
boolean
|
||||
|
||||
Default
|
||||
|
||||
`true`
|
||||
|
||||
delete\_connected\_networks
|
||||
|
||||
Delete connected networks.
|
||||
|
||||
Type
|
||||
|
||||
boolean
|
||||
|
||||
Default
|
||||
|
||||
`true`
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/delete-database-by-uuid#responses)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
Database deleted.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"message": "Database deleted."
|
||||
|
||||
}
|
||||
|
||||
DELETE
|
||||
|
||||
/databases/{uuid}
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/delete-database-by-uuid#playground)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
delete\_configurations
|
||||
|
||||
delete\_volumes
|
||||
|
||||
docker\_cleanup
|
||||
|
||||
delete\_connected\_networks
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/delete-database-by-uuid#samples)
|
||||
|
||||
-------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,103 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/delete-env-by-application-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Delete Env[](https://coolify.io/docs/api-reference/api/operations/delete-env-by-application-uuid#delete-env)
|
||||
|
||||
==============================================================================================================
|
||||
|
||||
DELETE
|
||||
|
||||
/applications/{uuid}/envs/{env\_uuid}
|
||||
|
||||
Delete env by UUID.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/delete-env-by-application-uuid#authorizations)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/delete-env-by-application-uuid#parameters)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the application.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
env\_uuid\*
|
||||
|
||||
UUID of the environment variable.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/delete-env-by-application-uuid#responses)
|
||||
|
||||
------------------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
Environment variable deleted.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"message": "Environment variable deleted."
|
||||
|
||||
}
|
||||
|
||||
DELETE
|
||||
|
||||
/applications/{uuid}/envs/{env\_uuid}
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/delete-env-by-application-uuid#playground)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
env\_uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/delete-env-by-application-uuid#samples)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,103 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/delete-env-by-service-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Delete Env[](https://coolify.io/docs/api-reference/api/operations/delete-env-by-service-uuid#delete-env)
|
||||
|
||||
==========================================================================================================
|
||||
|
||||
DELETE
|
||||
|
||||
/services/{uuid}/envs/{env\_uuid}
|
||||
|
||||
Delete env by UUID.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/delete-env-by-service-uuid#authorizations)
|
||||
|
||||
------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/delete-env-by-service-uuid#parameters)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the service.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
env\_uuid\*
|
||||
|
||||
UUID of the environment variable.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/delete-env-by-service-uuid#responses)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
Environment variable deleted.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"message": "Environment variable deleted."
|
||||
|
||||
}
|
||||
|
||||
DELETE
|
||||
|
||||
/services/{uuid}/envs/{env\_uuid}
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/delete-env-by-service-uuid#playground)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
env\_uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/delete-env-by-service-uuid#samples)
|
||||
|
||||
----------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,103 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/delete-environment#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Delete Environment[](https://coolify.io/docs/api-reference/api/operations/delete-environment#delete-environment)
|
||||
|
||||
==================================================================================================================
|
||||
|
||||
DELETE
|
||||
|
||||
/projects/{uuid}/environments/{environment\_name\_or\_uuid}
|
||||
|
||||
Delete environment by name or UUID. Environment must be empty.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/delete-environment#authorizations)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/delete-environment#parameters)
|
||||
|
||||
--------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
Project UUID
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
environment\_name\_or\_uuid\*
|
||||
|
||||
Environment name or UUID
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/delete-environment#responses)
|
||||
|
||||
------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404422
|
||||
|
||||
Environment deleted.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"message": "Environment deleted."
|
||||
|
||||
}
|
||||
|
||||
DELETE
|
||||
|
||||
/projects/{uuid}/environments/{environment\_name\_or\_uuid}
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/delete-environment#playground)
|
||||
|
||||
--------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
environment\_name\_or\_uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/delete-environment#samples)
|
||||
|
||||
--------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,91 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/delete-private-key-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Delete[](https://coolify.io/docs/api-reference/api/operations/delete-private-key-by-uuid#delete)
|
||||
|
||||
==================================================================================================
|
||||
|
||||
DELETE
|
||||
|
||||
/security/keys/{uuid}
|
||||
|
||||
Delete a private key.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/delete-private-key-by-uuid#authorizations)
|
||||
|
||||
------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/delete-private-key-by-uuid#parameters)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
Private Key UUID
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/delete-private-key-by-uuid#responses)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404422
|
||||
|
||||
Private Key deleted.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"message": "Private Key deleted."
|
||||
|
||||
}
|
||||
|
||||
DELETE
|
||||
|
||||
/security/keys/{uuid}
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/delete-private-key-by-uuid#playground)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/delete-private-key-by-uuid#samples)
|
||||
|
||||
----------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,91 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/delete-project-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Delete[](https://coolify.io/docs/api-reference/api/operations/delete-project-by-uuid#delete)
|
||||
|
||||
==============================================================================================
|
||||
|
||||
DELETE
|
||||
|
||||
/projects/{uuid}
|
||||
|
||||
Delete project by UUID.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/delete-project-by-uuid#authorizations)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/delete-project-by-uuid#parameters)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the application.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/delete-project-by-uuid#responses)
|
||||
|
||||
----------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404422
|
||||
|
||||
Project deleted.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"message": "Project deleted."
|
||||
|
||||
}
|
||||
|
||||
DELETE
|
||||
|
||||
/projects/{uuid}
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/delete-project-by-uuid#playground)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/delete-project-by-uuid#samples)
|
||||
|
||||
------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,91 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/delete-server-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Delete[](https://coolify.io/docs/api-reference/api/operations/delete-server-by-uuid#delete)
|
||||
|
||||
=============================================================================================
|
||||
|
||||
DELETE
|
||||
|
||||
/servers/{uuid}
|
||||
|
||||
Delete server by UUID.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/delete-server-by-uuid#authorizations)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/delete-server-by-uuid#parameters)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the server.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/delete-server-by-uuid#responses)
|
||||
|
||||
---------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404422
|
||||
|
||||
Server deleted.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"message": "Server deleted."
|
||||
|
||||
}
|
||||
|
||||
DELETE
|
||||
|
||||
/servers/{uuid}
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/delete-server-by-uuid#playground)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/delete-server-by-uuid#samples)
|
||||
|
||||
-----------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,149 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/delete-service-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Delete[](https://coolify.io/docs/api-reference/api/operations/delete-service-by-uuid#delete)
|
||||
|
||||
==============================================================================================
|
||||
|
||||
DELETE
|
||||
|
||||
/services/{uuid}
|
||||
|
||||
Delete service by UUID.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/delete-service-by-uuid#authorizations)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/delete-service-by-uuid#parameters)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
Service UUID
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
### Query Parameters
|
||||
|
||||
delete\_configurations
|
||||
|
||||
Delete configurations.
|
||||
|
||||
Type
|
||||
|
||||
boolean
|
||||
|
||||
Default
|
||||
|
||||
`true`
|
||||
|
||||
delete\_volumes
|
||||
|
||||
Delete volumes.
|
||||
|
||||
Type
|
||||
|
||||
boolean
|
||||
|
||||
Default
|
||||
|
||||
`true`
|
||||
|
||||
docker\_cleanup
|
||||
|
||||
Run docker cleanup.
|
||||
|
||||
Type
|
||||
|
||||
boolean
|
||||
|
||||
Default
|
||||
|
||||
`true`
|
||||
|
||||
delete\_connected\_networks
|
||||
|
||||
Delete connected networks.
|
||||
|
||||
Type
|
||||
|
||||
boolean
|
||||
|
||||
Default
|
||||
|
||||
`true`
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/delete-service-by-uuid#responses)
|
||||
|
||||
----------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
Delete a service by UUID
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"message": "Service deletion request queued."
|
||||
|
||||
}
|
||||
|
||||
DELETE
|
||||
|
||||
/services/{uuid}
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/delete-service-by-uuid#playground)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
delete\_configurations
|
||||
|
||||
delete\_volumes
|
||||
|
||||
docker\_cleanup
|
||||
|
||||
delete\_connected\_networks
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/delete-service-by-uuid#samples)
|
||||
|
||||
------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,91 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/deleteGithubApp#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Delete GitHub App[](https://coolify.io/docs/api-reference/api/operations/deleteGithubApp#delete-github-app)
|
||||
|
||||
=============================================================================================================
|
||||
|
||||
DELETE
|
||||
|
||||
/github-apps/{github\_app\_id}
|
||||
|
||||
Delete a GitHub app if it's not being used by any applications.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/deleteGithubApp#authorizations)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/deleteGithubApp#parameters)
|
||||
|
||||
-----------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
github\_app\_id\*
|
||||
|
||||
GitHub App ID
|
||||
|
||||
Type
|
||||
|
||||
integer
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/deleteGithubApp#responses)
|
||||
|
||||
---------------------------------------------------------------------------------------------
|
||||
|
||||
200401404409
|
||||
|
||||
GitHub app deleted successfully
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"message": "GitHub app deleted successfully"
|
||||
|
||||
}
|
||||
|
||||
DELETE
|
||||
|
||||
/github-apps/{github\_app\_id}
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/deleteGithubApp#playground)
|
||||
|
||||
-----------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
github\_app\_id\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/deleteGithubApp#samples)
|
||||
|
||||
-----------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,151 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/deploy-by-tag-or-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Deploy[](https://coolify.io/docs/api-reference/api/operations/deploy-by-tag-or-uuid#deploy)
|
||||
|
||||
=============================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/deploy
|
||||
|
||||
Deploy by tag or uuid. `Post` request also accepted with `uuid` and `tag` json body.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/deploy-by-tag-or-uuid#authorizations)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/deploy-by-tag-or-uuid#parameters)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------
|
||||
|
||||
### Query Parameters
|
||||
|
||||
tag
|
||||
|
||||
Tag name(s). Comma separated list is also accepted.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
uuid
|
||||
|
||||
Resource UUID(s). Comma separated list is also accepted.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
force
|
||||
|
||||
Force rebuild (without cache)
|
||||
|
||||
Type
|
||||
|
||||
boolean
|
||||
|
||||
pr
|
||||
|
||||
Pull Request Id for deploying specific PR builds. Cannot be used with tag parameter.
|
||||
|
||||
Type
|
||||
|
||||
integer
|
||||
|
||||
pull\_request\_id
|
||||
|
||||
Preview deployment identifier. Alias of pr.
|
||||
|
||||
Type
|
||||
|
||||
integer
|
||||
|
||||
docker\_tag
|
||||
|
||||
Docker image tag for Docker Image preview deployments. Requires pull\_request\_id.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/deploy-by-tag-or-uuid#responses)
|
||||
|
||||
---------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401
|
||||
|
||||
Get deployment(s) UUID's
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"deployments": \[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"message": "string",\
|
||||
\
|
||||
"resource\_uuid": "string",\
|
||||
\
|
||||
"deployment\_uuid": "string"\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]
|
||||
|
||||
}
|
||||
|
||||
GET
|
||||
|
||||
/deploy
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/deploy-by-tag-or-uuid#playground)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
tag
|
||||
|
||||
uuid
|
||||
|
||||
force
|
||||
|
||||
pr
|
||||
|
||||
pull\_request\_id
|
||||
|
||||
docker\_tag
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/deploy-by-tag-or-uuid#samples)
|
||||
|
||||
-----------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,67 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/disable-api#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Disable API[](https://coolify.io/docs/api-reference/api/operations/disable-api#disable-api)
|
||||
|
||||
=============================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/disable
|
||||
|
||||
Disable API (only with root permissions).
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/disable-api#authorizations)
|
||||
|
||||
---------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/disable-api#responses)
|
||||
|
||||
-----------------------------------------------------------------------------------------
|
||||
|
||||
200400401403
|
||||
|
||||
Disable API.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"message": "API disabled."
|
||||
|
||||
}
|
||||
|
||||
GET
|
||||
|
||||
/disable
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/disable-api#playground)
|
||||
|
||||
-------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/disable-api#samples)
|
||||
|
||||
-------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,108 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/enable-api#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Enable API[](https://coolify.io/docs/api-reference/api/operations/enable-api#enable-api)
|
||||
|
||||
==========================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/enable
|
||||
|
||||
Enable API (only with root permissions).
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/enable-api#authorizations)
|
||||
|
||||
--------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/enable-api#responses)
|
||||
|
||||
----------------------------------------------------------------------------------------
|
||||
|
||||
200400401403
|
||||
|
||||
Enable API.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"message": "API enabled."
|
||||
|
||||
}
|
||||
|
||||
GET
|
||||
|
||||
/enable
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/enable-api#playground)
|
||||
|
||||
------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/enable-api#samples)
|
||||
|
||||
------------------------------------------------------------------------------------
|
||||
|
||||
BrunocURLJavaScriptPHPPython
|
||||
|
||||
Bruno
|
||||
|
||||
GET https://app.coolify.io/api/v1/enable
|
||||
|
||||
Headers
|
||||
authorization: Token
|
||||
|
||||
|
||||
cURL
|
||||
|
||||
curl https://app.coolify.io/api/v1/enable \
|
||||
--header 'Authorization: Token'
|
||||
|
||||
JavaScript
|
||||
|
||||
fetch('https://app.coolify.io/api/v1/enable', {
|
||||
headers: {
|
||||
Authorization: 'Token'
|
||||
}
|
||||
})
|
||||
|
||||
PHP
|
||||
|
||||
$ch = curl_init("https://app.coolify.io/api/v1/enable");
|
||||
|
||||
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Token']);
|
||||
|
||||
curl_exec($ch);
|
||||
|
||||
curl_close($ch);
|
||||
|
||||
Python
|
||||
|
||||
requests.get("https://app.coolify.io/api/v1/enable",
|
||||
headers={
|
||||
"Authorization": "Token"
|
||||
}
|
||||
)
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,297 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/get-application-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Get[](https://coolify.io/docs/api-reference/api/operations/get-application-by-uuid#get)
|
||||
|
||||
=========================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/applications/{uuid}
|
||||
|
||||
Get application by UUID.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/get-application-by-uuid#authorizations)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/get-application-by-uuid#parameters)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the application.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/get-application-by-uuid#responses)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
Get application by UUID.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"id": 0,
|
||||
|
||||
"description": "string",
|
||||
|
||||
"repository\_project\_id": 0,
|
||||
|
||||
"uuid": "string",
|
||||
|
||||
"name": "string",
|
||||
|
||||
"fqdn": "string",
|
||||
|
||||
"config\_hash": "string",
|
||||
|
||||
"git\_repository": "string",
|
||||
|
||||
"git\_branch": "string",
|
||||
|
||||
"git\_commit\_sha": "string",
|
||||
|
||||
"git\_full\_url": "string",
|
||||
|
||||
"docker\_registry\_image\_name": "string",
|
||||
|
||||
"docker\_registry\_image\_tag": "string",
|
||||
|
||||
"build\_pack": "string",
|
||||
|
||||
"static\_image": "string",
|
||||
|
||||
"install\_command": "string",
|
||||
|
||||
"build\_command": "string",
|
||||
|
||||
"start\_command": "string",
|
||||
|
||||
"ports\_exposes": "string",
|
||||
|
||||
"ports\_mappings": "string",
|
||||
|
||||
"custom\_network\_aliases": "string",
|
||||
|
||||
"base\_directory": "string",
|
||||
|
||||
"publish\_directory": "string",
|
||||
|
||||
"health\_check\_enabled": true,
|
||||
|
||||
"health\_check\_path": "string",
|
||||
|
||||
"health\_check\_port": "string",
|
||||
|
||||
"health\_check\_host": "string",
|
||||
|
||||
"health\_check\_method": "string",
|
||||
|
||||
"health\_check\_return\_code": 0,
|
||||
|
||||
"health\_check\_scheme": "string",
|
||||
|
||||
"health\_check\_response\_text": "string",
|
||||
|
||||
"health\_check\_interval": 0,
|
||||
|
||||
"health\_check\_timeout": 0,
|
||||
|
||||
"health\_check\_retries": 0,
|
||||
|
||||
"health\_check\_start\_period": 0,
|
||||
|
||||
"health\_check\_type": "string",
|
||||
|
||||
"health\_check\_command": "string",
|
||||
|
||||
"limits\_memory": "string",
|
||||
|
||||
"limits\_memory\_swap": "string",
|
||||
|
||||
"limits\_memory\_swappiness": 0,
|
||||
|
||||
"limits\_memory\_reservation": "string",
|
||||
|
||||
"limits\_cpus": "string",
|
||||
|
||||
"limits\_cpuset": "string",
|
||||
|
||||
"limits\_cpu\_shares": 0,
|
||||
|
||||
"status": "string",
|
||||
|
||||
"preview\_url\_template": "string",
|
||||
|
||||
"destination\_type": "string",
|
||||
|
||||
"destination\_id": 0,
|
||||
|
||||
"source\_id": 0,
|
||||
|
||||
"private\_key\_id": 0,
|
||||
|
||||
"environment\_id": 0,
|
||||
|
||||
"dockerfile": "string",
|
||||
|
||||
"dockerfile\_location": "string",
|
||||
|
||||
"custom\_labels": "string",
|
||||
|
||||
"dockerfile\_target\_build": "string",
|
||||
|
||||
"manual\_webhook\_secret\_github": "string",
|
||||
|
||||
"manual\_webhook\_secret\_gitlab": "string",
|
||||
|
||||
"manual\_webhook\_secret\_bitbucket": "string",
|
||||
|
||||
"manual\_webhook\_secret\_gitea": "string",
|
||||
|
||||
"docker\_compose\_location": "string",
|
||||
|
||||
"docker\_compose": "string",
|
||||
|
||||
"docker\_compose\_raw": "string",
|
||||
|
||||
"docker\_compose\_domains": "string",
|
||||
|
||||
"docker\_compose\_custom\_start\_command": "string",
|
||||
|
||||
"docker\_compose\_custom\_build\_command": "string",
|
||||
|
||||
"swarm\_replicas": 0,
|
||||
|
||||
"swarm\_placement\_constraints": "string",
|
||||
|
||||
"custom\_docker\_run\_options": "string",
|
||||
|
||||
"post\_deployment\_command": "string",
|
||||
|
||||
"post\_deployment\_command\_container": "string",
|
||||
|
||||
"pre\_deployment\_command": "string",
|
||||
|
||||
"pre\_deployment\_command\_container": "string",
|
||||
|
||||
"watch\_paths": "string",
|
||||
|
||||
"custom\_healthcheck\_found": true,
|
||||
|
||||
"redirect": "string",
|
||||
|
||||
"created\_at": "string",
|
||||
|
||||
"updated\_at": "string",
|
||||
|
||||
"deleted\_at": "string",
|
||||
|
||||
"compose\_parsing\_version": "string",
|
||||
|
||||
"custom\_nginx\_configuration": "string",
|
||||
|
||||
"is\_http\_basic\_auth\_enabled": true,
|
||||
|
||||
"http\_basic\_auth\_username": "string",
|
||||
|
||||
"http\_basic\_auth\_password": "string"
|
||||
|
||||
}
|
||||
|
||||
GET
|
||||
|
||||
/applications/{uuid}
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/get-application-by-uuid#playground)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/get-application-by-uuid#samples)
|
||||
|
||||
-------------------------------------------------------------------------------------------------
|
||||
|
||||
BrunocURLJavaScriptPHPPython
|
||||
|
||||
Bruno
|
||||
|
||||
GET https://app.coolify.io/api/v1/applications/%7Buuid%7D
|
||||
|
||||
Headers
|
||||
authorization: Token
|
||||
|
||||
|
||||
cURL
|
||||
|
||||
curl 'https://app.coolify.io/api/v1/applications/{uuid}' \
|
||||
--header 'Authorization: Token'
|
||||
|
||||
JavaScript
|
||||
|
||||
fetch('https://app.coolify.io/api/v1/applications/{uuid}', {
|
||||
headers: {
|
||||
Authorization: 'Token'
|
||||
}
|
||||
})
|
||||
|
||||
PHP
|
||||
|
||||
$ch = curl_init("https://app.coolify.io/api/v1/applications/{uuid}");
|
||||
|
||||
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Token']);
|
||||
|
||||
curl_exec($ch);
|
||||
|
||||
curl_close($ch);
|
||||
|
||||
Python
|
||||
|
||||
requests.get(
|
||||
"https://app.coolify.io/api/v1/applications/{uuid}",
|
||||
headers={
|
||||
"Authorization": "Token"
|
||||
}
|
||||
)
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,111 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/get-application-logs-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Get application logs.[](https://coolify.io/docs/api-reference/api/operations/get-application-logs-by-uuid#get-application-logs)
|
||||
|
||||
=================================================================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/applications/{uuid}/logs
|
||||
|
||||
Get application logs by UUID.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/get-application-logs-by-uuid#authorizations)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/get-application-logs-by-uuid#parameters)
|
||||
|
||||
------------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the application.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
### Query Parameters
|
||||
|
||||
lines
|
||||
|
||||
Number of lines to show from the end of the logs.
|
||||
|
||||
Type
|
||||
|
||||
integer
|
||||
|
||||
Format
|
||||
|
||||
`"int32"`
|
||||
|
||||
Default
|
||||
|
||||
`100`
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/get-application-logs-by-uuid#responses)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
Get application logs by UUID.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"logs": "string"
|
||||
|
||||
}
|
||||
|
||||
GET
|
||||
|
||||
/applications/{uuid}/logs
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/get-application-logs-by-uuid#playground)
|
||||
|
||||
------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
lines
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/get-application-logs-by-uuid#samples)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,103 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/get-cloud-token-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Get Cloud Provider Token[](https://coolify.io/docs/api-reference/api/operations/get-cloud-token-by-uuid#get-cloud-provider-token)
|
||||
|
||||
===================================================================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/cloud-tokens/{uuid}
|
||||
|
||||
Get cloud provider token by UUID.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/get-cloud-token-by-uuid#authorizations)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/get-cloud-token-by-uuid#parameters)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
Token UUID
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/get-cloud-token-by-uuid#responses)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------
|
||||
|
||||
200401404
|
||||
|
||||
Get cloud provider token by UUID
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"uuid": "string",
|
||||
|
||||
"name": "string",
|
||||
|
||||
"provider": "string",
|
||||
|
||||
"team\_id": 0,
|
||||
|
||||
"servers\_count": 0,
|
||||
|
||||
"created\_at": "string",
|
||||
|
||||
"updated\_at": "string"
|
||||
|
||||
}
|
||||
|
||||
GET
|
||||
|
||||
/cloud-tokens/{uuid}
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/get-cloud-token-by-uuid#playground)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/get-cloud-token-by-uuid#samples)
|
||||
|
||||
-------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,87 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/get-current-team-members#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Authenticated Team Members[](https://coolify.io/docs/api-reference/api/operations/get-current-team-members#authenticated-team-members)
|
||||
|
||||
========================================================================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/teams/current/members
|
||||
|
||||
Get currently authenticated team members.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/get-current-team-members#authorizations)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/get-current-team-members#responses)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401
|
||||
|
||||
Currently authenticated team members.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
\[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"id": 0,\
|
||||
\
|
||||
"name": "string",\
|
||||
\
|
||||
"email": "string",\
|
||||
\
|
||||
"email\_verified\_at": "string",\
|
||||
\
|
||||
"created\_at": "string",\
|
||||
\
|
||||
"updated\_at": "string",\
|
||||
\
|
||||
"two\_factor\_confirmed\_at": "string",\
|
||||
\
|
||||
"force\_password\_reset": true,\
|
||||
\
|
||||
"marketing\_emails": true\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]
|
||||
|
||||
GET
|
||||
|
||||
/teams/current/members
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/get-current-team-members#playground)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/get-current-team-members#samples)
|
||||
|
||||
--------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,107 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/get-current-team#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Authenticated Team[](https://coolify.io/docs/api-reference/api/operations/get-current-team#authenticated-team)
|
||||
|
||||
================================================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/teams/current
|
||||
|
||||
Get currently authenticated team.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/get-current-team#authorizations)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/get-current-team#responses)
|
||||
|
||||
----------------------------------------------------------------------------------------------
|
||||
|
||||
200400401
|
||||
|
||||
Current Team.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"id": 0,
|
||||
|
||||
"name": "string",
|
||||
|
||||
"description": "string",
|
||||
|
||||
"personal\_team": true,
|
||||
|
||||
"created\_at": "string",
|
||||
|
||||
"updated\_at": "string",
|
||||
|
||||
"show\_boarding": true,
|
||||
|
||||
"custom\_server\_limit": "string",
|
||||
|
||||
"members": \[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"id": 0,\
|
||||
\
|
||||
"name": "string",\
|
||||
\
|
||||
"email": "string",\
|
||||
\
|
||||
"email\_verified\_at": "string",\
|
||||
\
|
||||
"created\_at": "string",\
|
||||
\
|
||||
"updated\_at": "string",\
|
||||
\
|
||||
"two\_factor\_confirmed\_at": "string",\
|
||||
\
|
||||
"force\_password\_reset": true,\
|
||||
\
|
||||
"marketing\_emails": true\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]
|
||||
|
||||
}
|
||||
|
||||
GET
|
||||
|
||||
/teams/current
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/get-current-team#playground)
|
||||
|
||||
------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/get-current-team#samples)
|
||||
|
||||
------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,87 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/get-database-backups-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Get[](https://coolify.io/docs/api-reference/api/operations/get-database-backups-by-uuid#get)
|
||||
|
||||
==============================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/databases/{uuid}/backups
|
||||
|
||||
Get backups details by database UUID.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/get-database-backups-by-uuid#authorizations)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/get-database-backups-by-uuid#parameters)
|
||||
|
||||
------------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the database.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/get-database-backups-by-uuid#responses)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
Get all backups for a database
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
"string"
|
||||
|
||||
GET
|
||||
|
||||
/databases/{uuid}/backups
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/get-database-backups-by-uuid#playground)
|
||||
|
||||
------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/get-database-backups-by-uuid#samples)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,87 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/get-database-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Get[](https://coolify.io/docs/api-reference/api/operations/get-database-by-uuid#get)
|
||||
|
||||
======================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/databases/{uuid}
|
||||
|
||||
Get database by UUID.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/get-database-by-uuid#authorizations)
|
||||
|
||||
------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/get-database-by-uuid#parameters)
|
||||
|
||||
----------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the database.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/get-database-by-uuid#responses)
|
||||
|
||||
--------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
Get all databases
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
"string"
|
||||
|
||||
GET
|
||||
|
||||
/databases/{uuid}
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/get-database-by-uuid#playground)
|
||||
|
||||
----------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/get-database-by-uuid#samples)
|
||||
|
||||
----------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,137 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/get-deployment-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Get[](https://coolify.io/docs/api-reference/api/operations/get-deployment-by-uuid#get)
|
||||
|
||||
========================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/deployments/{uuid}
|
||||
|
||||
Get deployment by UUID.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/get-deployment-by-uuid#authorizations)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/get-deployment-by-uuid#parameters)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
Deployment UUID
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/get-deployment-by-uuid#responses)
|
||||
|
||||
----------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
Get deployment by UUID.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"id": 0,
|
||||
|
||||
"application\_id": "string",
|
||||
|
||||
"deployment\_uuid": "string",
|
||||
|
||||
"pull\_request\_id": 0,
|
||||
|
||||
"docker\_registry\_image\_tag": "string",
|
||||
|
||||
"force\_rebuild": true,
|
||||
|
||||
"commit": "string",
|
||||
|
||||
"status": "string",
|
||||
|
||||
"is\_webhook": true,
|
||||
|
||||
"is\_api": true,
|
||||
|
||||
"created\_at": "string",
|
||||
|
||||
"updated\_at": "string",
|
||||
|
||||
"logs": "string",
|
||||
|
||||
"current\_process\_id": "string",
|
||||
|
||||
"restart\_only": true,
|
||||
|
||||
"git\_type": "string",
|
||||
|
||||
"server\_id": 0,
|
||||
|
||||
"application\_name": "string",
|
||||
|
||||
"server\_name": "string",
|
||||
|
||||
"deployment\_url": "string",
|
||||
|
||||
"destination\_id": "string",
|
||||
|
||||
"only\_this\_server": true,
|
||||
|
||||
"rollback": true,
|
||||
|
||||
"commit\_message": "string"
|
||||
|
||||
}
|
||||
|
||||
GET
|
||||
|
||||
/deployments/{uuid}
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/get-deployment-by-uuid#playground)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/get-deployment-by-uuid#samples)
|
||||
|
||||
------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,101 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/get-domains-by-server-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Domains[](https://coolify.io/docs/api-reference/api/operations/get-domains-by-server-uuid#domains)
|
||||
|
||||
====================================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/servers/{uuid}/domains
|
||||
|
||||
Get domains by server.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/get-domains-by-server-uuid#authorizations)
|
||||
|
||||
------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/get-domains-by-server-uuid#parameters)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
Server's UUID
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/get-domains-by-server-uuid#responses)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401
|
||||
|
||||
Get domains by server
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
\[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"ip": "string",\
|
||||
\
|
||||
"domains": \[\
|
||||
\
|
||||
"string"\
|
||||
\
|
||||
\]\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]
|
||||
|
||||
GET
|
||||
|
||||
/servers/{uuid}/domains
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/get-domains-by-server-uuid#playground)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/get-domains-by-server-uuid#samples)
|
||||
|
||||
----------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,113 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/get-environment-by-name-or-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Environment[](https://coolify.io/docs/api-reference/api/operations/get-environment-by-name-or-uuid#environment)
|
||||
|
||||
=================================================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/projects/{uuid}/{environment\_name\_or\_uuid}
|
||||
|
||||
Get environment by name or UUID.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/get-environment-by-name-or-uuid#authorizations)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/get-environment-by-name-or-uuid#parameters)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
Project UUID
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
environment\_name\_or\_uuid\*
|
||||
|
||||
Environment name or UUID
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/get-environment-by-name-or-uuid#responses)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404422
|
||||
|
||||
Environment details
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"id": 0,
|
||||
|
||||
"name": "string",
|
||||
|
||||
"project\_id": 0,
|
||||
|
||||
"created\_at": "string",
|
||||
|
||||
"updated\_at": "string",
|
||||
|
||||
"description": "string"
|
||||
|
||||
}
|
||||
|
||||
GET
|
||||
|
||||
/projects/{uuid}/{environment\_name\_or\_uuid}
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/get-environment-by-name-or-uuid#playground)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
environment\_name\_or\_uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/get-environment-by-name-or-uuid#samples)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,105 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/get-environments#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
List Environments[](https://coolify.io/docs/api-reference/api/operations/get-environments#list-environments)
|
||||
|
||||
==============================================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/projects/{uuid}/environments
|
||||
|
||||
List all environments in a project.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/get-environments#authorizations)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/get-environments#parameters)
|
||||
|
||||
------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
Project UUID
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/get-environments#responses)
|
||||
|
||||
----------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404422
|
||||
|
||||
List of environments
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
\[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"id": 0,\
|
||||
\
|
||||
"name": "string",\
|
||||
\
|
||||
"project\_id": 0,\
|
||||
\
|
||||
"created\_at": "string",\
|
||||
\
|
||||
"updated\_at": "string",\
|
||||
\
|
||||
"description": "string"\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]
|
||||
|
||||
GET
|
||||
|
||||
/projects/{uuid}/environments
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/get-environments#playground)
|
||||
|
||||
------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/get-environments#samples)
|
||||
|
||||
------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,115 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/get-hetzner-images#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Get Hetzner Images[](https://coolify.io/docs/api-reference/api/operations/get-hetzner-images#get-hetzner-images)
|
||||
|
||||
==================================================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/hetzner/images
|
||||
|
||||
Get all available Hetzner system images (operating systems).
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/get-hetzner-images#authorizations)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/get-hetzner-images#parameters)
|
||||
|
||||
--------------------------------------------------------------------------------------------------
|
||||
|
||||
### Query Parameters
|
||||
|
||||
cloud\_provider\_token\_uuid
|
||||
|
||||
Cloud provider token UUID. Required if cloud\_provider\_token\_id is not provided.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
cloud\_provider\_token\_id
|
||||
|
||||
Deprecated: Use cloud\_provider\_token\_uuid instead. Cloud provider token UUID.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/get-hetzner-images#responses)
|
||||
|
||||
------------------------------------------------------------------------------------------------
|
||||
|
||||
200401404
|
||||
|
||||
List of Hetzner images.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
\[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"id": 0,\
|
||||
\
|
||||
"name": "string",\
|
||||
\
|
||||
"description": "string",\
|
||||
\
|
||||
"type": "string",\
|
||||
\
|
||||
"os\_flavor": "string",\
|
||||
\
|
||||
"os\_version": "string",\
|
||||
\
|
||||
"architecture": "string"\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]
|
||||
|
||||
GET
|
||||
|
||||
/hetzner/images
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/get-hetzner-images#playground)
|
||||
|
||||
--------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
cloud\_provider\_token\_uuid
|
||||
|
||||
cloud\_provider\_token\_id
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/get-hetzner-images#samples)
|
||||
|
||||
--------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,115 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/get-hetzner-locations#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Get Hetzner Locations[](https://coolify.io/docs/api-reference/api/operations/get-hetzner-locations#get-hetzner-locations)
|
||||
|
||||
===========================================================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/hetzner/locations
|
||||
|
||||
Get all available Hetzner datacenter locations.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/get-hetzner-locations#authorizations)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/get-hetzner-locations#parameters)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------
|
||||
|
||||
### Query Parameters
|
||||
|
||||
cloud\_provider\_token\_uuid
|
||||
|
||||
Cloud provider token UUID. Required if cloud\_provider\_token\_id is not provided.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
cloud\_provider\_token\_id
|
||||
|
||||
Deprecated: Use cloud\_provider\_token\_uuid instead. Cloud provider token UUID.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/get-hetzner-locations#responses)
|
||||
|
||||
---------------------------------------------------------------------------------------------------
|
||||
|
||||
200401404
|
||||
|
||||
List of Hetzner locations.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
\[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"id": 0,\
|
||||
\
|
||||
"name": "string",\
|
||||
\
|
||||
"description": "string",\
|
||||
\
|
||||
"country": "string",\
|
||||
\
|
||||
"city": "string",\
|
||||
\
|
||||
"latitude": 0,\
|
||||
\
|
||||
"longitude": 0\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]
|
||||
|
||||
GET
|
||||
|
||||
/hetzner/locations
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/get-hetzner-locations#playground)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
cloud\_provider\_token\_uuid
|
||||
|
||||
cloud\_provider\_token\_id
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/get-hetzner-locations#samples)
|
||||
|
||||
-----------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,139 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/get-hetzner-server-types#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Get Hetzner Server Types[](https://coolify.io/docs/api-reference/api/operations/get-hetzner-server-types#get-hetzner-server-types)
|
||||
|
||||
====================================================================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/hetzner/server-types
|
||||
|
||||
Get all available Hetzner server types (instance sizes).
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/get-hetzner-server-types#authorizations)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/get-hetzner-server-types#parameters)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Query Parameters
|
||||
|
||||
cloud\_provider\_token\_uuid
|
||||
|
||||
Cloud provider token UUID. Required if cloud\_provider\_token\_id is not provided.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
cloud\_provider\_token\_id
|
||||
|
||||
Deprecated: Use cloud\_provider\_token\_uuid instead. Cloud provider token UUID.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/get-hetzner-server-types#responses)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
200401404
|
||||
|
||||
List of Hetzner server types.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
\[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"id": 0,\
|
||||
\
|
||||
"name": "string",\
|
||||
\
|
||||
"description": "string",\
|
||||
\
|
||||
"cores": 0,\
|
||||
\
|
||||
"memory": 0,\
|
||||
\
|
||||
"disk": 0,\
|
||||
\
|
||||
"prices": \[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"location": "string",\
|
||||
\
|
||||
"price\_hourly": {\
|
||||
\
|
||||
"net": "string",\
|
||||
\
|
||||
"gross": "string"\
|
||||
\
|
||||
},\
|
||||
\
|
||||
"price\_monthly": {\
|
||||
\
|
||||
"net": "string",\
|
||||
\
|
||||
"gross": "string"\
|
||||
\
|
||||
}\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]
|
||||
|
||||
GET
|
||||
|
||||
/hetzner/server-types
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/get-hetzner-server-types#playground)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
cloud\_provider\_token\_uuid
|
||||
|
||||
cloud\_provider\_token\_id
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/get-hetzner-server-types#samples)
|
||||
|
||||
--------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,109 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/get-hetzner-ssh-keys#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Get Hetzner SSH Keys[](https://coolify.io/docs/api-reference/api/operations/get-hetzner-ssh-keys#get-hetzner-ssh-keys)
|
||||
|
||||
========================================================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/hetzner/ssh-keys
|
||||
|
||||
Get all SSH keys stored in the Hetzner account.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/get-hetzner-ssh-keys#authorizations)
|
||||
|
||||
------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/get-hetzner-ssh-keys#parameters)
|
||||
|
||||
----------------------------------------------------------------------------------------------------
|
||||
|
||||
### Query Parameters
|
||||
|
||||
cloud\_provider\_token\_uuid
|
||||
|
||||
Cloud provider token UUID. Required if cloud\_provider\_token\_id is not provided.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
cloud\_provider\_token\_id
|
||||
|
||||
Deprecated: Use cloud\_provider\_token\_uuid instead. Cloud provider token UUID.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/get-hetzner-ssh-keys#responses)
|
||||
|
||||
--------------------------------------------------------------------------------------------------
|
||||
|
||||
200401404
|
||||
|
||||
List of Hetzner SSH keys.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
\[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"id": 0,\
|
||||
\
|
||||
"name": "string",\
|
||||
\
|
||||
"fingerprint": "string",\
|
||||
\
|
||||
"public\_key": "string"\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]
|
||||
|
||||
GET
|
||||
|
||||
/hetzner/ssh-keys
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/get-hetzner-ssh-keys#playground)
|
||||
|
||||
----------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
cloud\_provider\_token\_uuid
|
||||
|
||||
cloud\_provider\_token\_id
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/get-hetzner-ssh-keys#samples)
|
||||
|
||||
----------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,111 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/get-members-by-team-id#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Members[](https://coolify.io/docs/api-reference/api/operations/get-members-by-team-id#members)
|
||||
|
||||
================================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/teams/{id}/members
|
||||
|
||||
Get members by TeamId.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/get-members-by-team-id#authorizations)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/get-members-by-team-id#parameters)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
id\*
|
||||
|
||||
Team ID
|
||||
|
||||
Type
|
||||
|
||||
integer
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/get-members-by-team-id#responses)
|
||||
|
||||
----------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
List of members.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
\[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"id": 0,\
|
||||
\
|
||||
"name": "string",\
|
||||
\
|
||||
"email": "string",\
|
||||
\
|
||||
"email\_verified\_at": "string",\
|
||||
\
|
||||
"created\_at": "string",\
|
||||
\
|
||||
"updated\_at": "string",\
|
||||
\
|
||||
"two\_factor\_confirmed\_at": "string",\
|
||||
\
|
||||
"force\_password\_reset": true,\
|
||||
\
|
||||
"marketing\_emails": true\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]
|
||||
|
||||
GET
|
||||
|
||||
/teams/{id}/members
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/get-members-by-team-id#playground)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
id\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/get-members-by-team-id#samples)
|
||||
|
||||
------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,111 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/get-private-key-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Get[](https://coolify.io/docs/api-reference/api/operations/get-private-key-by-uuid#get)
|
||||
|
||||
=========================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/security/keys/{uuid}
|
||||
|
||||
Get key by UUID.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/get-private-key-by-uuid#authorizations)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/get-private-key-by-uuid#parameters)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
Private Key UUID
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/get-private-key-by-uuid#responses)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
Get all private keys.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"id": 0,
|
||||
|
||||
"uuid": "string",
|
||||
|
||||
"name": "string",
|
||||
|
||||
"description": "string",
|
||||
|
||||
"private\_key": "string",
|
||||
|
||||
"public\_key": "string",
|
||||
|
||||
"fingerprint": "string",
|
||||
|
||||
"is\_git\_related": true,
|
||||
|
||||
"team\_id": 0,
|
||||
|
||||
"created\_at": "string",
|
||||
|
||||
"updated\_at": "string"
|
||||
|
||||
}
|
||||
|
||||
GET
|
||||
|
||||
/security/keys/{uuid}
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/get-private-key-by-uuid#playground)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/get-private-key-by-uuid#samples)
|
||||
|
||||
-------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,97 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/get-project-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Get[](https://coolify.io/docs/api-reference/api/operations/get-project-by-uuid#get)
|
||||
|
||||
=====================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/projects/{uuid}
|
||||
|
||||
Get project by UUID.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/get-project-by-uuid#authorizations)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/get-project-by-uuid#parameters)
|
||||
|
||||
---------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
Project UUID
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/get-project-by-uuid#responses)
|
||||
|
||||
-------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
Project details
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"id": 0,
|
||||
|
||||
"uuid": "string",
|
||||
|
||||
"name": "string",
|
||||
|
||||
"description": "string"
|
||||
|
||||
}
|
||||
|
||||
GET
|
||||
|
||||
/projects/{uuid}
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/get-project-by-uuid#playground)
|
||||
|
||||
---------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/get-project-by-uuid#samples)
|
||||
|
||||
---------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,107 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/get-resources-by-server-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Resources[](https://coolify.io/docs/api-reference/api/operations/get-resources-by-server-uuid#resources)
|
||||
|
||||
==========================================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/servers/{uuid}/resources
|
||||
|
||||
Get resources by server.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/get-resources-by-server-uuid#authorizations)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/get-resources-by-server-uuid#parameters)
|
||||
|
||||
------------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
Server's UUID
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/get-resources-by-server-uuid#responses)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401
|
||||
|
||||
Get resources by server
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
\[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"id": 0,\
|
||||
\
|
||||
"uuid": "string",\
|
||||
\
|
||||
"name": "string",\
|
||||
\
|
||||
"type": "string",\
|
||||
\
|
||||
"created\_at": "string",\
|
||||
\
|
||||
"updated\_at": "string",\
|
||||
\
|
||||
"status": "string"\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]
|
||||
|
||||
GET
|
||||
|
||||
/servers/{uuid}/resources
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/get-resources-by-server-uuid#playground)
|
||||
|
||||
------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/get-resources-by-server-uuid#samples)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,201 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/get-server-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Get[](https://coolify.io/docs/api-reference/api/operations/get-server-by-uuid#get)
|
||||
|
||||
====================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/servers/{uuid}
|
||||
|
||||
Get server by UUID.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/get-server-by-uuid#authorizations)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/get-server-by-uuid#parameters)
|
||||
|
||||
--------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
Server's UUID
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/get-server-by-uuid#responses)
|
||||
|
||||
------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
Get server by UUID
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"id": 0,
|
||||
|
||||
"uuid": "string",
|
||||
|
||||
"name": "string",
|
||||
|
||||
"description": "string",
|
||||
|
||||
"ip": "string",
|
||||
|
||||
"user": "string",
|
||||
|
||||
"port": 0,
|
||||
|
||||
"proxy": {
|
||||
|
||||
},
|
||||
|
||||
"proxy\_type": "string",
|
||||
|
||||
"high\_disk\_usage\_notification\_sent": true,
|
||||
|
||||
"unreachable\_notification\_sent": true,
|
||||
|
||||
"unreachable\_count": 0,
|
||||
|
||||
"validation\_logs": "string",
|
||||
|
||||
"log\_drain\_notification\_sent": true,
|
||||
|
||||
"swarm\_cluster": "string",
|
||||
|
||||
"settings": {
|
||||
|
||||
"id": 0,
|
||||
|
||||
"concurrent\_builds": 0,
|
||||
|
||||
"deployment\_queue\_limit": 0,
|
||||
|
||||
"dynamic\_timeout": 0,
|
||||
|
||||
"force\_disabled": true,
|
||||
|
||||
"force\_server\_cleanup": true,
|
||||
|
||||
"is\_build\_server": true,
|
||||
|
||||
"is\_cloudflare\_tunnel": true,
|
||||
|
||||
"is\_jump\_server": true,
|
||||
|
||||
"is\_logdrain\_axiom\_enabled": true,
|
||||
|
||||
"is\_logdrain\_custom\_enabled": true,
|
||||
|
||||
"is\_logdrain\_highlight\_enabled": true,
|
||||
|
||||
"is\_logdrain\_newrelic\_enabled": true,
|
||||
|
||||
"is\_metrics\_enabled": true,
|
||||
|
||||
"is\_reachable": true,
|
||||
|
||||
"is\_sentinel\_enabled": true,
|
||||
|
||||
"is\_swarm\_manager": true,
|
||||
|
||||
"is\_swarm\_worker": true,
|
||||
|
||||
"is\_terminal\_enabled": true,
|
||||
|
||||
"is\_usable": true,
|
||||
|
||||
"logdrain\_axiom\_api\_key": "string",
|
||||
|
||||
"logdrain\_axiom\_dataset\_name": "string",
|
||||
|
||||
"logdrain\_custom\_config": "string",
|
||||
|
||||
"logdrain\_custom\_config\_parser": "string",
|
||||
|
||||
"logdrain\_highlight\_project\_id": "string",
|
||||
|
||||
"logdrain\_newrelic\_base\_uri": "string",
|
||||
|
||||
"logdrain\_newrelic\_license\_key": "string",
|
||||
|
||||
"sentinel\_metrics\_history\_days": 0,
|
||||
|
||||
"sentinel\_metrics\_refresh\_rate\_seconds": 0,
|
||||
|
||||
"sentinel\_token": "string",
|
||||
|
||||
"docker\_cleanup\_frequency": "string",
|
||||
|
||||
"docker\_cleanup\_threshold": 0,
|
||||
|
||||
"server\_id": 0,
|
||||
|
||||
"wildcard\_domain": "string",
|
||||
|
||||
"created\_at": "string",
|
||||
|
||||
"updated\_at": "string",
|
||||
|
||||
"delete\_unused\_volumes": true,
|
||||
|
||||
"delete\_unused\_networks": true
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
GET
|
||||
|
||||
/servers/{uuid}
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/get-server-by-uuid#playground)
|
||||
|
||||
--------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/get-server-by-uuid#samples)
|
||||
|
||||
--------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,125 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/get-service-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Get[](https://coolify.io/docs/api-reference/api/operations/get-service-by-uuid#get)
|
||||
|
||||
=====================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/services/{uuid}
|
||||
|
||||
Get service by UUID.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/get-service-by-uuid#authorizations)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/get-service-by-uuid#parameters)
|
||||
|
||||
---------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
Service UUID
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/get-service-by-uuid#responses)
|
||||
|
||||
-------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
Get a service by UUID.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"id": 0,
|
||||
|
||||
"uuid": "string",
|
||||
|
||||
"name": "string",
|
||||
|
||||
"environment\_id": 0,
|
||||
|
||||
"server\_id": 0,
|
||||
|
||||
"description": "string",
|
||||
|
||||
"docker\_compose\_raw": "string",
|
||||
|
||||
"docker\_compose": "string",
|
||||
|
||||
"destination\_type": "string",
|
||||
|
||||
"destination\_id": 0,
|
||||
|
||||
"connect\_to\_docker\_network": true,
|
||||
|
||||
"is\_container\_label\_escape\_enabled": true,
|
||||
|
||||
"is\_container\_label\_readonly\_enabled": true,
|
||||
|
||||
"config\_hash": "string",
|
||||
|
||||
"service\_type": "string",
|
||||
|
||||
"created\_at": "string",
|
||||
|
||||
"updated\_at": "string",
|
||||
|
||||
"deleted\_at": "string"
|
||||
|
||||
}
|
||||
|
||||
GET
|
||||
|
||||
/services/{uuid}
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/get-service-by-uuid#playground)
|
||||
|
||||
---------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/get-service-by-uuid#samples)
|
||||
|
||||
---------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,131 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/get-team-by-id#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Get[](https://coolify.io/docs/api-reference/api/operations/get-team-by-id#get)
|
||||
|
||||
================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/teams/{id}
|
||||
|
||||
Get team by TeamId.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/get-team-by-id#authorizations)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/get-team-by-id#parameters)
|
||||
|
||||
----------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
id\*
|
||||
|
||||
Team ID
|
||||
|
||||
Type
|
||||
|
||||
integer
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/get-team-by-id#responses)
|
||||
|
||||
--------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
List of teams.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"id": 0,
|
||||
|
||||
"name": "string",
|
||||
|
||||
"description": "string",
|
||||
|
||||
"personal\_team": true,
|
||||
|
||||
"created\_at": "string",
|
||||
|
||||
"updated\_at": "string",
|
||||
|
||||
"show\_boarding": true,
|
||||
|
||||
"custom\_server\_limit": "string",
|
||||
|
||||
"members": \[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"id": 0,\
|
||||
\
|
||||
"name": "string",\
|
||||
\
|
||||
"email": "string",\
|
||||
\
|
||||
"email\_verified\_at": "string",\
|
||||
\
|
||||
"created\_at": "string",\
|
||||
\
|
||||
"updated\_at": "string",\
|
||||
\
|
||||
"two\_factor\_confirmed\_at": "string",\
|
||||
\
|
||||
"force\_password\_reset": true,\
|
||||
\
|
||||
"marketing\_emails": true\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]
|
||||
|
||||
}
|
||||
|
||||
GET
|
||||
|
||||
/teams/{id}
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/get-team-by-id#playground)
|
||||
|
||||
----------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
id\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/get-team-by-id#samples)
|
||||
|
||||
----------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,47 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/healthcheck#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Healthcheck[](https://coolify.io/docs/api-reference/api/operations/healthcheck#healthcheck)
|
||||
|
||||
=============================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/health
|
||||
|
||||
Healthcheck endpoint.
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/healthcheck#responses)
|
||||
|
||||
-----------------------------------------------------------------------------------------
|
||||
|
||||
200400401
|
||||
|
||||
Healthcheck endpoint.
|
||||
|
||||
Content-Type
|
||||
|
||||
text/html
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
"string"
|
||||
|
||||
GET
|
||||
|
||||
/health
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/healthcheck#playground)
|
||||
|
||||
-------------------------------------------------------------------------------------------
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/healthcheck#samples)
|
||||
|
||||
-------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,257 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/list-applications#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
List[](https://coolify.io/docs/api-reference/api/operations/list-applications#list)
|
||||
|
||||
=====================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/applications
|
||||
|
||||
List all applications.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/list-applications#authorizations)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/list-applications#parameters)
|
||||
|
||||
-------------------------------------------------------------------------------------------------
|
||||
|
||||
### Query Parameters
|
||||
|
||||
tag
|
||||
|
||||
Filter applications by tag name.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/list-applications#responses)
|
||||
|
||||
-----------------------------------------------------------------------------------------------
|
||||
|
||||
200400401
|
||||
|
||||
Get all applications.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
\[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"id": 0,\
|
||||
\
|
||||
"description": "string",\
|
||||
\
|
||||
"repository\_project\_id": 0,\
|
||||
\
|
||||
"uuid": "string",\
|
||||
\
|
||||
"name": "string",\
|
||||
\
|
||||
"fqdn": "string",\
|
||||
\
|
||||
"config\_hash": "string",\
|
||||
\
|
||||
"git\_repository": "string",\
|
||||
\
|
||||
"git\_branch": "string",\
|
||||
\
|
||||
"git\_commit\_sha": "string",\
|
||||
\
|
||||
"git\_full\_url": "string",\
|
||||
\
|
||||
"docker\_registry\_image\_name": "string",\
|
||||
\
|
||||
"docker\_registry\_image\_tag": "string",\
|
||||
\
|
||||
"build\_pack": "string",\
|
||||
\
|
||||
"static\_image": "string",\
|
||||
\
|
||||
"install\_command": "string",\
|
||||
\
|
||||
"build\_command": "string",\
|
||||
\
|
||||
"start\_command": "string",\
|
||||
\
|
||||
"ports\_exposes": "string",\
|
||||
\
|
||||
"ports\_mappings": "string",\
|
||||
\
|
||||
"custom\_network\_aliases": "string",\
|
||||
\
|
||||
"base\_directory": "string",\
|
||||
\
|
||||
"publish\_directory": "string",\
|
||||
\
|
||||
"health\_check\_enabled": true,\
|
||||
\
|
||||
"health\_check\_path": "string",\
|
||||
\
|
||||
"health\_check\_port": "string",\
|
||||
\
|
||||
"health\_check\_host": "string",\
|
||||
\
|
||||
"health\_check\_method": "string",\
|
||||
\
|
||||
"health\_check\_return\_code": 0,\
|
||||
\
|
||||
"health\_check\_scheme": "string",\
|
||||
\
|
||||
"health\_check\_response\_text": "string",\
|
||||
\
|
||||
"health\_check\_interval": 0,\
|
||||
\
|
||||
"health\_check\_timeout": 0,\
|
||||
\
|
||||
"health\_check\_retries": 0,\
|
||||
\
|
||||
"health\_check\_start\_period": 0,\
|
||||
\
|
||||
"health\_check\_type": "string",\
|
||||
\
|
||||
"health\_check\_command": "string",\
|
||||
\
|
||||
"limits\_memory": "string",\
|
||||
\
|
||||
"limits\_memory\_swap": "string",\
|
||||
\
|
||||
"limits\_memory\_swappiness": 0,\
|
||||
\
|
||||
"limits\_memory\_reservation": "string",\
|
||||
\
|
||||
"limits\_cpus": "string",\
|
||||
\
|
||||
"limits\_cpuset": "string",\
|
||||
\
|
||||
"limits\_cpu\_shares": 0,\
|
||||
\
|
||||
"status": "string",\
|
||||
\
|
||||
"preview\_url\_template": "string",\
|
||||
\
|
||||
"destination\_type": "string",\
|
||||
\
|
||||
"destination\_id": 0,\
|
||||
\
|
||||
"source\_id": 0,\
|
||||
\
|
||||
"private\_key\_id": 0,\
|
||||
\
|
||||
"environment\_id": 0,\
|
||||
\
|
||||
"dockerfile": "string",\
|
||||
\
|
||||
"dockerfile\_location": "string",\
|
||||
\
|
||||
"custom\_labels": "string",\
|
||||
\
|
||||
"dockerfile\_target\_build": "string",\
|
||||
\
|
||||
"manual\_webhook\_secret\_github": "string",\
|
||||
\
|
||||
"manual\_webhook\_secret\_gitlab": "string",\
|
||||
\
|
||||
"manual\_webhook\_secret\_bitbucket": "string",\
|
||||
\
|
||||
"manual\_webhook\_secret\_gitea": "string",\
|
||||
\
|
||||
"docker\_compose\_location": "string",\
|
||||
\
|
||||
"docker\_compose": "string",\
|
||||
\
|
||||
"docker\_compose\_raw": "string",\
|
||||
\
|
||||
"docker\_compose\_domains": "string",\
|
||||
\
|
||||
"docker\_compose\_custom\_start\_command": "string",\
|
||||
\
|
||||
"docker\_compose\_custom\_build\_command": "string",\
|
||||
\
|
||||
"swarm\_replicas": 0,\
|
||||
\
|
||||
"swarm\_placement\_constraints": "string",\
|
||||
\
|
||||
"custom\_docker\_run\_options": "string",\
|
||||
\
|
||||
"post\_deployment\_command": "string",\
|
||||
\
|
||||
"post\_deployment\_command\_container": "string",\
|
||||
\
|
||||
"pre\_deployment\_command": "string",\
|
||||
\
|
||||
"pre\_deployment\_command\_container": "string",\
|
||||
\
|
||||
"watch\_paths": "string",\
|
||||
\
|
||||
"custom\_healthcheck\_found": true,\
|
||||
\
|
||||
"redirect": "string",\
|
||||
\
|
||||
"created\_at": "string",\
|
||||
\
|
||||
"updated\_at": "string",\
|
||||
\
|
||||
"deleted\_at": "string",\
|
||||
\
|
||||
"compose\_parsing\_version": "string",\
|
||||
\
|
||||
"custom\_nginx\_configuration": "string",\
|
||||
\
|
||||
"is\_http\_basic\_auth\_enabled": true,\
|
||||
\
|
||||
"http\_basic\_auth\_username": "string",\
|
||||
\
|
||||
"http\_basic\_auth\_password": "string"\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]
|
||||
|
||||
GET
|
||||
|
||||
/applications
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/list-applications#playground)
|
||||
|
||||
-------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
tag
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/list-applications#samples)
|
||||
|
||||
-------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,121 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/list-backup-executions#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
List backup executions[](https://coolify.io/docs/api-reference/api/operations/list-backup-executions#list-backup-executions)
|
||||
|
||||
==============================================================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/databases/{uuid}/backups/{scheduled\_backup\_uuid}/executions
|
||||
|
||||
Get all executions for a specific backup configuration.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/list-backup-executions#authorizations)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/list-backup-executions#parameters)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the database
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
scheduled\_backup\_uuid\*
|
||||
|
||||
UUID of the backup configuration
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/list-backup-executions#responses)
|
||||
|
||||
----------------------------------------------------------------------------------------------------
|
||||
|
||||
200404
|
||||
|
||||
List of backup executions
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"executions": \[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"uuid": "string",\
|
||||
\
|
||||
"filename": "string",\
|
||||
\
|
||||
"size": 0,\
|
||||
\
|
||||
"created\_at": "string",\
|
||||
\
|
||||
"message": "string",\
|
||||
\
|
||||
"status": "string"\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]
|
||||
|
||||
}
|
||||
|
||||
GET
|
||||
|
||||
/databases/{uuid}/backups/{scheduled\_backup\_uuid}/executions
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/list-backup-executions#playground)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
scheduled\_backup\_uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/list-backup-executions#samples)
|
||||
|
||||
------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,125 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/list-cloud-tokens#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
List Cloud Provider Tokens[](https://coolify.io/docs/api-reference/api/operations/list-cloud-tokens#list-cloud-provider-tokens)
|
||||
|
||||
=================================================================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/cloud-tokens
|
||||
|
||||
List all cloud provider tokens for the authenticated team.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/list-cloud-tokens#authorizations)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/list-cloud-tokens#responses)
|
||||
|
||||
-----------------------------------------------------------------------------------------------
|
||||
|
||||
200400401
|
||||
|
||||
Get all cloud provider tokens.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
\[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"uuid": "string",\
|
||||
\
|
||||
"name": "string",\
|
||||
\
|
||||
"provider": "string",\
|
||||
\
|
||||
"team\_id": 0,\
|
||||
\
|
||||
"servers\_count": 0,\
|
||||
\
|
||||
"created\_at": "string",\
|
||||
\
|
||||
"updated\_at": "string"\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]
|
||||
|
||||
GET
|
||||
|
||||
/cloud-tokens
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/list-cloud-tokens#playground)
|
||||
|
||||
-------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/list-cloud-tokens#samples)
|
||||
|
||||
-------------------------------------------------------------------------------------------
|
||||
|
||||
BrunocURLJavaScriptPHPPython
|
||||
|
||||
Bruno
|
||||
|
||||
GET https://app.coolify.io/api/v1/cloud-tokens
|
||||
|
||||
Headers
|
||||
authorization: Token
|
||||
|
||||
|
||||
cURL
|
||||
|
||||
curl https://app.coolify.io/api/v1/cloud-tokens \
|
||||
--header 'Authorization: Token'
|
||||
|
||||
JavaScript
|
||||
|
||||
fetch('https://app.coolify.io/api/v1/cloud-tokens', {
|
||||
headers: {
|
||||
Authorization: 'Token'
|
||||
}
|
||||
})
|
||||
|
||||
PHP
|
||||
|
||||
$ch = curl_init("https://app.coolify.io/api/v1/cloud-tokens");
|
||||
|
||||
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Token']);
|
||||
|
||||
curl_exec($ch);
|
||||
|
||||
curl_close($ch);
|
||||
|
||||
Python
|
||||
|
||||
requests.get(
|
||||
"https://app.coolify.io/api/v1/cloud-tokens",
|
||||
headers={
|
||||
"Authorization": "Token"
|
||||
}
|
||||
)
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,63 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/list-databases#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
List[](https://coolify.io/docs/api-reference/api/operations/list-databases#list)
|
||||
|
||||
==================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/databases
|
||||
|
||||
List all databases.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/list-databases#authorizations)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/list-databases#responses)
|
||||
|
||||
--------------------------------------------------------------------------------------------
|
||||
|
||||
200400401
|
||||
|
||||
Get all databases
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
"string"
|
||||
|
||||
GET
|
||||
|
||||
/databases
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/list-databases#playground)
|
||||
|
||||
----------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/list-databases#samples)
|
||||
|
||||
----------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,297 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/list-deployments-by-app-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
List application deployments[](https://coolify.io/docs/api-reference/api/operations/list-deployments-by-app-uuid#list-application-deployments)
|
||||
|
||||
================================================================================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/deployments/applications/{uuid}
|
||||
|
||||
List application deployments by using the app uuid
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/list-deployments-by-app-uuid#authorizations)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/list-deployments-by-app-uuid#parameters)
|
||||
|
||||
------------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the application.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
### Query Parameters
|
||||
|
||||
skip
|
||||
|
||||
Number of records to skip.
|
||||
|
||||
Type
|
||||
|
||||
integer
|
||||
|
||||
Default
|
||||
|
||||
`0`
|
||||
|
||||
Minimum
|
||||
|
||||
`0`
|
||||
|
||||
take
|
||||
|
||||
Number of records to take.
|
||||
|
||||
Type
|
||||
|
||||
integer
|
||||
|
||||
Default
|
||||
|
||||
`10`
|
||||
|
||||
Minimum
|
||||
|
||||
`1`
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/list-deployments-by-app-uuid#responses)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401
|
||||
|
||||
List application deployments by using the app uuid.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
\[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"id": 0,\
|
||||
\
|
||||
"description": "string",\
|
||||
\
|
||||
"repository\_project\_id": 0,\
|
||||
\
|
||||
"uuid": "string",\
|
||||
\
|
||||
"name": "string",\
|
||||
\
|
||||
"fqdn": "string",\
|
||||
\
|
||||
"config\_hash": "string",\
|
||||
\
|
||||
"git\_repository": "string",\
|
||||
\
|
||||
"git\_branch": "string",\
|
||||
\
|
||||
"git\_commit\_sha": "string",\
|
||||
\
|
||||
"git\_full\_url": "string",\
|
||||
\
|
||||
"docker\_registry\_image\_name": "string",\
|
||||
\
|
||||
"docker\_registry\_image\_tag": "string",\
|
||||
\
|
||||
"build\_pack": "string",\
|
||||
\
|
||||
"static\_image": "string",\
|
||||
\
|
||||
"install\_command": "string",\
|
||||
\
|
||||
"build\_command": "string",\
|
||||
\
|
||||
"start\_command": "string",\
|
||||
\
|
||||
"ports\_exposes": "string",\
|
||||
\
|
||||
"ports\_mappings": "string",\
|
||||
\
|
||||
"custom\_network\_aliases": "string",\
|
||||
\
|
||||
"base\_directory": "string",\
|
||||
\
|
||||
"publish\_directory": "string",\
|
||||
\
|
||||
"health\_check\_enabled": true,\
|
||||
\
|
||||
"health\_check\_path": "string",\
|
||||
\
|
||||
"health\_check\_port": "string",\
|
||||
\
|
||||
"health\_check\_host": "string",\
|
||||
\
|
||||
"health\_check\_method": "string",\
|
||||
\
|
||||
"health\_check\_return\_code": 0,\
|
||||
\
|
||||
"health\_check\_scheme": "string",\
|
||||
\
|
||||
"health\_check\_response\_text": "string",\
|
||||
\
|
||||
"health\_check\_interval": 0,\
|
||||
\
|
||||
"health\_check\_timeout": 0,\
|
||||
\
|
||||
"health\_check\_retries": 0,\
|
||||
\
|
||||
"health\_check\_start\_period": 0,\
|
||||
\
|
||||
"health\_check\_type": "string",\
|
||||
\
|
||||
"health\_check\_command": "string",\
|
||||
\
|
||||
"limits\_memory": "string",\
|
||||
\
|
||||
"limits\_memory\_swap": "string",\
|
||||
\
|
||||
"limits\_memory\_swappiness": 0,\
|
||||
\
|
||||
"limits\_memory\_reservation": "string",\
|
||||
\
|
||||
"limits\_cpus": "string",\
|
||||
\
|
||||
"limits\_cpuset": "string",\
|
||||
\
|
||||
"limits\_cpu\_shares": 0,\
|
||||
\
|
||||
"status": "string",\
|
||||
\
|
||||
"preview\_url\_template": "string",\
|
||||
\
|
||||
"destination\_type": "string",\
|
||||
\
|
||||
"destination\_id": 0,\
|
||||
\
|
||||
"source\_id": 0,\
|
||||
\
|
||||
"private\_key\_id": 0,\
|
||||
\
|
||||
"environment\_id": 0,\
|
||||
\
|
||||
"dockerfile": "string",\
|
||||
\
|
||||
"dockerfile\_location": "string",\
|
||||
\
|
||||
"custom\_labels": "string",\
|
||||
\
|
||||
"dockerfile\_target\_build": "string",\
|
||||
\
|
||||
"manual\_webhook\_secret\_github": "string",\
|
||||
\
|
||||
"manual\_webhook\_secret\_gitlab": "string",\
|
||||
\
|
||||
"manual\_webhook\_secret\_bitbucket": "string",\
|
||||
\
|
||||
"manual\_webhook\_secret\_gitea": "string",\
|
||||
\
|
||||
"docker\_compose\_location": "string",\
|
||||
\
|
||||
"docker\_compose": "string",\
|
||||
\
|
||||
"docker\_compose\_raw": "string",\
|
||||
\
|
||||
"docker\_compose\_domains": "string",\
|
||||
\
|
||||
"docker\_compose\_custom\_start\_command": "string",\
|
||||
\
|
||||
"docker\_compose\_custom\_build\_command": "string",\
|
||||
\
|
||||
"swarm\_replicas": 0,\
|
||||
\
|
||||
"swarm\_placement\_constraints": "string",\
|
||||
\
|
||||
"custom\_docker\_run\_options": "string",\
|
||||
\
|
||||
"post\_deployment\_command": "string",\
|
||||
\
|
||||
"post\_deployment\_command\_container": "string",\
|
||||
\
|
||||
"pre\_deployment\_command": "string",\
|
||||
\
|
||||
"pre\_deployment\_command\_container": "string",\
|
||||
\
|
||||
"watch\_paths": "string",\
|
||||
\
|
||||
"custom\_healthcheck\_found": true,\
|
||||
\
|
||||
"redirect": "string",\
|
||||
\
|
||||
"created\_at": "string",\
|
||||
\
|
||||
"updated\_at": "string",\
|
||||
\
|
||||
"deleted\_at": "string",\
|
||||
\
|
||||
"compose\_parsing\_version": "string",\
|
||||
\
|
||||
"custom\_nginx\_configuration": "string",\
|
||||
\
|
||||
"is\_http\_basic\_auth\_enabled": true,\
|
||||
\
|
||||
"http\_basic\_auth\_username": "string",\
|
||||
\
|
||||
"http\_basic\_auth\_password": "string"\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]
|
||||
|
||||
GET
|
||||
|
||||
/deployments/applications/{uuid}
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/list-deployments-by-app-uuid#playground)
|
||||
|
||||
------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
skip
|
||||
|
||||
take
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/list-deployments-by-app-uuid#samples)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,117 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/list-deployments#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
List[](https://coolify.io/docs/api-reference/api/operations/list-deployments#list)
|
||||
|
||||
====================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/deployments
|
||||
|
||||
List currently running deployments
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/list-deployments#authorizations)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/list-deployments#responses)
|
||||
|
||||
----------------------------------------------------------------------------------------------
|
||||
|
||||
200400401
|
||||
|
||||
Get all currently running deployments.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
\[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"id": 0,\
|
||||
\
|
||||
"application\_id": "string",\
|
||||
\
|
||||
"deployment\_uuid": "string",\
|
||||
\
|
||||
"pull\_request\_id": 0,\
|
||||
\
|
||||
"docker\_registry\_image\_tag": "string",\
|
||||
\
|
||||
"force\_rebuild": true,\
|
||||
\
|
||||
"commit": "string",\
|
||||
\
|
||||
"status": "string",\
|
||||
\
|
||||
"is\_webhook": true,\
|
||||
\
|
||||
"is\_api": true,\
|
||||
\
|
||||
"created\_at": "string",\
|
||||
\
|
||||
"updated\_at": "string",\
|
||||
\
|
||||
"logs": "string",\
|
||||
\
|
||||
"current\_process\_id": "string",\
|
||||
\
|
||||
"restart\_only": true,\
|
||||
\
|
||||
"git\_type": "string",\
|
||||
\
|
||||
"server\_id": 0,\
|
||||
\
|
||||
"application\_name": "string",\
|
||||
\
|
||||
"server\_name": "string",\
|
||||
\
|
||||
"deployment\_url": "string",\
|
||||
\
|
||||
"destination\_id": "string",\
|
||||
\
|
||||
"only\_this\_server": true,\
|
||||
\
|
||||
"rollback": true,\
|
||||
\
|
||||
"commit\_message": "string"\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]
|
||||
|
||||
GET
|
||||
|
||||
/deployments
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/list-deployments#playground)
|
||||
|
||||
------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/list-deployments#samples)
|
||||
|
||||
------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,129 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/list-envs-by-application-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
List Envs[](https://coolify.io/docs/api-reference/api/operations/list-envs-by-application-uuid#list-envs)
|
||||
|
||||
===========================================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/applications/{uuid}/envs
|
||||
|
||||
List all envs by application UUID.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/list-envs-by-application-uuid#authorizations)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/list-envs-by-application-uuid#parameters)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the application.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/list-envs-by-application-uuid#responses)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
All environment variables by application UUID.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
\[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"id": 0,\
|
||||
\
|
||||
"uuid": "string",\
|
||||
\
|
||||
"resourceable\_type": "string",\
|
||||
\
|
||||
"resourceable\_id": 0,\
|
||||
\
|
||||
"is\_literal": true,\
|
||||
\
|
||||
"is\_multiline": true,\
|
||||
\
|
||||
"is\_preview": true,\
|
||||
\
|
||||
"is\_runtime": true,\
|
||||
\
|
||||
"is\_buildtime": true,\
|
||||
\
|
||||
"is\_shared": true,\
|
||||
\
|
||||
"is\_shown\_once": true,\
|
||||
\
|
||||
"key": "string",\
|
||||
\
|
||||
"value": "string",\
|
||||
\
|
||||
"real\_value": "string",\
|
||||
\
|
||||
"comment": "string",\
|
||||
\
|
||||
"version": "string",\
|
||||
\
|
||||
"created\_at": "string",\
|
||||
\
|
||||
"updated\_at": "string"\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]
|
||||
|
||||
GET
|
||||
|
||||
/applications/{uuid}/envs
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/list-envs-by-application-uuid#playground)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/list-envs-by-application-uuid#samples)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,171 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/list-envs-by-service-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
List Envs[](https://coolify.io/docs/api-reference/api/operations/list-envs-by-service-uuid#list-envs)
|
||||
|
||||
=======================================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/services/{uuid}/envs
|
||||
|
||||
List all envs by service UUID.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/list-envs-by-service-uuid#authorizations)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/list-envs-by-service-uuid#parameters)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the service.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/list-envs-by-service-uuid#responses)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
All environment variables by service UUID.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
\[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"id": 0,\
|
||||
\
|
||||
"uuid": "string",\
|
||||
\
|
||||
"resourceable\_type": "string",\
|
||||
\
|
||||
"resourceable\_id": 0,\
|
||||
\
|
||||
"is\_literal": true,\
|
||||
\
|
||||
"is\_multiline": true,\
|
||||
\
|
||||
"is\_preview": true,\
|
||||
\
|
||||
"is\_runtime": true,\
|
||||
\
|
||||
"is\_buildtime": true,\
|
||||
\
|
||||
"is\_shared": true,\
|
||||
\
|
||||
"is\_shown\_once": true,\
|
||||
\
|
||||
"key": "string",\
|
||||
\
|
||||
"value": "string",\
|
||||
\
|
||||
"real\_value": "string",\
|
||||
\
|
||||
"comment": "string",\
|
||||
\
|
||||
"version": "string",\
|
||||
\
|
||||
"created\_at": "string",\
|
||||
\
|
||||
"updated\_at": "string"\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]
|
||||
|
||||
GET
|
||||
|
||||
/services/{uuid}/envs
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/list-envs-by-service-uuid#playground)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/list-envs-by-service-uuid#samples)
|
||||
|
||||
---------------------------------------------------------------------------------------------------
|
||||
|
||||
BrunocURLJavaScriptPHPPython
|
||||
|
||||
Bruno
|
||||
|
||||
GET https://app.coolify.io/api/v1/services/%7Buuid%7D/envs
|
||||
|
||||
Headers
|
||||
authorization: Token
|
||||
|
||||
|
||||
cURL
|
||||
|
||||
curl 'https://app.coolify.io/api/v1/services/{uuid}/envs' \
|
||||
--header 'Authorization: Token'
|
||||
|
||||
JavaScript
|
||||
|
||||
fetch('https://app.coolify.io/api/v1/services/{uuid}/envs', {
|
||||
headers: {
|
||||
Authorization: 'Token'
|
||||
}
|
||||
})
|
||||
|
||||
PHP
|
||||
|
||||
$ch = curl_init("https://app.coolify.io/api/v1/services/{uuid}/envs");
|
||||
|
||||
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Token']);
|
||||
|
||||
curl_exec($ch);
|
||||
|
||||
curl_close($ch);
|
||||
|
||||
Python
|
||||
|
||||
requests.get(
|
||||
"https://app.coolify.io/api/v1/services/{uuid}/envs",
|
||||
headers={
|
||||
"Authorization": "Token"
|
||||
}
|
||||
)
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,101 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/list-github-apps#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
List[](https://coolify.io/docs/api-reference/api/operations/list-github-apps#list)
|
||||
|
||||
====================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/github-apps
|
||||
|
||||
List all GitHub apps.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/list-github-apps#authorizations)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/list-github-apps#responses)
|
||||
|
||||
----------------------------------------------------------------------------------------------
|
||||
|
||||
200400401
|
||||
|
||||
List of GitHub apps.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
\[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"id": 0,\
|
||||
\
|
||||
"uuid": "string",\
|
||||
\
|
||||
"name": "string",\
|
||||
\
|
||||
"organization": "string",\
|
||||
\
|
||||
"api\_url": "string",\
|
||||
\
|
||||
"html\_url": "string",\
|
||||
\
|
||||
"custom\_user": "string",\
|
||||
\
|
||||
"custom\_port": 0,\
|
||||
\
|
||||
"app\_id": 0,\
|
||||
\
|
||||
"installation\_id": 0,\
|
||||
\
|
||||
"client\_id": "string",\
|
||||
\
|
||||
"private\_key\_id": 0,\
|
||||
\
|
||||
"is\_system\_wide": true,\
|
||||
\
|
||||
"is\_public": true,\
|
||||
\
|
||||
"team\_id": 0,\
|
||||
\
|
||||
"type": "string"\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]
|
||||
|
||||
GET
|
||||
|
||||
/github-apps
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/list-github-apps#playground)
|
||||
|
||||
------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/list-github-apps#samples)
|
||||
|
||||
------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,91 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/list-private-keys#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
List[](https://coolify.io/docs/api-reference/api/operations/list-private-keys#list)
|
||||
|
||||
=====================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/security/keys
|
||||
|
||||
List all private keys.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/list-private-keys#authorizations)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/list-private-keys#responses)
|
||||
|
||||
-----------------------------------------------------------------------------------------------
|
||||
|
||||
200400401
|
||||
|
||||
Get all private keys.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
\[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"id": 0,\
|
||||
\
|
||||
"uuid": "string",\
|
||||
\
|
||||
"name": "string",\
|
||||
\
|
||||
"description": "string",\
|
||||
\
|
||||
"private\_key": "string",\
|
||||
\
|
||||
"public\_key": "string",\
|
||||
\
|
||||
"fingerprint": "string",\
|
||||
\
|
||||
"is\_git\_related": true,\
|
||||
\
|
||||
"team\_id": 0,\
|
||||
\
|
||||
"created\_at": "string",\
|
||||
\
|
||||
"updated\_at": "string"\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]
|
||||
|
||||
GET
|
||||
|
||||
/security/keys
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/list-private-keys#playground)
|
||||
|
||||
-------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/list-private-keys#samples)
|
||||
|
||||
-------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,77 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/list-projects#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
List[](https://coolify.io/docs/api-reference/api/operations/list-projects#list)
|
||||
|
||||
=================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/projects
|
||||
|
||||
List projects.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/list-projects#authorizations)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/list-projects#responses)
|
||||
|
||||
-------------------------------------------------------------------------------------------
|
||||
|
||||
200400401
|
||||
|
||||
Get all projects.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
\[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"id": 0,\
|
||||
\
|
||||
"uuid": "string",\
|
||||
\
|
||||
"name": "string",\
|
||||
\
|
||||
"description": "string"\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]
|
||||
|
||||
GET
|
||||
|
||||
/projects
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/list-projects#playground)
|
||||
|
||||
---------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/list-projects#samples)
|
||||
|
||||
---------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,63 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/list-resources#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
List[](https://coolify.io/docs/api-reference/api/operations/list-resources#list)
|
||||
|
||||
==================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/resources
|
||||
|
||||
Get all resources.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/list-resources#authorizations)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/list-resources#responses)
|
||||
|
||||
--------------------------------------------------------------------------------------------
|
||||
|
||||
200400401
|
||||
|
||||
Get all resources
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
"string"
|
||||
|
||||
GET
|
||||
|
||||
/resources
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/list-resources#playground)
|
||||
|
||||
----------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/list-resources#samples)
|
||||
|
||||
----------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,181 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/list-servers#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
List[](https://coolify.io/docs/api-reference/api/operations/list-servers#list)
|
||||
|
||||
================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/servers
|
||||
|
||||
List all servers.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/list-servers#authorizations)
|
||||
|
||||
----------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/list-servers#responses)
|
||||
|
||||
------------------------------------------------------------------------------------------
|
||||
|
||||
200400401
|
||||
|
||||
Get all servers.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
\[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"id": 0,\
|
||||
\
|
||||
"uuid": "string",\
|
||||
\
|
||||
"name": "string",\
|
||||
\
|
||||
"description": "string",\
|
||||
\
|
||||
"ip": "string",\
|
||||
\
|
||||
"user": "string",\
|
||||
\
|
||||
"port": 0,\
|
||||
\
|
||||
"proxy": {\
|
||||
\
|
||||
},\
|
||||
\
|
||||
"proxy\_type": "string",\
|
||||
\
|
||||
"high\_disk\_usage\_notification\_sent": true,\
|
||||
\
|
||||
"unreachable\_notification\_sent": true,\
|
||||
\
|
||||
"unreachable\_count": 0,\
|
||||
\
|
||||
"validation\_logs": "string",\
|
||||
\
|
||||
"log\_drain\_notification\_sent": true,\
|
||||
\
|
||||
"swarm\_cluster": "string",\
|
||||
\
|
||||
"settings": {\
|
||||
\
|
||||
"id": 0,\
|
||||
\
|
||||
"concurrent\_builds": 0,\
|
||||
\
|
||||
"deployment\_queue\_limit": 0,\
|
||||
\
|
||||
"dynamic\_timeout": 0,\
|
||||
\
|
||||
"force\_disabled": true,\
|
||||
\
|
||||
"force\_server\_cleanup": true,\
|
||||
\
|
||||
"is\_build\_server": true,\
|
||||
\
|
||||
"is\_cloudflare\_tunnel": true,\
|
||||
\
|
||||
"is\_jump\_server": true,\
|
||||
\
|
||||
"is\_logdrain\_axiom\_enabled": true,\
|
||||
\
|
||||
"is\_logdrain\_custom\_enabled": true,\
|
||||
\
|
||||
"is\_logdrain\_highlight\_enabled": true,\
|
||||
\
|
||||
"is\_logdrain\_newrelic\_enabled": true,\
|
||||
\
|
||||
"is\_metrics\_enabled": true,\
|
||||
\
|
||||
"is\_reachable": true,\
|
||||
\
|
||||
"is\_sentinel\_enabled": true,\
|
||||
\
|
||||
"is\_swarm\_manager": true,\
|
||||
\
|
||||
"is\_swarm\_worker": true,\
|
||||
\
|
||||
"is\_terminal\_enabled": true,\
|
||||
\
|
||||
"is\_usable": true,\
|
||||
\
|
||||
"logdrain\_axiom\_api\_key": "string",\
|
||||
\
|
||||
"logdrain\_axiom\_dataset\_name": "string",\
|
||||
\
|
||||
"logdrain\_custom\_config": "string",\
|
||||
\
|
||||
"logdrain\_custom\_config\_parser": "string",\
|
||||
\
|
||||
"logdrain\_highlight\_project\_id": "string",\
|
||||
\
|
||||
"logdrain\_newrelic\_base\_uri": "string",\
|
||||
\
|
||||
"logdrain\_newrelic\_license\_key": "string",\
|
||||
\
|
||||
"sentinel\_metrics\_history\_days": 0,\
|
||||
\
|
||||
"sentinel\_metrics\_refresh\_rate\_seconds": 0,\
|
||||
\
|
||||
"sentinel\_token": "string",\
|
||||
\
|
||||
"docker\_cleanup\_frequency": "string",\
|
||||
\
|
||||
"docker\_cleanup\_threshold": 0,\
|
||||
\
|
||||
"server\_id": 0,\
|
||||
\
|
||||
"wildcard\_domain": "string",\
|
||||
\
|
||||
"created\_at": "string",\
|
||||
\
|
||||
"updated\_at": "string",\
|
||||
\
|
||||
"delete\_unused\_volumes": true,\
|
||||
\
|
||||
"delete\_unused\_networks": true\
|
||||
\
|
||||
}\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]
|
||||
|
||||
GET
|
||||
|
||||
/servers
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/list-servers#playground)
|
||||
|
||||
--------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/list-servers#samples)
|
||||
|
||||
--------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,105 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/list-services#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
List[](https://coolify.io/docs/api-reference/api/operations/list-services#list)
|
||||
|
||||
=================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/services
|
||||
|
||||
List all services.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/list-services#authorizations)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/list-services#responses)
|
||||
|
||||
-------------------------------------------------------------------------------------------
|
||||
|
||||
200400401
|
||||
|
||||
Get all services
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
\[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"id": 0,\
|
||||
\
|
||||
"uuid": "string",\
|
||||
\
|
||||
"name": "string",\
|
||||
\
|
||||
"environment\_id": 0,\
|
||||
\
|
||||
"server\_id": 0,\
|
||||
\
|
||||
"description": "string",\
|
||||
\
|
||||
"docker\_compose\_raw": "string",\
|
||||
\
|
||||
"docker\_compose": "string",\
|
||||
\
|
||||
"destination\_type": "string",\
|
||||
\
|
||||
"destination\_id": 0,\
|
||||
\
|
||||
"connect\_to\_docker\_network": true,\
|
||||
\
|
||||
"is\_container\_label\_escape\_enabled": true,\
|
||||
\
|
||||
"is\_container\_label\_readonly\_enabled": true,\
|
||||
\
|
||||
"config\_hash": "string",\
|
||||
\
|
||||
"service\_type": "string",\
|
||||
\
|
||||
"created\_at": "string",\
|
||||
\
|
||||
"updated\_at": "string",\
|
||||
\
|
||||
"deleted\_at": "string"\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]
|
||||
|
||||
GET
|
||||
|
||||
/services
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/list-services#playground)
|
||||
|
||||
---------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/list-services#samples)
|
||||
|
||||
---------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,111 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/list-teams#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
List[](https://coolify.io/docs/api-reference/api/operations/list-teams#list)
|
||||
|
||||
==============================================================================
|
||||
|
||||
GET
|
||||
|
||||
/teams
|
||||
|
||||
Get all teams.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/list-teams#authorizations)
|
||||
|
||||
--------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/list-teams#responses)
|
||||
|
||||
----------------------------------------------------------------------------------------
|
||||
|
||||
200400401
|
||||
|
||||
List of teams.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
\[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"id": 0,\
|
||||
\
|
||||
"name": "string",\
|
||||
\
|
||||
"description": "string",\
|
||||
\
|
||||
"personal\_team": true,\
|
||||
\
|
||||
"created\_at": "string",\
|
||||
\
|
||||
"updated\_at": "string",\
|
||||
\
|
||||
"show\_boarding": true,\
|
||||
\
|
||||
"custom\_server\_limit": "string",\
|
||||
\
|
||||
"members": \[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"id": 0,\
|
||||
\
|
||||
"name": "string",\
|
||||
\
|
||||
"email": "string",\
|
||||
\
|
||||
"email\_verified\_at": "string",\
|
||||
\
|
||||
"created\_at": "string",\
|
||||
\
|
||||
"updated\_at": "string",\
|
||||
\
|
||||
"two\_factor\_confirmed\_at": "string",\
|
||||
\
|
||||
"force\_password\_reset": true,\
|
||||
\
|
||||
"marketing\_emails": true\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]
|
||||
|
||||
GET
|
||||
|
||||
/teams
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/list-teams#playground)
|
||||
|
||||
------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/list-teams#samples)
|
||||
|
||||
------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,121 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/load-branches#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Load Branches for a GitHub Repository[](https://coolify.io/docs/api-reference/api/operations/load-branches#load-branches-for-a-github-repository)
|
||||
|
||||
===================================================================================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/github-apps/{github\_app\_id}/repositories/{owner}/{repo}/branches
|
||||
|
||||
Fetch branches from GitHub for a given repository.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/load-branches#authorizations)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/load-branches#parameters)
|
||||
|
||||
---------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
github\_app\_id\*
|
||||
|
||||
GitHub App ID
|
||||
|
||||
Type
|
||||
|
||||
integer
|
||||
|
||||
Required
|
||||
|
||||
owner\*
|
||||
|
||||
Repository owner
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
repo\*
|
||||
|
||||
Repository name
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/load-branches#responses)
|
||||
|
||||
-------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
Branches loaded successfully.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"branches": \[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]
|
||||
|
||||
}
|
||||
|
||||
GET
|
||||
|
||||
/github-apps/{github\_app\_id}/repositories/{owner}/{repo}/branches
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/load-branches#playground)
|
||||
|
||||
---------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
github\_app\_id\*
|
||||
|
||||
owner\*
|
||||
|
||||
repo\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/load-branches#samples)
|
||||
|
||||
---------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,97 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/load-repositories#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Load Repositories for a GitHub App[](https://coolify.io/docs/api-reference/api/operations/load-repositories#load-repositories-for-a-github-app)
|
||||
|
||||
=================================================================================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/github-apps/{github\_app\_id}/repositories
|
||||
|
||||
Fetch repositories from GitHub for a given GitHub app.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/load-repositories#authorizations)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/load-repositories#parameters)
|
||||
|
||||
-------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
github\_app\_id\*
|
||||
|
||||
GitHub App ID
|
||||
|
||||
Type
|
||||
|
||||
integer
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/load-repositories#responses)
|
||||
|
||||
-----------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
Repositories loaded successfully.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"repositories": \[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\]
|
||||
|
||||
}
|
||||
|
||||
GET
|
||||
|
||||
/github-apps/{github\_app\_id}/repositories
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/load-repositories#playground)
|
||||
|
||||
-------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
github\_app\_id\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/load-repositories#samples)
|
||||
|
||||
-------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,93 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/restart-application-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Restart[](https://coolify.io/docs/api-reference/api/operations/restart-application-by-uuid#restart)
|
||||
|
||||
=====================================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/applications/{uuid}/restart
|
||||
|
||||
Restart application. `Post` request is also accepted.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/restart-application-by-uuid#authorizations)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/restart-application-by-uuid#parameters)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the application.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/restart-application-by-uuid#responses)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
Restart application.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"message": "Restart request queued.",
|
||||
|
||||
"deployment\_uuid": "doogksw"
|
||||
|
||||
}
|
||||
|
||||
GET
|
||||
|
||||
/applications/{uuid}/restart
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/restart-application-by-uuid#playground)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/restart-application-by-uuid#samples)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,91 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/restart-database-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Restart[](https://coolify.io/docs/api-reference/api/operations/restart-database-by-uuid#restart)
|
||||
|
||||
==================================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/databases/{uuid}/restart
|
||||
|
||||
Restart database. `Post` request is also accepted.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/restart-database-by-uuid#authorizations)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/restart-database-by-uuid#parameters)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the database.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/restart-database-by-uuid#responses)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
Restart database.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"message": "Database restaring request queued."
|
||||
|
||||
}
|
||||
|
||||
GET
|
||||
|
||||
/databases/{uuid}/restart
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/restart-database-by-uuid#playground)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/restart-database-by-uuid#samples)
|
||||
|
||||
--------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,149 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/restart-service-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Restart[](https://coolify.io/docs/api-reference/api/operations/restart-service-by-uuid#restart)
|
||||
|
||||
=================================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/services/{uuid}/restart
|
||||
|
||||
Restart service. `Post` request is also accepted.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/restart-service-by-uuid#authorizations)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/restart-service-by-uuid#parameters)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the service.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
### Query Parameters
|
||||
|
||||
latest
|
||||
|
||||
Pull latest images.
|
||||
|
||||
Type
|
||||
|
||||
boolean
|
||||
|
||||
Default
|
||||
|
||||
`false`
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/restart-service-by-uuid#responses)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
Restart service.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"message": "Service restaring request queued."
|
||||
|
||||
}
|
||||
|
||||
GET
|
||||
|
||||
/services/{uuid}/restart
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/restart-service-by-uuid#playground)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
latest
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/restart-service-by-uuid#samples)
|
||||
|
||||
-------------------------------------------------------------------------------------------------
|
||||
|
||||
BrunocURLJavaScriptPHPPython
|
||||
|
||||
Bruno
|
||||
|
||||
GET https://app.coolify.io/api/v1/services/%7Buuid%7D/restart
|
||||
|
||||
Headers
|
||||
authorization: Token
|
||||
|
||||
|
||||
cURL
|
||||
|
||||
curl 'https://app.coolify.io/api/v1/services/{uuid}/restart' \
|
||||
--header 'Authorization: Token'
|
||||
|
||||
JavaScript
|
||||
|
||||
fetch('https://app.coolify.io/api/v1/services/{uuid}/restart', {
|
||||
headers: {
|
||||
Authorization: 'Token'
|
||||
}
|
||||
})
|
||||
|
||||
PHP
|
||||
|
||||
$ch = curl_init("https://app.coolify.io/api/v1/services/{uuid}/restart");
|
||||
|
||||
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Token']);
|
||||
|
||||
curl_exec($ch);
|
||||
|
||||
curl_close($ch);
|
||||
|
||||
Python
|
||||
|
||||
requests.get(
|
||||
"https://app.coolify.io/api/v1/services/{uuid}/restart",
|
||||
headers={
|
||||
"Authorization": "Token"
|
||||
}
|
||||
)
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,123 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/start-application-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Start[](https://coolify.io/docs/api-reference/api/operations/start-application-by-uuid#start)
|
||||
|
||||
===============================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/applications/{uuid}/start
|
||||
|
||||
Start application. `Post` request is also accepted.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/start-application-by-uuid#authorizations)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/start-application-by-uuid#parameters)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the application.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
### Query Parameters
|
||||
|
||||
force
|
||||
|
||||
Force rebuild.
|
||||
|
||||
Type
|
||||
|
||||
boolean
|
||||
|
||||
Default
|
||||
|
||||
`false`
|
||||
|
||||
instant\_deploy
|
||||
|
||||
Instant deploy (skip queuing).
|
||||
|
||||
Type
|
||||
|
||||
boolean
|
||||
|
||||
Default
|
||||
|
||||
`false`
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/start-application-by-uuid#responses)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
Start application.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"message": "Deployment request queued.",
|
||||
|
||||
"deployment\_uuid": "doogksw"
|
||||
|
||||
}
|
||||
|
||||
GET
|
||||
|
||||
/applications/{uuid}/start
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/start-application-by-uuid#playground)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
force
|
||||
|
||||
instant\_deploy
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/start-application-by-uuid#samples)
|
||||
|
||||
---------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,91 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/start-database-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Start[](https://coolify.io/docs/api-reference/api/operations/start-database-by-uuid#start)
|
||||
|
||||
============================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/databases/{uuid}/start
|
||||
|
||||
Start database. `Post` request is also accepted.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/start-database-by-uuid#authorizations)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/start-database-by-uuid#parameters)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the database.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/start-database-by-uuid#responses)
|
||||
|
||||
----------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
Start database.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"message": "Database starting request queued."
|
||||
|
||||
}
|
||||
|
||||
GET
|
||||
|
||||
/databases/{uuid}/start
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/start-database-by-uuid#playground)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/start-database-by-uuid#samples)
|
||||
|
||||
------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,91 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/start-service-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Start[](https://coolify.io/docs/api-reference/api/operations/start-service-by-uuid#start)
|
||||
|
||||
===========================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/services/{uuid}/start
|
||||
|
||||
Start service. `Post` request is also accepted.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/start-service-by-uuid#authorizations)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/start-service-by-uuid#parameters)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the service.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/start-service-by-uuid#responses)
|
||||
|
||||
---------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
Start service.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"message": "Service starting request queued."
|
||||
|
||||
}
|
||||
|
||||
GET
|
||||
|
||||
/services/{uuid}/start
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/start-service-by-uuid#playground)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/start-service-by-uuid#samples)
|
||||
|
||||
-----------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,107 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/stop-application-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Stop[](https://coolify.io/docs/api-reference/api/operations/stop-application-by-uuid#stop)
|
||||
|
||||
============================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/applications/{uuid}/stop
|
||||
|
||||
Stop application. `Post` request is also accepted.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/stop-application-by-uuid#authorizations)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/stop-application-by-uuid#parameters)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the application.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
### Query Parameters
|
||||
|
||||
docker\_cleanup
|
||||
|
||||
Perform docker cleanup (prune networks, volumes, etc.).
|
||||
|
||||
Type
|
||||
|
||||
boolean
|
||||
|
||||
Default
|
||||
|
||||
`true`
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/stop-application-by-uuid#responses)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
Stop application.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"message": "Application stopping request queued."
|
||||
|
||||
}
|
||||
|
||||
GET
|
||||
|
||||
/applications/{uuid}/stop
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/stop-application-by-uuid#playground)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
docker\_cleanup
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/stop-application-by-uuid#samples)
|
||||
|
||||
--------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,107 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/stop-database-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Stop[](https://coolify.io/docs/api-reference/api/operations/stop-database-by-uuid#stop)
|
||||
|
||||
=========================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/databases/{uuid}/stop
|
||||
|
||||
Stop database. `Post` request is also accepted.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/stop-database-by-uuid#authorizations)
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/stop-database-by-uuid#parameters)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the database.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
### Query Parameters
|
||||
|
||||
docker\_cleanup
|
||||
|
||||
Perform docker cleanup (prune networks, volumes, etc.).
|
||||
|
||||
Type
|
||||
|
||||
boolean
|
||||
|
||||
Default
|
||||
|
||||
`true`
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/stop-database-by-uuid#responses)
|
||||
|
||||
---------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
Stop database.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"message": "Database stopping request queued."
|
||||
|
||||
}
|
||||
|
||||
GET
|
||||
|
||||
/databases/{uuid}/stop
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/stop-database-by-uuid#playground)
|
||||
|
||||
-----------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
docker\_cleanup
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/stop-database-by-uuid#samples)
|
||||
|
||||
-----------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,107 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/stop-service-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Stop[](https://coolify.io/docs/api-reference/api/operations/stop-service-by-uuid#stop)
|
||||
|
||||
========================================================================================
|
||||
|
||||
GET
|
||||
|
||||
/services/{uuid}/stop
|
||||
|
||||
Stop service. `Post` request is also accepted.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/stop-service-by-uuid#authorizations)
|
||||
|
||||
------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/stop-service-by-uuid#parameters)
|
||||
|
||||
----------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the service.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
### Query Parameters
|
||||
|
||||
docker\_cleanup
|
||||
|
||||
Perform docker cleanup (prune networks, volumes, etc.).
|
||||
|
||||
Type
|
||||
|
||||
boolean
|
||||
|
||||
Default
|
||||
|
||||
`true`
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/stop-service-by-uuid#responses)
|
||||
|
||||
--------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404
|
||||
|
||||
Stop service.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"message": "Service stopping request queued."
|
||||
|
||||
}
|
||||
|
||||
GET
|
||||
|
||||
/services/{uuid}/stop
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/stop-service-by-uuid#playground)
|
||||
|
||||
----------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
docker\_cleanup
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/stop-service-by-uuid#samples)
|
||||
|
||||
----------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,253 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/update-application-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Update[](https://coolify.io/docs/api-reference/api/operations/update-application-by-uuid#update)
|
||||
|
||||
==================================================================================================
|
||||
|
||||
PATCH
|
||||
|
||||
/applications/{uuid}
|
||||
|
||||
Update application by UUID.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/update-application-by-uuid#authorizations)
|
||||
|
||||
------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/update-application-by-uuid#parameters)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the application.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/update-application-by-uuid#request-body)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"project\_uuid": "string",
|
||||
|
||||
"server\_uuid": "string",
|
||||
|
||||
"environment\_name": "string",
|
||||
|
||||
"github\_app\_uuid": "string",
|
||||
|
||||
"git\_repository": "string",
|
||||
|
||||
"git\_branch": "string",
|
||||
|
||||
"ports\_exposes": "string",
|
||||
|
||||
"destination\_uuid": "string",
|
||||
|
||||
"build\_pack": "string",
|
||||
|
||||
"name": "string",
|
||||
|
||||
"description": "string",
|
||||
|
||||
"domains": "string",
|
||||
|
||||
"git\_commit\_sha": "string",
|
||||
|
||||
"docker\_registry\_image\_name": "string",
|
||||
|
||||
"docker\_registry\_image\_tag": "string",
|
||||
|
||||
"is\_static": true,
|
||||
|
||||
"is\_spa": true,
|
||||
|
||||
"is\_auto\_deploy\_enabled": true,
|
||||
|
||||
"is\_force\_https\_enabled": true,
|
||||
|
||||
"install\_command": "string",
|
||||
|
||||
"build\_command": "string",
|
||||
|
||||
"start\_command": "string",
|
||||
|
||||
"ports\_mappings": "string",
|
||||
|
||||
"base\_directory": "string",
|
||||
|
||||
"publish\_directory": "string",
|
||||
|
||||
"health\_check\_enabled": true,
|
||||
|
||||
"health\_check\_path": "string",
|
||||
|
||||
"health\_check\_port": "string",
|
||||
|
||||
"health\_check\_host": "string",
|
||||
|
||||
"health\_check\_method": "string",
|
||||
|
||||
"health\_check\_return\_code": 0,
|
||||
|
||||
"health\_check\_scheme": "string",
|
||||
|
||||
"health\_check\_response\_text": "string",
|
||||
|
||||
"health\_check\_interval": 0,
|
||||
|
||||
"health\_check\_timeout": 0,
|
||||
|
||||
"health\_check\_retries": 0,
|
||||
|
||||
"health\_check\_start\_period": 0,
|
||||
|
||||
"limits\_memory": "string",
|
||||
|
||||
"limits\_memory\_swap": "string",
|
||||
|
||||
"limits\_memory\_swappiness": 0,
|
||||
|
||||
"limits\_memory\_reservation": "string",
|
||||
|
||||
"limits\_cpus": "string",
|
||||
|
||||
"limits\_cpuset": "string",
|
||||
|
||||
"limits\_cpu\_shares": 0,
|
||||
|
||||
"custom\_labels": "string",
|
||||
|
||||
"custom\_docker\_run\_options": "string",
|
||||
|
||||
"post\_deployment\_command": "string",
|
||||
|
||||
"post\_deployment\_command\_container": "string",
|
||||
|
||||
"pre\_deployment\_command": "string",
|
||||
|
||||
"pre\_deployment\_command\_container": "string",
|
||||
|
||||
"manual\_webhook\_secret\_github": "string",
|
||||
|
||||
"manual\_webhook\_secret\_gitlab": "string",
|
||||
|
||||
"manual\_webhook\_secret\_bitbucket": "string",
|
||||
|
||||
"manual\_webhook\_secret\_gitea": "string",
|
||||
|
||||
"redirect": "string",
|
||||
|
||||
"instant\_deploy": true,
|
||||
|
||||
"dockerfile": "string",
|
||||
|
||||
"dockerfile\_location": "string",
|
||||
|
||||
"docker\_compose\_location": "string",
|
||||
|
||||
"docker\_compose\_custom\_start\_command": "string",
|
||||
|
||||
"docker\_compose\_custom\_build\_command": "string",
|
||||
|
||||
"docker\_compose\_domains": \[\
|
||||
\
|
||||
{\
|
||||
\
|
||||
"name": "string",\
|
||||
\
|
||||
"domain": "string"\
|
||||
\
|
||||
}\
|
||||
\
|
||||
\],
|
||||
|
||||
"watch\_paths": "string",
|
||||
|
||||
"use\_build\_server": true,
|
||||
|
||||
"connect\_to\_docker\_network": true,
|
||||
|
||||
"force\_domain\_override": true,
|
||||
|
||||
"is\_container\_label\_escape\_enabled": true,
|
||||
|
||||
"is\_preserve\_repository\_enabled": true
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/update-application-by-uuid#responses)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404409
|
||||
|
||||
Application updated.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"uuid": "string"
|
||||
|
||||
}
|
||||
|
||||
PATCH
|
||||
|
||||
/applications/{uuid}
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/update-application-by-uuid#playground)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Body
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/update-application-by-uuid#samples)
|
||||
|
||||
----------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,109 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/update-cloud-token-by-uuid#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Update Cloud Provider Token[](https://coolify.io/docs/api-reference/api/operations/update-cloud-token-by-uuid#update-cloud-provider-token)
|
||||
|
||||
============================================================================================================================================
|
||||
|
||||
PATCH
|
||||
|
||||
/cloud-tokens/{uuid}
|
||||
|
||||
Update cloud provider token name.
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/update-cloud-token-by-uuid#authorizations)
|
||||
|
||||
------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/update-cloud-token-by-uuid#parameters)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
Token UUID
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/update-cloud-token-by-uuid#request-body)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"name": "string"
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/update-cloud-token-by-uuid#responses)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------
|
||||
|
||||
200401404422
|
||||
|
||||
Cloud provider token updated.
|
||||
|
||||
Content-Type
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"uuid": "string"
|
||||
|
||||
}
|
||||
|
||||
PATCH
|
||||
|
||||
/cloud-tokens/{uuid}
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/update-cloud-token-by-uuid#playground)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
Body
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/update-cloud-token-by-uuid#samples)
|
||||
|
||||
----------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
@@ -0,0 +1,133 @@
|
||||
[Skip to content](https://coolify.io/docs/api-reference/api/operations/update-database-backup#VPContent)
|
||||
|
||||
Return to top
|
||||
|
||||
Update[](https://coolify.io/docs/api-reference/api/operations/update-database-backup#update)
|
||||
|
||||
==============================================================================================
|
||||
|
||||
PATCH
|
||||
|
||||
/databases/{uuid}/backups/{scheduled\_backup\_uuid}
|
||||
|
||||
Update a specific backup configuration for a given database, identified by its UUID and the backup ID
|
||||
|
||||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/update-database-backup#authorizations)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------
|
||||
|
||||
bearerAuth
|
||||
|
||||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||||
|
||||
Type
|
||||
|
||||
HTTP (bearer)
|
||||
|
||||
Parameters[](https://coolify.io/docs/api-reference/api/operations/update-database-backup#parameters)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Path Parameters
|
||||
|
||||
uuid\*
|
||||
|
||||
UUID of the database.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
scheduled\_backup\_uuid\*
|
||||
|
||||
UUID of the backup configuration.
|
||||
|
||||
Type
|
||||
|
||||
string
|
||||
|
||||
Required
|
||||
|
||||
Request Body[](https://coolify.io/docs/api-reference/api/operations/update-database-backup#request-body)
|
||||
|
||||
----------------------------------------------------------------------------------------------------------
|
||||
|
||||
application/json
|
||||
|
||||
SchemaJSON
|
||||
|
||||
JSON
|
||||
|
||||
{
|
||||
|
||||
"save\_s3": true,
|
||||
|
||||
"s3\_storage\_uuid": "string",
|
||||
|
||||
"backup\_now": true,
|
||||
|
||||
"enabled": true,
|
||||
|
||||
"databases\_to\_backup": "string",
|
||||
|
||||
"dump\_all": true,
|
||||
|
||||
"frequency": "string",
|
||||
|
||||
"database\_backup\_retention\_amount\_locally": 0,
|
||||
|
||||
"database\_backup\_retention\_days\_locally": 0,
|
||||
|
||||
"database\_backup\_retention\_max\_storage\_locally": 0,
|
||||
|
||||
"database\_backup\_retention\_amount\_s3": 0,
|
||||
|
||||
"database\_backup\_retention\_days\_s3": 0,
|
||||
|
||||
"database\_backup\_retention\_max\_storage\_s3": 0,
|
||||
|
||||
"timeout": 3600
|
||||
|
||||
}
|
||||
|
||||
Responses[](https://coolify.io/docs/api-reference/api/operations/update-database-backup#responses)
|
||||
|
||||
----------------------------------------------------------------------------------------------------
|
||||
|
||||
200400401404422
|
||||
|
||||
Database backup configuration updated
|
||||
|
||||
PATCH
|
||||
|
||||
/databases/{uuid}/backups/{scheduled\_backup\_uuid}
|
||||
|
||||
Playground[](https://coolify.io/docs/api-reference/api/operations/update-database-backup#playground)
|
||||
|
||||
------------------------------------------------------------------------------------------------------
|
||||
|
||||
Authorization
|
||||
|
||||
bearerAuth
|
||||
|
||||
Variables
|
||||
|
||||
Key
|
||||
|
||||
Value
|
||||
|
||||
uuid\*
|
||||
|
||||
scheduled\_backup\_uuid\*
|
||||
|
||||
Body
|
||||
|
||||
Try it out
|
||||
|
||||
Samples[](https://coolify.io/docs/api-reference/api/operations/update-database-backup#samples)
|
||||
|
||||
------------------------------------------------------------------------------------------------
|
||||
|
||||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user