mirror of
https://github.com/LukeHagar/Coolify-TypeScript-SDK.git
synced 2025-12-06 04:19:26 +00:00
Saving initial generation
This commit is contained in:
Luke Hagar
30
.devcontainer/README.md
Normal file
30
.devcontainer/README.md
Normal file
@@ -0,0 +1,30 @@
|
||||
|
||||
> **Remember to shutdown a GitHub Codespace when it is not in use!**
|
||||
|
||||
# Dev Containers Quick Start
|
||||
|
||||
The default location for usage snippets is the `samples` directory.
|
||||
|
||||
## Running a Usage Sample
|
||||
|
||||
A sample usage example has been provided in a `root.ts` file. As you work with the SDK, it's expected that you will modify these samples to fit your needs. To execute this particular snippet, use the command below.
|
||||
|
||||
```
|
||||
ts-node root.ts
|
||||
```
|
||||
|
||||
## Generating Additional Usage Samples
|
||||
|
||||
The speakeasy CLI allows you to generate more usage snippets. Here's how:
|
||||
|
||||
- To generate a sample for a specific operation by providing an operation ID, use:
|
||||
|
||||
```
|
||||
speakeasy generate usage -s https://raw.githubusercontent.com/coollabsio/documentation-coolify/refs/heads/main/openapi.yaml -l typescript -i {INPUT_OPERATION_ID} -o ./samples
|
||||
```
|
||||
|
||||
- To generate samples for an entire namespace (like a tag or group name), use:
|
||||
|
||||
```
|
||||
speakeasy generate usage -s https://raw.githubusercontent.com/coollabsio/documentation-coolify/refs/heads/main/openapi.yaml -l typescript -n {INPUT_TAG_NAME} -o ./samples
|
||||
```
|
||||
45
.devcontainer/devcontainer.json
Normal file
45
.devcontainer/devcontainer.json
Normal file
@@ -0,0 +1,45 @@
|
||||
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
|
||||
// README at: https://github.com/devcontainers/images/tree/main/src/typescript-node
|
||||
{
|
||||
"name": "TypeScript",
|
||||
"image": "mcr.microsoft.com/devcontainers/typescript-node:1-20-bullseye",
|
||||
// Features to add to the dev container. More info: https://containers.dev/features.
|
||||
// "features": {},
|
||||
// Use 'forwardPorts' to make a list of ports inside the container available locally.
|
||||
// "forwardPorts": [],
|
||||
// Use 'postCreateCommand' to run commands after the container is created.
|
||||
"postCreateCommand": "sudo chmod +x ./.devcontainer/setup.sh && ./.devcontainer/setup.sh",
|
||||
"customizations": {
|
||||
"vscode": {
|
||||
"extensions": [
|
||||
"ms-vscode.vscode-typescript-tslint-plugin",
|
||||
"esbenp.prettier-vscode",
|
||||
"github.vscode-pull-request-github"
|
||||
],
|
||||
"settings": {
|
||||
"files.eol": "\n",
|
||||
"editor.formatOnSave": true,
|
||||
"typescript.tsc.autoDetect": "on",
|
||||
"typescript.updateImportsOnFileMove.enabled": "always",
|
||||
"typescript.preferences.importModuleSpecifier": "relative",
|
||||
"[typescript]": {
|
||||
"editor.codeActionsOnSave": {
|
||||
"source.organizeImports": true
|
||||
}
|
||||
},
|
||||
"[typescriptreact]": {
|
||||
"editor.codeActionsOnSave": {
|
||||
"source.organizeImports": true
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"codespaces": {
|
||||
"openFiles": [
|
||||
".devcontainer/README.md"
|
||||
]
|
||||
}
|
||||
}
|
||||
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
|
||||
// "remoteUser": "root"
|
||||
}
|
||||
30
.devcontainer/setup.sh
Normal file
30
.devcontainer/setup.sh
Normal file
@@ -0,0 +1,30 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Install the speakeasy CLI
|
||||
curl -fsSL https://raw.githubusercontent.com/speakeasy-api/speakeasy/main/install.sh | sh
|
||||
|
||||
# Setup samples directory
|
||||
rmdir samples || true
|
||||
mkdir samples
|
||||
|
||||
npm install
|
||||
npm install -g ts-node
|
||||
npm link
|
||||
npm link coolify
|
||||
TS_CONFIG_CONTENT=$(cat <<EOL
|
||||
{
|
||||
"compilerOptions": {
|
||||
"baseUrl": ".",
|
||||
"paths": {
|
||||
"openapi": ["../src/index"],
|
||||
"openapi/*": ["../src/*"]
|
||||
}
|
||||
},
|
||||
"include": ["./**/*.ts"]
|
||||
}
|
||||
EOL
|
||||
)
|
||||
echo "$TS_CONFIG_CONTENT" > samples/tsconfig.json
|
||||
|
||||
# Generate starter usage sample with speakeasy
|
||||
speakeasy generate usage -s https://raw.githubusercontent.com/coollabsio/documentation-coolify/refs/heads/main/openapi.yaml -l typescript -o samples/root.ts
|
||||
28
.eslintrc.cjs
Normal file
28
.eslintrc.cjs
Normal file
@@ -0,0 +1,28 @@
|
||||
/* eslint-env node */
|
||||
module.exports = {
|
||||
root: true,
|
||||
extends: [
|
||||
"eslint:recommended",
|
||||
"plugin:@typescript-eslint/recommended",
|
||||
"plugin:import/recommended",
|
||||
"plugin:import/typescript",
|
||||
],
|
||||
parser: "@typescript-eslint/parser",
|
||||
plugins: ["@typescript-eslint"],
|
||||
settings: {
|
||||
"import/resolver": {
|
||||
typescript: true,
|
||||
node: true,
|
||||
},
|
||||
},
|
||||
rules: {
|
||||
// Handled by typescript compiler
|
||||
"@typescript-eslint/no-unused-vars": "off",
|
||||
"@typescript-eslint/ban-types": "off",
|
||||
"@typescript-eslint/no-namespace": "off",
|
||||
"@typescript-eslint/no-explicit-any": "off",
|
||||
"import/no-named-as-default-member": "off",
|
||||
|
||||
"import/no-default-export": "error",
|
||||
},
|
||||
};
|
||||
2
.gitattributes
vendored
Normal file
2
.gitattributes
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
# This allows generated code to be indexed correctly
|
||||
*.ts linguist-generated=false
|
||||
17
.gitignore
vendored
Normal file
17
.gitignore
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
/models
|
||||
/models/errors
|
||||
/types
|
||||
/node_modules
|
||||
/lib
|
||||
/sdk
|
||||
/funcs
|
||||
/hooks
|
||||
/index.*
|
||||
/core.*
|
||||
/cjs
|
||||
/esm
|
||||
/dist
|
||||
/.tsbuildinfo
|
||||
/.tshy
|
||||
/.tshy-*
|
||||
/__tests__
|
||||
10
.npmignore
Normal file
10
.npmignore
Normal file
@@ -0,0 +1,10 @@
|
||||
**/*
|
||||
!/**/*.ts
|
||||
!/**/*.js
|
||||
!/**/*.map
|
||||
|
||||
/.eslintrc.js
|
||||
/cjs
|
||||
/.tshy
|
||||
/.tshy-*
|
||||
/__tests__
|
||||
1804
.speakeasy/gen.lock
Normal file
1804
.speakeasy/gen.lock
Normal file
File diff suppressed because it is too large
Load Diff
48
.speakeasy/gen.yaml
Normal file
48
.speakeasy/gen.yaml
Normal file
@@ -0,0 +1,48 @@
|
||||
configVersion: 2.0.0
|
||||
generation:
|
||||
devContainers:
|
||||
enabled: true
|
||||
schemaPath: https://raw.githubusercontent.com/coollabsio/documentation-coolify/refs/heads/main/openapi.yaml
|
||||
sdkClassName: Coolify
|
||||
maintainOpenAPIOrder: true
|
||||
usageSnippets:
|
||||
optionalPropertyRendering: withExample
|
||||
useClassNamesForArrayFields: true
|
||||
fixes:
|
||||
nameResolutionDec2023: true
|
||||
parameterOrderingFeb2024: true
|
||||
requestResponseComponentNamesFeb2024: true
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: true
|
||||
oAuth2PasswordEnabled: true
|
||||
typescript:
|
||||
version: 0.1.1
|
||||
additionalDependencies:
|
||||
dependencies: {}
|
||||
devDependencies: {}
|
||||
peerDependencies: {}
|
||||
additionalPackageJSON: {}
|
||||
author: Speakeasy
|
||||
clientServerStatusCodesAsErrors: true
|
||||
defaultErrorName: APIError
|
||||
enumFormat: union
|
||||
envVarPrefix: COOLIFY
|
||||
flattenGlobalSecurity: true
|
||||
flatteningOrder: parameters-first
|
||||
imports:
|
||||
option: openapi
|
||||
paths:
|
||||
callbacks: models/callbacks
|
||||
errors: models/errors
|
||||
operations: models/operations
|
||||
shared: models/components
|
||||
webhooks: models/webhooks
|
||||
inputModelSuffix: input
|
||||
maxMethodParams: 0
|
||||
methodArguments: require-security-and-request
|
||||
moduleFormat: commonjs
|
||||
outputModelSuffix: output
|
||||
packageName: coolify
|
||||
responseFormat: flat
|
||||
templateVersion: v2
|
||||
useIndexModules: true
|
||||
36
.speakeasy/workflow.lock
Normal file
36
.speakeasy/workflow.lock
Normal file
@@ -0,0 +1,36 @@
|
||||
speakeasyVersion: 1.441.0
|
||||
sources:
|
||||
Coolify-OAS:
|
||||
sourceNamespace: coolify-oas
|
||||
sourceRevisionDigest: sha256:6f90b2e956ab8c0b49b28a442b3315a73ef04bedc9caf4a55d496547cd6ef283
|
||||
sourceBlobDigest: sha256:8b9fa64561d834d376afef39a6ebecd3814c914ca8f134b1cea2eca72cf33919
|
||||
tags:
|
||||
- latest
|
||||
targets:
|
||||
coolify:
|
||||
source: Coolify-OAS
|
||||
sourceNamespace: coolify-oas
|
||||
sourceRevisionDigest: sha256:6f90b2e956ab8c0b49b28a442b3315a73ef04bedc9caf4a55d496547cd6ef283
|
||||
sourceBlobDigest: sha256:8b9fa64561d834d376afef39a6ebecd3814c914ca8f134b1cea2eca72cf33919
|
||||
codeSamplesNamespace: coolify-oas-code-samples
|
||||
codeSamplesRevisionDigest: sha256:f093bd5deaaeea41ab713948ef4b25ccffc80af0e111f75b772fc27e1b03b54d
|
||||
workflow:
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
sources:
|
||||
Coolify-OAS:
|
||||
inputs:
|
||||
- location: ./OpenAPI.yaml
|
||||
overlays:
|
||||
- location: ./speakeasy-suggested-name-overlay.yaml
|
||||
- location: ./speakeasy-suggested-error-overlay.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/coolify-oas
|
||||
targets:
|
||||
coolify:
|
||||
target: typescript
|
||||
source: Coolify-OAS
|
||||
codeSamples:
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/coolify-oas-code-samples
|
||||
blocking: false
|
||||
19
.speakeasy/workflow.yaml
Normal file
19
.speakeasy/workflow.yaml
Normal file
@@ -0,0 +1,19 @@
|
||||
workflowVersion: 1.0.0
|
||||
speakeasyVersion: latest
|
||||
sources:
|
||||
Coolify-OAS:
|
||||
inputs:
|
||||
- location: ./OpenAPI.yaml
|
||||
overlays:
|
||||
- location: ./speakeasy-suggested-name-overlay.yaml
|
||||
- location: ./speakeasy-suggested-error-overlay.yaml
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/coolify-oas
|
||||
targets:
|
||||
coolify:
|
||||
target: typescript
|
||||
source: Coolify-OAS
|
||||
codeSamples:
|
||||
registry:
|
||||
location: registry.speakeasyapi.dev/lukehagar/lukehagar/coolify-oas-code-samples
|
||||
blocking: false
|
||||
26
CONTRIBUTING.md
Normal file
26
CONTRIBUTING.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# Contributing to This Repository
|
||||
|
||||
Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements.
|
||||
|
||||
## How to Report Issues
|
||||
|
||||
If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes:
|
||||
|
||||
- A clear and descriptive title
|
||||
- Steps to reproduce the issue
|
||||
- Expected and actual behavior
|
||||
- Any relevant logs, screenshots, or error messages
|
||||
- Information about your environment (e.g., operating system, software versions)
|
||||
- For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed
|
||||
|
||||
## Issue Triage and Upstream Fixes
|
||||
|
||||
We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code.
|
||||
|
||||
## Contact
|
||||
|
||||
If you have any questions or need further assistance, please feel free to reach out by opening an issue.
|
||||
|
||||
Thank you for your understanding and cooperation!
|
||||
|
||||
The Maintainers
|
||||
104
FUNCTIONS.md
Normal file
104
FUNCTIONS.md
Normal file
@@ -0,0 +1,104 @@
|
||||
# Standalone Functions
|
||||
|
||||
> [!NOTE]
|
||||
> This section is useful if you are using a bundler and targetting browsers and
|
||||
> runtimes where the size of an application affects performance and load times.
|
||||
|
||||
Every method in this SDK is also available as a standalone function. This
|
||||
alternative API is suitable when targetting the browser or serverless runtimes
|
||||
and using a bundler to build your application since all unused functionality
|
||||
will be tree-shaken away. This includes code for unused methods, Zod schemas,
|
||||
encoding helpers and response handlers. The result is dramatically smaller
|
||||
impact on the application's final bundle size which grows very slowly as you use
|
||||
more and more functionality from this SDK.
|
||||
|
||||
Calling methods through the main SDK class remains a valid and generally more
|
||||
more ergonomic option. Standalone functions represent an optimisation for a
|
||||
specific category of applications.
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { CoolifyCore } from "coolify/core.js";
|
||||
import { applicationsList } from "coolify/funcs/applicationsList.js";
|
||||
import { SDKValidationError } from "coolify/models/errors/sdkvalidationerror.js";
|
||||
|
||||
// Use `CoolifyCore` for best tree-shaking performance.
|
||||
// You can create one instance of it to use across an application.
|
||||
const coolify = new CoolifyCore({
|
||||
bearerAuth: process.env["COOLIFY_BEARER_AUTH"] ?? "",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const res = await applicationsList(coolify);
|
||||
|
||||
switch (true) {
|
||||
case res.ok:
|
||||
// The success case will be handled outside of the switch block
|
||||
break;
|
||||
case res.error instanceof SDKValidationError:
|
||||
// Pretty-print validation errors.
|
||||
return console.log(res.error.pretty());
|
||||
case res.error instanceof Error:
|
||||
return console.log(res.error);
|
||||
default:
|
||||
// TypeScript's type checking will fail on the following line if the above
|
||||
// cases were not exhaustive.
|
||||
res.error satisfies never;
|
||||
throw new Error("Assertion failed: expected error checks to be exhaustive: " + res.error);
|
||||
}
|
||||
|
||||
|
||||
const { value: result } = res;
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
|
||||
## Result types
|
||||
|
||||
Standalone functions differ from SDK methods in that they return a
|
||||
`Result<Value, Error>` type to capture _known errors_ and document them using
|
||||
the type system. By avoiding throwing errors, application code maintains clear
|
||||
control flow and error-handling become part of the regular flow of application
|
||||
code.
|
||||
|
||||
> We use the term "known errors" because standalone functions, and JavaScript
|
||||
> code in general, can still throw unexpected errors such as `TypeError`s,
|
||||
> `RangeError`s and `DOMException`s. Exhaustively catching all errors may be
|
||||
> something this SDK addresses in the future. Nevertheless, there is still a lot
|
||||
> of benefit from capturing most errors and turning them into values.
|
||||
|
||||
The second reason for this style of programming is because these functions will
|
||||
typically be used in front-end applications where exception throwing is
|
||||
sometimes discouraged or considered unidiomatic. React and similar ecosystems
|
||||
and libraries tend to promote this style of programming so that components
|
||||
render useful content under all states (loading, success, error and so on).
|
||||
|
||||
The general pattern when calling standalone functions looks like this:
|
||||
|
||||
```typescript
|
||||
import { Core } from "<sdk-package-name>";
|
||||
import { fetchSomething } from "<sdk-package-name>/funcs/fetchSomething.js";
|
||||
|
||||
const client = new Core();
|
||||
|
||||
async function run() {
|
||||
const result = await fetchSomething(client, { id: "123" });
|
||||
if (!result.ok) {
|
||||
// You can throw the error or handle it. It's your choice now.
|
||||
throw result.error;
|
||||
}
|
||||
|
||||
console.log(result.value);
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
|
||||
Notably, `result.error` above will have an explicit type compared to a try-catch
|
||||
variation where the error in the catch block can only be of type `unknown` (or
|
||||
`any` depending on your TypeScript settings).
|
||||
5504
OpenAPI.yaml
Normal file
5504
OpenAPI.yaml
Normal file
File diff suppressed because it is too large
Load Diff
629
README.md
Normal file
629
README.md
Normal file
@@ -0,0 +1,629 @@
|
||||
<div align="center">
|
||||
<img width="300px" src="https://coolify.io/docs/_astro/coolify-transparent.uB67yhAU.svg">
|
||||
<h1>Coolify Typescript SDK</h1>
|
||||
<p><strong>Self-hosting with superpowers.</strong></p>
|
||||
<p>Developer-friendly & type-safe Typescript SDK specifically catered to leverage the <strong>Coolify</strong> API.</p>
|
||||
<a href="https://coolify.io/docs/"><img src="https://img.shields.io/static/v1?label=Docs&message=API Ref&color=4c2cec&style=for-the-badge" /></a>
|
||||
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge" /></a>
|
||||
</div>
|
||||
|
||||
|
||||
<br /><br />
|
||||
> [!IMPORTANT]
|
||||
> This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/lukehagar/lukehagar). Delete this section before > publishing to a package manager.
|
||||
|
||||
<!-- Start Summary [summary] -->
|
||||
## Summary
|
||||
|
||||
|
||||
<!-- End Summary [summary] -->
|
||||
|
||||
<!-- Start Table of Contents [toc] -->
|
||||
## Table of Contents
|
||||
|
||||
* [SDK Installation](#sdk-installation)
|
||||
* [Requirements](#requirements)
|
||||
* [SDK Example Usage](#sdk-example-usage)
|
||||
* [Available Resources and Operations](#available-resources-and-operations)
|
||||
* [Standalone functions](#standalone-functions)
|
||||
* [Retries](#retries)
|
||||
* [Error Handling](#error-handling)
|
||||
* [Server Selection](#server-selection)
|
||||
* [Custom HTTP Client](#custom-http-client)
|
||||
* [Authentication](#authentication)
|
||||
* [Debugging](#debugging)
|
||||
<!-- End Table of Contents [toc] -->
|
||||
|
||||
<!-- Start SDK Installation [installation] -->
|
||||
## SDK Installation
|
||||
|
||||
The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
|
||||
|
||||
### NPM
|
||||
|
||||
```bash
|
||||
npm add https://github.com/LukeHagar/Coolify-TypeScript-SDK
|
||||
```
|
||||
|
||||
### PNPM
|
||||
|
||||
```bash
|
||||
pnpm add https://github.com/LukeHagar/Coolify-TypeScript-SDK
|
||||
```
|
||||
|
||||
### Bun
|
||||
|
||||
```bash
|
||||
bun add https://github.com/LukeHagar/Coolify-TypeScript-SDK
|
||||
```
|
||||
|
||||
### Yarn
|
||||
|
||||
```bash
|
||||
yarn add https://github.com/LukeHagar/Coolify-TypeScript-SDK zod
|
||||
|
||||
# Note that Yarn does not install peer dependencies automatically. You will need
|
||||
# to install zod as shown above.
|
||||
```
|
||||
<!-- End SDK Installation [installation] -->
|
||||
|
||||
<!-- Start Requirements [requirements] -->
|
||||
## Requirements
|
||||
|
||||
For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
|
||||
<!-- End Requirements [requirements] -->
|
||||
|
||||
<!-- Start SDK Example Usage [usage] -->
|
||||
## SDK Example Usage
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import { Coolify } from "coolify";
|
||||
|
||||
const coolify = new Coolify({
|
||||
bearerAuth: process.env["COOLIFY_BEARER_AUTH"] ?? "",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await coolify.applications.list();
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
<!-- End SDK Example Usage [usage] -->
|
||||
|
||||
<!-- Start Available Resources and Operations [operations] -->
|
||||
## Available Resources and Operations
|
||||
|
||||
<details open>
|
||||
<summary>Available methods</summary>
|
||||
|
||||
### [api](docs/sdks/api/README.md)
|
||||
|
||||
* [enable](docs/sdks/api/README.md#enable) - Enable API
|
||||
* [disable](docs/sdks/api/README.md#disable) - Disable API
|
||||
|
||||
### [applications](docs/sdks/applications/README.md)
|
||||
|
||||
* [list](docs/sdks/applications/README.md#list) - List
|
||||
* [createPublic](docs/sdks/applications/README.md#createpublic) - Create (Public)
|
||||
* [createPrivateGithubApp](docs/sdks/applications/README.md#createprivategithubapp) - Create (Private - GH App)
|
||||
* [createPrivateDeployKey](docs/sdks/applications/README.md#createprivatedeploykey) - Create (Private - Deploy Key)
|
||||
* [createDockerfile](docs/sdks/applications/README.md#createdockerfile) - Create (Dockerfile)
|
||||
* [createDockerImage](docs/sdks/applications/README.md#createdockerimage) - Create (Docker Image)
|
||||
* [createDockerCompose](docs/sdks/applications/README.md#createdockercompose) - Create (Docker Compose)
|
||||
* [get](docs/sdks/applications/README.md#get) - Get
|
||||
* [delete](docs/sdks/applications/README.md#delete) - Delete
|
||||
* [update](docs/sdks/applications/README.md#update) - Update
|
||||
* [listEnvs](docs/sdks/applications/README.md#listenvs) - List Envs
|
||||
* [createEnv](docs/sdks/applications/README.md#createenv) - Create Env
|
||||
* [updateEnv](docs/sdks/applications/README.md#updateenv) - Update Env
|
||||
* [updateEnvsBulk](docs/sdks/applications/README.md#updateenvsbulk) - Update Envs (Bulk)
|
||||
* [deleteEnv](docs/sdks/applications/README.md#deleteenv) - Delete Env
|
||||
* [start](docs/sdks/applications/README.md#start) - Start
|
||||
* [stop](docs/sdks/applications/README.md#stop) - Stop
|
||||
* [restart](docs/sdks/applications/README.md#restart) - Restart
|
||||
* [executeCommand](docs/sdks/applications/README.md#executecommand) - Execute Command
|
||||
|
||||
|
||||
### [databases](docs/sdks/databases/README.md)
|
||||
|
||||
* [list](docs/sdks/databases/README.md#list) - List
|
||||
* [get](docs/sdks/databases/README.md#get) - Get
|
||||
* [delete](docs/sdks/databases/README.md#delete) - Delete
|
||||
* [update](docs/sdks/databases/README.md#update) - Update
|
||||
* [createPostgresql](docs/sdks/databases/README.md#createpostgresql) - Create (PostgreSQL)
|
||||
* [createClickhouse](docs/sdks/databases/README.md#createclickhouse) - Create (Clickhouse)
|
||||
* [createDragonfly](docs/sdks/databases/README.md#createdragonfly) - Create (DragonFly)
|
||||
* [createRedis](docs/sdks/databases/README.md#createredis) - Create (Redis)
|
||||
* [createKeydb](docs/sdks/databases/README.md#createkeydb) - Create (KeyDB)
|
||||
* [createMariadb](docs/sdks/databases/README.md#createmariadb) - Create (MariaDB)
|
||||
* [createMysql](docs/sdks/databases/README.md#createmysql) - Create (MySQL)
|
||||
* [createMongodb](docs/sdks/databases/README.md#createmongodb) - Create (MongoDB)
|
||||
* [start](docs/sdks/databases/README.md#start) - Start
|
||||
* [stop](docs/sdks/databases/README.md#stop) - Stop
|
||||
* [restart](docs/sdks/databases/README.md#restart) - Restart
|
||||
|
||||
### [deployments](docs/sdks/deployments/README.md)
|
||||
|
||||
* [list](docs/sdks/deployments/README.md#list) - List
|
||||
* [get](docs/sdks/deployments/README.md#get) - Get
|
||||
* [deployByTagOrUuid](docs/sdks/deployments/README.md#deploybytagoruuid) - Deploy
|
||||
|
||||
### [health](docs/sdks/health/README.md)
|
||||
|
||||
* [check](docs/sdks/health/README.md#check) - Healthcheck
|
||||
|
||||
### [privateKeys](docs/sdks/privatekeys/README.md)
|
||||
|
||||
* [list](docs/sdks/privatekeys/README.md#list) - List
|
||||
* [create](docs/sdks/privatekeys/README.md#create) - Create
|
||||
* [update](docs/sdks/privatekeys/README.md#update) - Update
|
||||
* [get](docs/sdks/privatekeys/README.md#get) - Get
|
||||
* [delete](docs/sdks/privatekeys/README.md#delete) - Delete
|
||||
|
||||
### [projects](docs/sdks/projects/README.md)
|
||||
|
||||
* [list](docs/sdks/projects/README.md#list) - List
|
||||
* [create](docs/sdks/projects/README.md#create) - Create
|
||||
* [get](docs/sdks/projects/README.md#get) - Get
|
||||
* [delete](docs/sdks/projects/README.md#delete) - Delete
|
||||
* [update](docs/sdks/projects/README.md#update) - Update
|
||||
* [getEnvironment](docs/sdks/projects/README.md#getenvironment) - Environment
|
||||
|
||||
### [resources](docs/sdks/resources/README.md)
|
||||
|
||||
* [list](docs/sdks/resources/README.md#list) - List
|
||||
|
||||
### [servers](docs/sdks/servers/README.md)
|
||||
|
||||
* [list](docs/sdks/servers/README.md#list) - List
|
||||
* [create](docs/sdks/servers/README.md#create) - Create
|
||||
* [get](docs/sdks/servers/README.md#get) - Get
|
||||
* [delete](docs/sdks/servers/README.md#delete) - Delete
|
||||
* [update](docs/sdks/servers/README.md#update) - Update
|
||||
* [getResources](docs/sdks/servers/README.md#getresources) - Resources
|
||||
* [getDomains](docs/sdks/servers/README.md#getdomains) - Domains
|
||||
* [validate](docs/sdks/servers/README.md#validate) - Validate
|
||||
|
||||
### [services](docs/sdks/services/README.md)
|
||||
|
||||
* [list](docs/sdks/services/README.md#list) - List
|
||||
* [create](docs/sdks/services/README.md#create) - Create
|
||||
* [get](docs/sdks/services/README.md#get) - Get
|
||||
* [delete](docs/sdks/services/README.md#delete) - Delete
|
||||
* [listEnvs](docs/sdks/services/README.md#listenvs) - List Envs
|
||||
* [createEnv](docs/sdks/services/README.md#createenv) - Create Env
|
||||
* [updateEnv](docs/sdks/services/README.md#updateenv) - Update Env
|
||||
* [updateEnvsBulk](docs/sdks/services/README.md#updateenvsbulk) - Update Envs (Bulk)
|
||||
* [deleteEnv](docs/sdks/services/README.md#deleteenv) - Delete Env
|
||||
* [start](docs/sdks/services/README.md#start) - Start
|
||||
* [stop](docs/sdks/services/README.md#stop) - Stop
|
||||
* [restart](docs/sdks/services/README.md#restart) - Restart
|
||||
|
||||
### [teams](docs/sdks/teams/README.md)
|
||||
|
||||
* [list](docs/sdks/teams/README.md#list) - List
|
||||
* [get](docs/sdks/teams/README.md#get) - Get
|
||||
* [getMembers](docs/sdks/teams/README.md#getmembers) - Members
|
||||
* [getCurrent](docs/sdks/teams/README.md#getcurrent) - Authenticated Team
|
||||
* [getCurrentMembers](docs/sdks/teams/README.md#getcurrentmembers) - Authenticated Team Members
|
||||
|
||||
### [version](docs/sdks/version/README.md)
|
||||
|
||||
* [get](docs/sdks/version/README.md#get) - Version
|
||||
|
||||
</details>
|
||||
<!-- End Available Resources and Operations [operations] -->
|
||||
|
||||
<!-- Start Standalone functions [standalone-funcs] -->
|
||||
## Standalone functions
|
||||
|
||||
All the methods listed above are available as standalone functions. These
|
||||
functions are ideal for use in applications running in the browser, serverless
|
||||
runtimes or other environments where application bundle size is a primary
|
||||
concern. When using a bundler to build your application, all unused
|
||||
functionality will be either excluded from the final bundle or tree-shaken away.
|
||||
|
||||
To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
||||
|
||||
<details>
|
||||
|
||||
<summary>Available standalone functions</summary>
|
||||
|
||||
- [`apiDisable`](docs/sdks/api/README.md#disable) - Disable API
|
||||
- [`apiEnable`](docs/sdks/api/README.md#enable) - Enable API
|
||||
- [`applicationsCreateDockerCompose`](docs/sdks/applications/README.md#createdockercompose) - Create (Docker Compose)
|
||||
- [`applicationsCreateDockerfile`](docs/sdks/applications/README.md#createdockerfile) - Create (Dockerfile)
|
||||
- [`applicationsCreateDockerImage`](docs/sdks/applications/README.md#createdockerimage) - Create (Docker Image)
|
||||
- [`applicationsCreateEnv`](docs/sdks/applications/README.md#createenv) - Create Env
|
||||
- [`applicationsCreatePrivateDeployKey`](docs/sdks/applications/README.md#createprivatedeploykey) - Create (Private - Deploy Key)
|
||||
- [`applicationsCreatePrivateGithubApp`](docs/sdks/applications/README.md#createprivategithubapp) - Create (Private - GH App)
|
||||
- [`applicationsCreatePublic`](docs/sdks/applications/README.md#createpublic) - Create (Public)
|
||||
- [`applicationsDelete`](docs/sdks/applications/README.md#delete) - Delete
|
||||
- [`applicationsDeleteEnv`](docs/sdks/applications/README.md#deleteenv) - Delete Env
|
||||
- [`applicationsExecuteCommand`](docs/sdks/applications/README.md#executecommand) - Execute Command
|
||||
- [`applicationsGet`](docs/sdks/applications/README.md#get) - Get
|
||||
- [`applicationsList`](docs/sdks/applications/README.md#list) - List
|
||||
- [`applicationsListEnvs`](docs/sdks/applications/README.md#listenvs) - List Envs
|
||||
- [`applicationsRestart`](docs/sdks/applications/README.md#restart) - Restart
|
||||
- [`applicationsStart`](docs/sdks/applications/README.md#start) - Start
|
||||
- [`applicationsStop`](docs/sdks/applications/README.md#stop) - Stop
|
||||
- [`applicationsUpdate`](docs/sdks/applications/README.md#update) - Update
|
||||
- [`applicationsUpdateEnv`](docs/sdks/applications/README.md#updateenv) - Update Env
|
||||
- [`applicationsUpdateEnvsBulk`](docs/sdks/applications/README.md#updateenvsbulk) - Update Envs (Bulk)
|
||||
- [`databasesCreateClickhouse`](docs/sdks/databases/README.md#createclickhouse) - Create (Clickhouse)
|
||||
- [`databasesCreateDragonfly`](docs/sdks/databases/README.md#createdragonfly) - Create (DragonFly)
|
||||
- [`databasesCreateKeydb`](docs/sdks/databases/README.md#createkeydb) - Create (KeyDB)
|
||||
- [`databasesCreateMariadb`](docs/sdks/databases/README.md#createmariadb) - Create (MariaDB)
|
||||
- [`databasesCreateMongodb`](docs/sdks/databases/README.md#createmongodb) - Create (MongoDB)
|
||||
- [`databasesCreateMysql`](docs/sdks/databases/README.md#createmysql) - Create (MySQL)
|
||||
- [`databasesCreatePostgresql`](docs/sdks/databases/README.md#createpostgresql) - Create (PostgreSQL)
|
||||
- [`databasesCreateRedis`](docs/sdks/databases/README.md#createredis) - Create (Redis)
|
||||
- [`databasesDelete`](docs/sdks/databases/README.md#delete) - Delete
|
||||
- [`databasesGet`](docs/sdks/databases/README.md#get) - Get
|
||||
- [`databasesList`](docs/sdks/databases/README.md#list) - List
|
||||
- [`databasesRestart`](docs/sdks/databases/README.md#restart) - Restart
|
||||
- [`databasesStart`](docs/sdks/databases/README.md#start) - Start
|
||||
- [`databasesStop`](docs/sdks/databases/README.md#stop) - Stop
|
||||
- [`databasesUpdate`](docs/sdks/databases/README.md#update) - Update
|
||||
- [`deploymentsDeployByTagOrUuid`](docs/sdks/deployments/README.md#deploybytagoruuid) - Deploy
|
||||
- [`deploymentsGet`](docs/sdks/deployments/README.md#get) - Get
|
||||
- [`deploymentsList`](docs/sdks/deployments/README.md#list) - List
|
||||
- [`healthCheck`](docs/sdks/health/README.md#check) - Healthcheck
|
||||
- [`privateKeysCreate`](docs/sdks/privatekeys/README.md#create) - Create
|
||||
- [`privateKeysDelete`](docs/sdks/privatekeys/README.md#delete) - Delete
|
||||
- [`privateKeysGet`](docs/sdks/privatekeys/README.md#get) - Get
|
||||
- [`privateKeysList`](docs/sdks/privatekeys/README.md#list) - List
|
||||
- [`privateKeysUpdate`](docs/sdks/privatekeys/README.md#update) - Update
|
||||
- [`projectsCreate`](docs/sdks/projects/README.md#create) - Create
|
||||
- [`projectsDelete`](docs/sdks/projects/README.md#delete) - Delete
|
||||
- [`projectsGet`](docs/sdks/projects/README.md#get) - Get
|
||||
- [`projectsGetEnvironment`](docs/sdks/projects/README.md#getenvironment) - Environment
|
||||
- [`projectsList`](docs/sdks/projects/README.md#list) - List
|
||||
- [`projectsUpdate`](docs/sdks/projects/README.md#update) - Update
|
||||
- [`resourcesList`](docs/sdks/resources/README.md#list) - List
|
||||
- [`serversCreate`](docs/sdks/servers/README.md#create) - Create
|
||||
- [`serversDelete`](docs/sdks/servers/README.md#delete) - Delete
|
||||
- [`serversGet`](docs/sdks/servers/README.md#get) - Get
|
||||
- [`serversGetDomains`](docs/sdks/servers/README.md#getdomains) - Domains
|
||||
- [`serversGetResources`](docs/sdks/servers/README.md#getresources) - Resources
|
||||
- [`serversList`](docs/sdks/servers/README.md#list) - List
|
||||
- [`serversUpdate`](docs/sdks/servers/README.md#update) - Update
|
||||
- [`serversValidate`](docs/sdks/servers/README.md#validate) - Validate
|
||||
- [`servicesCreate`](docs/sdks/services/README.md#create) - Create
|
||||
- [`servicesCreateEnv`](docs/sdks/services/README.md#createenv) - Create Env
|
||||
- [`servicesDelete`](docs/sdks/services/README.md#delete) - Delete
|
||||
- [`servicesDeleteEnv`](docs/sdks/services/README.md#deleteenv) - Delete Env
|
||||
- [`servicesGet`](docs/sdks/services/README.md#get) - Get
|
||||
- [`servicesList`](docs/sdks/services/README.md#list) - List
|
||||
- [`servicesListEnvs`](docs/sdks/services/README.md#listenvs) - List Envs
|
||||
- [`servicesRestart`](docs/sdks/services/README.md#restart) - Restart
|
||||
- [`servicesStart`](docs/sdks/services/README.md#start) - Start
|
||||
- [`servicesStop`](docs/sdks/services/README.md#stop) - Stop
|
||||
- [`servicesUpdateEnv`](docs/sdks/services/README.md#updateenv) - Update Env
|
||||
- [`servicesUpdateEnvsBulk`](docs/sdks/services/README.md#updateenvsbulk) - Update Envs (Bulk)
|
||||
- [`teamsGet`](docs/sdks/teams/README.md#get) - Get
|
||||
- [`teamsGetCurrent`](docs/sdks/teams/README.md#getcurrent) - Authenticated Team
|
||||
- [`teamsGetCurrentMembers`](docs/sdks/teams/README.md#getcurrentmembers) - Authenticated Team Members
|
||||
- [`teamsGetMembers`](docs/sdks/teams/README.md#getmembers) - Members
|
||||
- [`teamsList`](docs/sdks/teams/README.md#list) - List
|
||||
- [`versionGet`](docs/sdks/version/README.md#get) - Version
|
||||
|
||||
</details>
|
||||
<!-- End Standalone functions [standalone-funcs] -->
|
||||
|
||||
<!-- Start Retries [retries] -->
|
||||
## Retries
|
||||
|
||||
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
|
||||
|
||||
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
|
||||
```typescript
|
||||
import { Coolify } from "coolify";
|
||||
|
||||
const coolify = new Coolify({
|
||||
bearerAuth: process.env["COOLIFY_BEARER_AUTH"] ?? "",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await coolify.applications.list({
|
||||
retries: {
|
||||
strategy: "backoff",
|
||||
backoff: {
|
||||
initialInterval: 1,
|
||||
maxInterval: 50,
|
||||
exponent: 1.1,
|
||||
maxElapsedTime: 100,
|
||||
},
|
||||
retryConnectionErrors: false,
|
||||
},
|
||||
});
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
|
||||
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
|
||||
```typescript
|
||||
import { Coolify } from "coolify";
|
||||
|
||||
const coolify = new Coolify({
|
||||
retryConfig: {
|
||||
strategy: "backoff",
|
||||
backoff: {
|
||||
initialInterval: 1,
|
||||
maxInterval: 50,
|
||||
exponent: 1.1,
|
||||
maxElapsedTime: 100,
|
||||
},
|
||||
retryConnectionErrors: false,
|
||||
},
|
||||
bearerAuth: process.env["COOLIFY_BEARER_AUTH"] ?? "",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await coolify.applications.list();
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
<!-- End Retries [retries] -->
|
||||
|
||||
<!-- Start Error Handling [errors] -->
|
||||
## Error Handling
|
||||
|
||||
All SDK methods return a response object or throw an error. By default, an API error will throw a `errors.APIError`.
|
||||
|
||||
If a HTTP request fails, an operation my also throw an error from the `models/errors/httpclienterrors.ts` module:
|
||||
|
||||
| HTTP Client Error | Description |
|
||||
| ---------------------------------------------------- | ---------------------------------------------------- |
|
||||
| RequestAbortedError | HTTP request was aborted by the client |
|
||||
| RequestTimeoutError | HTTP request timed out due to an AbortSignal signal |
|
||||
| ConnectionError | HTTP client was unable to make a request to a server |
|
||||
| InvalidRequestError | Any input used to create a request is invalid |
|
||||
| UnexpectedClientError | Unrecognised or unexpected error |
|
||||
|
||||
In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation. For example, the `list` method may throw the following errors:
|
||||
|
||||
| Error Type | Status Code | Content Type |
|
||||
| -------------------------- | --------------------------------- | ---------------- |
|
||||
| errors.BadRequest | 400, 413, 414, 415, 422, 431, 510 | application/json |
|
||||
| errors.Unauthenticated | 401, 403, 407, 511 | application/json |
|
||||
| errors.NotFound | 404, 501, 505 | application/json |
|
||||
| errors.Timeout | 408, 504 | application/json |
|
||||
| errors.RateLimited | 429 | application/json |
|
||||
| errors.InternalServerError | 500, 502, 503, 506, 507, 508 | application/json |
|
||||
| errors.APIError | 4XX, 5XX | \*/\* |
|
||||
|
||||
```typescript
|
||||
import { Coolify } from "coolify";
|
||||
import {
|
||||
BadRequest,
|
||||
InternalServerError,
|
||||
NotFound,
|
||||
RateLimited,
|
||||
SDKValidationError,
|
||||
Timeout,
|
||||
Unauthenticated,
|
||||
} from "coolify/models/errors";
|
||||
|
||||
const coolify = new Coolify({
|
||||
bearerAuth: process.env["COOLIFY_BEARER_AUTH"] ?? "",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
let result;
|
||||
try {
|
||||
result = await coolify.applications.list();
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
} catch (err) {
|
||||
switch (true) {
|
||||
case (err instanceof SDKValidationError): {
|
||||
// Validation errors can be pretty-printed
|
||||
console.error(err.pretty());
|
||||
// Raw value may also be inspected
|
||||
console.error(err.rawValue);
|
||||
return;
|
||||
}
|
||||
case (err instanceof BadRequest): {
|
||||
// Handle err.data$: BadRequestData
|
||||
console.error(err);
|
||||
return;
|
||||
}
|
||||
case (err instanceof Unauthenticated): {
|
||||
// Handle err.data$: UnauthenticatedData
|
||||
console.error(err);
|
||||
return;
|
||||
}
|
||||
case (err instanceof NotFound): {
|
||||
// Handle err.data$: NotFoundData
|
||||
console.error(err);
|
||||
return;
|
||||
}
|
||||
case (err instanceof Timeout): {
|
||||
// Handle err.data$: TimeoutData
|
||||
console.error(err);
|
||||
return;
|
||||
}
|
||||
case (err instanceof RateLimited): {
|
||||
// Handle err.data$: RateLimitedData
|
||||
console.error(err);
|
||||
return;
|
||||
}
|
||||
case (err instanceof InternalServerError): {
|
||||
// Handle err.data$: InternalServerErrorData
|
||||
console.error(err);
|
||||
return;
|
||||
}
|
||||
default: {
|
||||
throw err;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
|
||||
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
|
||||
<!-- End Error Handling [errors] -->
|
||||
|
||||
<!-- Start Server Selection [server] -->
|
||||
## Server Selection
|
||||
|
||||
### Override Server URL Per-Client
|
||||
|
||||
The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
|
||||
```typescript
|
||||
import { Coolify } from "coolify";
|
||||
|
||||
const coolify = new Coolify({
|
||||
serverURL: "https://app.coolify.io/api/v1",
|
||||
bearerAuth: process.env["COOLIFY_BEARER_AUTH"] ?? "",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await coolify.applications.list();
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
<!-- End Server Selection [server] -->
|
||||
|
||||
<!-- Start Custom HTTP Client [http-client] -->
|
||||
## Custom HTTP Client
|
||||
|
||||
The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
|
||||
[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This
|
||||
client is a thin wrapper around `fetch` and provides the ability to attach hooks
|
||||
around the request lifecycle that can be used to modify the request or handle
|
||||
errors and response.
|
||||
|
||||
The `HTTPClient` constructor takes an optional `fetcher` argument that can be
|
||||
used to integrate a third-party HTTP client or when writing tests to mock out
|
||||
the HTTP client and feed in fixtures.
|
||||
|
||||
The following example shows how to use the `"beforeRequest"` hook to to add a
|
||||
custom header and a timeout to requests and how to use the `"requestError"` hook
|
||||
to log errors:
|
||||
|
||||
```typescript
|
||||
import { Coolify } from "coolify";
|
||||
import { HTTPClient } from "coolify/lib/http";
|
||||
|
||||
const httpClient = new HTTPClient({
|
||||
// fetcher takes a function that has the same signature as native `fetch`.
|
||||
fetcher: (request) => {
|
||||
return fetch(request);
|
||||
}
|
||||
});
|
||||
|
||||
httpClient.addHook("beforeRequest", (request) => {
|
||||
const nextRequest = new Request(request, {
|
||||
signal: request.signal || AbortSignal.timeout(5000)
|
||||
});
|
||||
|
||||
nextRequest.headers.set("x-custom-header", "custom value");
|
||||
|
||||
return nextRequest;
|
||||
});
|
||||
|
||||
httpClient.addHook("requestError", (error, request) => {
|
||||
console.group("Request Error");
|
||||
console.log("Reason:", `${error}`);
|
||||
console.log("Endpoint:", `${request.method} ${request.url}`);
|
||||
console.groupEnd();
|
||||
});
|
||||
|
||||
const sdk = new Coolify({ httpClient });
|
||||
```
|
||||
<!-- End Custom HTTP Client [http-client] -->
|
||||
|
||||
<!-- Start Authentication [security] -->
|
||||
## Authentication
|
||||
|
||||
### Per-Client Security Schemes
|
||||
|
||||
This SDK supports the following security scheme globally:
|
||||
|
||||
| Name | Type | Scheme | Environment Variable |
|
||||
| ------------ | ---- | ----------- | --------------------- |
|
||||
| `bearerAuth` | http | HTTP Bearer | `COOLIFY_BEARER_AUTH` |
|
||||
|
||||
To authenticate with the API the `bearerAuth` parameter must be set when initializing the SDK client instance. For example:
|
||||
```typescript
|
||||
import { Coolify } from "coolify";
|
||||
|
||||
const coolify = new Coolify({
|
||||
bearerAuth: process.env["COOLIFY_BEARER_AUTH"] ?? "",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await coolify.applications.list();
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
<!-- End Authentication [security] -->
|
||||
|
||||
<!-- Start Debugging [debug] -->
|
||||
## Debugging
|
||||
|
||||
You can setup your SDK to emit debug logs for SDK requests and responses.
|
||||
|
||||
You can pass a logger that matches `console`'s interface as an SDK option.
|
||||
|
||||
> [!WARNING]
|
||||
> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
|
||||
|
||||
```typescript
|
||||
import { Coolify } from "coolify";
|
||||
|
||||
const sdk = new Coolify({ debugLogger: console });
|
||||
```
|
||||
|
||||
You can also enable a default debug logger by setting an environment variable `COOLIFY_DEBUG` to true.
|
||||
<!-- End Debugging [debug] -->
|
||||
|
||||
<!-- Placeholder for Future Speakeasy SDK Sections -->
|
||||
|
||||
# Development
|
||||
|
||||
## Maturity
|
||||
|
||||
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
|
||||
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
|
||||
looking for the latest version.
|
||||
|
||||
## Contributions
|
||||
|
||||
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.
|
||||
We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
|
||||
|
||||
### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=coolify&utm_campaign=typescript)
|
||||
22
RUNTIMES.md
Normal file
22
RUNTIMES.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# Supported JavaScript runtimes
|
||||
|
||||
This SDK is intended to be used in JavaScript runtimes that support the following features:
|
||||
|
||||
* [Web Fetch API][web-fetch]
|
||||
* [Web Streams API][web-streams] and in particular `ReadableStream`
|
||||
* [Async iterables][async-iter] using `Symbol.asyncIterator`
|
||||
|
||||
[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
|
||||
[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
|
||||
[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
|
||||
|
||||
Runtime environments that are explicitly supported are:
|
||||
|
||||
- Evergreen browsers which include: Chrome, Safari, Edge, Firefox
|
||||
- Node.js active and maintenance LTS releases
|
||||
- Currently, this is v18 and v20
|
||||
- Bun v1 and above
|
||||
- Deno v1.39
|
||||
- Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
|
||||
|
||||
[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
|
||||
19
USAGE.md
Normal file
19
USAGE.md
Normal file
@@ -0,0 +1,19 @@
|
||||
<!-- Start SDK Example Usage [usage] -->
|
||||
```typescript
|
||||
import { Coolify } from "coolify";
|
||||
|
||||
const coolify = new Coolify({
|
||||
bearerAuth: process.env["COOLIFY_BEARER_AUTH"] ?? "",
|
||||
});
|
||||
|
||||
async function run() {
|
||||
const result = await coolify.applications.list();
|
||||
|
||||
// Handle the result
|
||||
console.log(result);
|
||||
}
|
||||
|
||||
run();
|
||||
|
||||
```
|
||||
<!-- End SDK Example Usage [usage] -->
|
||||
24
docs/lib/utils/retryconfig.md
Normal file
24
docs/lib/utils/retryconfig.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# RetryConfig
|
||||
|
||||
Allows customizing the default retry configuration. It is only permitted in methods that accept retry policies.
|
||||
|
||||
## Fields
|
||||
|
||||
| Name | Type | Description | Example |
|
||||
| ------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------ | ----------- |
|
||||
| `strategy` | `"backoff" | "none"` | The retry strategy to use. | `"backoff"` |
|
||||
| `backoff` | [BackoffStrategy](#backoffstrategy) | When strategy is "backoff", this configurates for the backoff parameters. | |
|
||||
| `retryConnectionErrors` | `*boolean*` | When strategy is "backoff", this determines whether or not to retry on connection errors. | `true` |
|
||||
|
||||
## BackoffStrategy
|
||||
|
||||
The backoff strategy allows retrying a request with an exponential backoff between each retry.
|
||||
|
||||
### Fields
|
||||
|
||||
| Name | Type | Description | Example |
|
||||
| ------------------ | ------------ | ----------------------------------------- | -------- |
|
||||
| `initialInterval` | `*number*` | The initial interval in milliseconds. | `500` |
|
||||
| `maxInterval` | `*number*` | The maximum interval in milliseconds. | `60000` |
|
||||
| `exponent` | `*number*` | The exponent to use for the backoff. | `1.5` |
|
||||
| `maxElapsedTime` | `*number*` | The maximum elapsed time in milliseconds. | `300000` |
|
||||
93
docs/models/components/application.md
Normal file
93
docs/models/components/application.md
Normal file
@@ -0,0 +1,93 @@
|
||||
# Application
|
||||
|
||||
Application model
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Application } from "coolify/models/components";
|
||||
|
||||
let value: Application = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | The application identifier in the database. |
|
||||
| `description` | *string* | :heavy_minus_sign: | The application description. |
|
||||
| `repositoryProjectId` | *number* | :heavy_minus_sign: | The repository project identifier. |
|
||||
| `uuid` | *string* | :heavy_minus_sign: | The application UUID. |
|
||||
| `name` | *string* | :heavy_minus_sign: | The application name. |
|
||||
| `fqdn` | *string* | :heavy_minus_sign: | The application domains. |
|
||||
| `configHash` | *string* | :heavy_minus_sign: | Configuration hash. |
|
||||
| `gitRepository` | *string* | :heavy_minus_sign: | Git repository URL. |
|
||||
| `gitBranch` | *string* | :heavy_minus_sign: | Git branch. |
|
||||
| `gitCommitSha` | *string* | :heavy_minus_sign: | Git commit SHA. |
|
||||
| `gitFullUrl` | *string* | :heavy_minus_sign: | Git full URL. |
|
||||
| `dockerRegistryImageName` | *string* | :heavy_minus_sign: | Docker registry image name. |
|
||||
| `dockerRegistryImageTag` | *string* | :heavy_minus_sign: | Docker registry image tag. |
|
||||
| `buildPack` | [components.BuildPack](../../models/components/buildpack.md) | :heavy_minus_sign: | Build pack. |
|
||||
| `staticImage` | *string* | :heavy_minus_sign: | Static image used when static site is deployed. |
|
||||
| `installCommand` | *string* | :heavy_minus_sign: | Install command. |
|
||||
| `buildCommand` | *string* | :heavy_minus_sign: | Build command. |
|
||||
| `startCommand` | *string* | :heavy_minus_sign: | Start command. |
|
||||
| `portsExposes` | *string* | :heavy_minus_sign: | Ports exposes. |
|
||||
| `portsMappings` | *string* | :heavy_minus_sign: | Ports mappings. |
|
||||
| `baseDirectory` | *string* | :heavy_minus_sign: | Base directory for all commands. |
|
||||
| `publishDirectory` | *string* | :heavy_minus_sign: | Publish directory. |
|
||||
| `healthCheckEnabled` | *boolean* | :heavy_minus_sign: | Health check enabled. |
|
||||
| `healthCheckPath` | *string* | :heavy_minus_sign: | Health check path. |
|
||||
| `healthCheckPort` | *string* | :heavy_minus_sign: | Health check port. |
|
||||
| `healthCheckHost` | *string* | :heavy_minus_sign: | Health check host. |
|
||||
| `healthCheckMethod` | *string* | :heavy_minus_sign: | Health check method. |
|
||||
| `healthCheckReturnCode` | *number* | :heavy_minus_sign: | Health check return code. |
|
||||
| `healthCheckScheme` | *string* | :heavy_minus_sign: | Health check scheme. |
|
||||
| `healthCheckResponseText` | *string* | :heavy_minus_sign: | Health check response text. |
|
||||
| `healthCheckInterval` | *number* | :heavy_minus_sign: | Health check interval in seconds. |
|
||||
| `healthCheckTimeout` | *number* | :heavy_minus_sign: | Health check timeout in seconds. |
|
||||
| `healthCheckRetries` | *number* | :heavy_minus_sign: | Health check retries count. |
|
||||
| `healthCheckStartPeriod` | *number* | :heavy_minus_sign: | Health check start period in seconds. |
|
||||
| `limitsMemory` | *string* | :heavy_minus_sign: | Memory limit. |
|
||||
| `limitsMemorySwap` | *string* | :heavy_minus_sign: | Memory swap limit. |
|
||||
| `limitsMemorySwappiness` | *number* | :heavy_minus_sign: | Memory swappiness. |
|
||||
| `limitsMemoryReservation` | *string* | :heavy_minus_sign: | Memory reservation. |
|
||||
| `limitsCpus` | *string* | :heavy_minus_sign: | CPU limit. |
|
||||
| `limitsCpuset` | *string* | :heavy_minus_sign: | CPU set. |
|
||||
| `limitsCpuShares` | *number* | :heavy_minus_sign: | CPU shares. |
|
||||
| `status` | *string* | :heavy_minus_sign: | Application status. |
|
||||
| `previewUrlTemplate` | *string* | :heavy_minus_sign: | Preview URL template. |
|
||||
| `destinationType` | *string* | :heavy_minus_sign: | Destination type. |
|
||||
| `destinationId` | *number* | :heavy_minus_sign: | Destination identifier. |
|
||||
| `sourceId` | *number* | :heavy_minus_sign: | Source identifier. |
|
||||
| `privateKeyId` | *number* | :heavy_minus_sign: | Private key identifier. |
|
||||
| `environmentId` | *number* | :heavy_minus_sign: | Environment identifier. |
|
||||
| `dockerfile` | *string* | :heavy_minus_sign: | Dockerfile content. Used for dockerfile build pack. |
|
||||
| `dockerfileLocation` | *string* | :heavy_minus_sign: | Dockerfile location. |
|
||||
| `customLabels` | *string* | :heavy_minus_sign: | Custom labels. |
|
||||
| `dockerfileTargetBuild` | *string* | :heavy_minus_sign: | Dockerfile target build. |
|
||||
| `manualWebhookSecretGithub` | *string* | :heavy_minus_sign: | Manual webhook secret for GitHub. |
|
||||
| `manualWebhookSecretGitlab` | *string* | :heavy_minus_sign: | Manual webhook secret for GitLab. |
|
||||
| `manualWebhookSecretBitbucket` | *string* | :heavy_minus_sign: | Manual webhook secret for Bitbucket. |
|
||||
| `manualWebhookSecretGitea` | *string* | :heavy_minus_sign: | Manual webhook secret for Gitea. |
|
||||
| `dockerComposeLocation` | *string* | :heavy_minus_sign: | Docker compose location. |
|
||||
| `dockerCompose` | *string* | :heavy_minus_sign: | Docker compose content. Used for docker compose build pack. |
|
||||
| `dockerComposeRaw` | *string* | :heavy_minus_sign: | Docker compose raw content. |
|
||||
| `dockerComposeDomains` | *string* | :heavy_minus_sign: | Docker compose domains. |
|
||||
| `dockerComposeCustomStartCommand` | *string* | :heavy_minus_sign: | Docker compose custom start command. |
|
||||
| `dockerComposeCustomBuildCommand` | *string* | :heavy_minus_sign: | Docker compose custom build command. |
|
||||
| `swarmReplicas` | *number* | :heavy_minus_sign: | Swarm replicas. Only used for swarm deployments. |
|
||||
| `swarmPlacementConstraints` | *string* | :heavy_minus_sign: | Swarm placement constraints. Only used for swarm deployments. |
|
||||
| `customDockerRunOptions` | *string* | :heavy_minus_sign: | Custom docker run options. |
|
||||
| `postDeploymentCommand` | *string* | :heavy_minus_sign: | Post deployment command. |
|
||||
| `postDeploymentCommandContainer` | *string* | :heavy_minus_sign: | Post deployment command container. |
|
||||
| `preDeploymentCommand` | *string* | :heavy_minus_sign: | Pre deployment command. |
|
||||
| `preDeploymentCommandContainer` | *string* | :heavy_minus_sign: | Pre deployment command container. |
|
||||
| `watchPaths` | *string* | :heavy_minus_sign: | Watch paths. |
|
||||
| `customHealthcheckFound` | *boolean* | :heavy_minus_sign: | Custom healthcheck found. |
|
||||
| `redirect` | [components.Redirect](../../models/components/redirect.md) | :heavy_minus_sign: | How to set redirect with Traefik / Caddy. www<->non-www. |
|
||||
| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The date and time when the application was created. |
|
||||
| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The date and time when the application was last updated. |
|
||||
| `deletedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | The date and time when the application was deleted. |
|
||||
| `composeParsingVersion` | *string* | :heavy_minus_sign: | How Coolify parse the compose file. |
|
||||
| `customNginxConfiguration` | *string* | :heavy_minus_sign: | Custom Nginx configuration base64 encoded. |
|
||||
39
docs/models/components/applicationdeploymentqueue.md
Normal file
39
docs/models/components/applicationdeploymentqueue.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# ApplicationDeploymentQueue
|
||||
|
||||
Project model
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ApplicationDeploymentQueue } from "coolify/models/components";
|
||||
|
||||
let value: ApplicationDeploymentQueue = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `applicationId` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `deploymentUuid` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `pullRequestId` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `forceRebuild` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `commit` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `status` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `isWebhook` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `isApi` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `createdAt` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `updatedAt` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `logs` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `currentProcessId` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `restartOnly` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `gitType` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `serverId` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `applicationName` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `serverName` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `deploymentUrl` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `destinationId` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `onlyThisServer` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `rollback` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `commitMessage` | *string* | :heavy_minus_sign: | N/A |
|
||||
17
docs/models/components/buildpack.md
Normal file
17
docs/models/components/buildpack.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# BuildPack
|
||||
|
||||
Build pack.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { BuildPack } from "coolify/models/components";
|
||||
|
||||
let value: BuildPack = "dockerfile";
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
```typescript
|
||||
"nixpacks" | "static" | "dockerfile" | "dockercompose"
|
||||
```
|
||||
22
docs/models/components/environment.md
Normal file
22
docs/models/components/environment.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# Environment
|
||||
|
||||
Environment model
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Environment } from "coolify/models/components";
|
||||
|
||||
let value: Environment = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `name` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `projectId` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `createdAt` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `updatedAt` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `description` | *string* | :heavy_minus_sign: | N/A |
|
||||
33
docs/models/components/environmentvariable.md
Normal file
33
docs/models/components/environmentvariable.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# EnvironmentVariable
|
||||
|
||||
Environment Variable model
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { EnvironmentVariable } from "coolify/models/components";
|
||||
|
||||
let value: EnvironmentVariable = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `uuid` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `applicationId` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `serviceId` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `databaseId` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `isBuildTime` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `isLiteral` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `isMultiline` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `isPreview` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `isShared` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `isShownOnce` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `key` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `value` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `realValue` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `version` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `createdAt` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `updatedAt` | *string* | :heavy_minus_sign: | N/A |
|
||||
25
docs/models/components/privatekey.md
Normal file
25
docs/models/components/privatekey.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# PrivateKey
|
||||
|
||||
Private Key model
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { PrivateKey } from "coolify/models/components";
|
||||
|
||||
let value: PrivateKey = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `uuid` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `name` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `description` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `privateKey` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `isGitRelated` | *boolean* | :heavy_minus_sign: | N/A |
|
||||
| `teamId` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `createdAt` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `updatedAt` | *string* | :heavy_minus_sign: | N/A |
|
||||
21
docs/models/components/project.md
Normal file
21
docs/models/components/project.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# Project
|
||||
|
||||
Project model
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Project } from "coolify/models/components";
|
||||
|
||||
let value: Project = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||
| `id` | *number* | :heavy_minus_sign: | N/A |
|
||||
| `uuid` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `name` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `description` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `environments` | [components.Environment](../../models/components/environment.md)[] | :heavy_minus_sign: | The environments of the project. |
|
||||
16
docs/models/components/proxy.md
Normal file
16
docs/models/components/proxy.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# Proxy
|
||||
|
||||
The proxy configuration.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Proxy } from "coolify/models/components";
|
||||
|
||||
let value: Proxy = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
17
docs/models/components/proxytype.md
Normal file
17
docs/models/components/proxytype.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# ProxyType
|
||||
|
||||
The proxy type.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ProxyType } from "coolify/models/components";
|
||||
|
||||
let value: ProxyType = "caddy";
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
```typescript
|
||||
"traefik" | "caddy" | "none"
|
||||
```
|
||||
17
docs/models/components/redirect.md
Normal file
17
docs/models/components/redirect.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# Redirect
|
||||
|
||||
How to set redirect with Traefik / Caddy. www<->non-www.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Redirect } from "coolify/models/components";
|
||||
|
||||
let value: Redirect = "both";
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
```typescript
|
||||
"www" | "non-www" | "both"
|
||||
```
|
||||
15
docs/models/components/security.md
Normal file
15
docs/models/components/security.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# Security
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Security } from "coolify/models/components";
|
||||
|
||||
let value: Security = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `bearerAuth` | *string* | :heavy_minus_sign: | N/A |
|
||||
33
docs/models/components/server.md
Normal file
33
docs/models/components/server.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# Server
|
||||
|
||||
Server model
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Server } from "coolify/models/components";
|
||||
|
||||
let value: Server = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | The server ID. |
|
||||
| `uuid` | *string* | :heavy_minus_sign: | The server UUID. |
|
||||
| `name` | *string* | :heavy_minus_sign: | The server name. |
|
||||
| `description` | *string* | :heavy_minus_sign: | The server description. |
|
||||
| `ip` | *string* | :heavy_minus_sign: | The IP address. |
|
||||
| `user` | *string* | :heavy_minus_sign: | The user. |
|
||||
| `port` | *number* | :heavy_minus_sign: | The port number. |
|
||||
| `proxy` | [components.Proxy](../../models/components/proxy.md) | :heavy_minus_sign: | The proxy configuration. |
|
||||
| `proxyType` | [components.ProxyType](../../models/components/proxytype.md) | :heavy_minus_sign: | The proxy type. |
|
||||
| `highDiskUsageNotificationSent` | *boolean* | :heavy_minus_sign: | The flag to indicate if the high disk usage notification has been sent. |
|
||||
| `unreachableNotificationSent` | *boolean* | :heavy_minus_sign: | The flag to indicate if the unreachable notification has been sent. |
|
||||
| `unreachableCount` | *number* | :heavy_minus_sign: | The unreachable count for your server. |
|
||||
| `validationLogs` | *string* | :heavy_minus_sign: | The validation logs. |
|
||||
| `logDrainNotificationSent` | *boolean* | :heavy_minus_sign: | The flag to indicate if the log drain notification has been sent. |
|
||||
| `swarmCluster` | *string* | :heavy_minus_sign: | The swarm cluster configuration. |
|
||||
| `deleteUnusedVolumes` | *boolean* | :heavy_minus_sign: | The flag to indicate if the unused volumes should be deleted. |
|
||||
| `deleteUnusedNetworks` | *boolean* | :heavy_minus_sign: | The flag to indicate if the unused networks should be deleted. |
|
||||
34
docs/models/components/service.md
Normal file
34
docs/models/components/service.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# Service
|
||||
|
||||
Service model
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Service } from "coolify/models/components";
|
||||
|
||||
let value: Service = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | The unique identifier of the service. Only used for database identification. |
|
||||
| `uuid` | *string* | :heavy_minus_sign: | The unique identifier of the service. |
|
||||
| `name` | *string* | :heavy_minus_sign: | The name of the service. |
|
||||
| `environmentId` | *number* | :heavy_minus_sign: | The unique identifier of the environment where the service is attached to. |
|
||||
| `serverId` | *number* | :heavy_minus_sign: | The unique identifier of the server where the service is running. |
|
||||
| `description` | *string* | :heavy_minus_sign: | The description of the service. |
|
||||
| `dockerComposeRaw` | *string* | :heavy_minus_sign: | The raw docker-compose.yml file of the service. |
|
||||
| `dockerCompose` | *string* | :heavy_minus_sign: | The docker-compose.yml file that is parsed and modified by Coolify. |
|
||||
| `destinationType` | *string* | :heavy_minus_sign: | Destination type. |
|
||||
| `destinationId` | *number* | :heavy_minus_sign: | The unique identifier of the destination where the service is running. |
|
||||
| `connectToDockerNetwork` | *boolean* | :heavy_minus_sign: | The flag to connect the service to the predefined Docker network. |
|
||||
| `isContainerLabelEscapeEnabled` | *boolean* | :heavy_minus_sign: | The flag to enable the container label escape. |
|
||||
| `isContainerLabelReadonlyEnabled` | *boolean* | :heavy_minus_sign: | The flag to enable the container label readonly. |
|
||||
| `configHash` | *string* | :heavy_minus_sign: | The hash of the service configuration. |
|
||||
| `serviceType` | *string* | :heavy_minus_sign: | The type of the service. |
|
||||
| `createdAt` | *string* | :heavy_minus_sign: | The date and time when the service was created. |
|
||||
| `updatedAt` | *string* | :heavy_minus_sign: | The date and time when the service was last updated. |
|
||||
| `deletedAt` | *string* | :heavy_minus_sign: | The date and time when the service was deleted. |
|
||||
65
docs/models/components/team.md
Normal file
65
docs/models/components/team.md
Normal file
@@ -0,0 +1,65 @@
|
||||
# Team
|
||||
|
||||
Team model
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Team } from "coolify/models/components";
|
||||
|
||||
let value: Team = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||
| `id` | *number* | :heavy_minus_sign: | The unique identifier of the team. |
|
||||
| `name` | *string* | :heavy_minus_sign: | The name of the team. |
|
||||
| `description` | *string* | :heavy_minus_sign: | The description of the team. |
|
||||
| `personalTeam` | *boolean* | :heavy_minus_sign: | Whether the team is personal or not. |
|
||||
| `createdAt` | *string* | :heavy_minus_sign: | The date and time the team was created. |
|
||||
| `updatedAt` | *string* | :heavy_minus_sign: | The date and time the team was last updated. |
|
||||
| `smtpEnabled` | *boolean* | :heavy_minus_sign: | Whether SMTP is enabled or not. |
|
||||
| `smtpFromAddress` | *string* | :heavy_minus_sign: | The email address to send emails from. |
|
||||
| `smtpFromName` | *string* | :heavy_minus_sign: | The name to send emails from. |
|
||||
| `smtpRecipients` | *string* | :heavy_minus_sign: | The email addresses to send emails to. |
|
||||
| `smtpHost` | *string* | :heavy_minus_sign: | The SMTP host. |
|
||||
| `smtpPort` | *string* | :heavy_minus_sign: | The SMTP port. |
|
||||
| `smtpEncryption` | *string* | :heavy_minus_sign: | The SMTP encryption. |
|
||||
| `smtpUsername` | *string* | :heavy_minus_sign: | The SMTP username. |
|
||||
| `smtpPassword` | *string* | :heavy_minus_sign: | The SMTP password. |
|
||||
| `smtpTimeout` | *string* | :heavy_minus_sign: | The SMTP timeout. |
|
||||
| `smtpNotificationsTest` | *boolean* | :heavy_minus_sign: | Whether to send test notifications via SMTP. |
|
||||
| `smtpNotificationsDeployments` | *boolean* | :heavy_minus_sign: | Whether to send deployment notifications via SMTP. |
|
||||
| `smtpNotificationsStatusChanges` | *boolean* | :heavy_minus_sign: | Whether to send status change notifications via SMTP. |
|
||||
| `smtpNotificationsScheduledTasks` | *boolean* | :heavy_minus_sign: | Whether to send scheduled task notifications via SMTP. |
|
||||
| `smtpNotificationsDatabaseBackups` | *boolean* | :heavy_minus_sign: | Whether to send database backup notifications via SMTP. |
|
||||
| `smtpNotificationsServerDiskUsage` | *boolean* | :heavy_minus_sign: | Whether to send server disk usage notifications via SMTP. |
|
||||
| `discordEnabled` | *boolean* | :heavy_minus_sign: | Whether Discord is enabled or not. |
|
||||
| `discordWebhookUrl` | *string* | :heavy_minus_sign: | The Discord webhook URL. |
|
||||
| `discordNotificationsTest` | *boolean* | :heavy_minus_sign: | Whether to send test notifications via Discord. |
|
||||
| `discordNotificationsDeployments` | *boolean* | :heavy_minus_sign: | Whether to send deployment notifications via Discord. |
|
||||
| `discordNotificationsStatusChanges` | *boolean* | :heavy_minus_sign: | Whether to send status change notifications via Discord. |
|
||||
| `discordNotificationsDatabaseBackups` | *boolean* | :heavy_minus_sign: | Whether to send database backup notifications via Discord. |
|
||||
| `discordNotificationsScheduledTasks` | *boolean* | :heavy_minus_sign: | Whether to send scheduled task notifications via Discord. |
|
||||
| `discordNotificationsServerDiskUsage` | *boolean* | :heavy_minus_sign: | Whether to send server disk usage notifications via Discord. |
|
||||
| `showBoarding` | *boolean* | :heavy_minus_sign: | Whether to show the boarding screen or not. |
|
||||
| `resendEnabled` | *boolean* | :heavy_minus_sign: | Whether to enable resending or not. |
|
||||
| `resendApiKey` | *string* | :heavy_minus_sign: | The resending API key. |
|
||||
| `useInstanceEmailSettings` | *boolean* | :heavy_minus_sign: | Whether to use instance email settings or not. |
|
||||
| `telegramEnabled` | *boolean* | :heavy_minus_sign: | Whether Telegram is enabled or not. |
|
||||
| `telegramToken` | *string* | :heavy_minus_sign: | The Telegram token. |
|
||||
| `telegramChatId` | *string* | :heavy_minus_sign: | The Telegram chat ID. |
|
||||
| `telegramNotificationsTest` | *boolean* | :heavy_minus_sign: | Whether to send test notifications via Telegram. |
|
||||
| `telegramNotificationsDeployments` | *boolean* | :heavy_minus_sign: | Whether to send deployment notifications via Telegram. |
|
||||
| `telegramNotificationsStatusChanges` | *boolean* | :heavy_minus_sign: | Whether to send status change notifications via Telegram. |
|
||||
| `telegramNotificationsDatabaseBackups` | *boolean* | :heavy_minus_sign: | Whether to send database backup notifications via Telegram. |
|
||||
| `telegramNotificationsTestMessageThreadId` | *string* | :heavy_minus_sign: | The Telegram test message thread ID. |
|
||||
| `telegramNotificationsDeploymentsMessageThreadId` | *string* | :heavy_minus_sign: | The Telegram deployment message thread ID. |
|
||||
| `telegramNotificationsStatusChangesMessageThreadId` | *string* | :heavy_minus_sign: | The Telegram status change message thread ID. |
|
||||
| `telegramNotificationsDatabaseBackupsMessageThreadId` | *string* | :heavy_minus_sign: | The Telegram database backup message thread ID. |
|
||||
| `customServerLimit` | *string* | :heavy_minus_sign: | The custom server limit. |
|
||||
| `telegramNotificationsScheduledTasks` | *boolean* | :heavy_minus_sign: | Whether to send scheduled task notifications via Telegram. |
|
||||
| `telegramNotificationsScheduledTasksThreadId` | *string* | :heavy_minus_sign: | The Telegram scheduled task message thread ID. |
|
||||
| `members` | [components.User](../../models/components/user.md)[] | :heavy_minus_sign: | The members of the team. |
|
||||
25
docs/models/components/user.md
Normal file
25
docs/models/components/user.md
Normal file
@@ -0,0 +1,25 @@
|
||||
# User
|
||||
|
||||
User model
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { User } from "coolify/models/components";
|
||||
|
||||
let value: User = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- |
|
||||
| `id` | *number* | :heavy_minus_sign: | The user identifier in the database. |
|
||||
| `name` | *string* | :heavy_minus_sign: | The user name. |
|
||||
| `email` | *string* | :heavy_minus_sign: | The user email. |
|
||||
| `emailVerifiedAt` | *string* | :heavy_minus_sign: | The date when the user email was verified. |
|
||||
| `createdAt` | *string* | :heavy_minus_sign: | The date when the user was created. |
|
||||
| `updatedAt` | *string* | :heavy_minus_sign: | The date when the user was updated. |
|
||||
| `twoFactorConfirmedAt` | *string* | :heavy_minus_sign: | The date when the user two factor was confirmed. |
|
||||
| `forcePasswordReset` | *boolean* | :heavy_minus_sign: | The flag to force the user to reset the password. |
|
||||
| `marketingEmails` | *boolean* | :heavy_minus_sign: | The flag to receive marketing emails. |
|
||||
17
docs/models/errors/badrequest.md
Normal file
17
docs/models/errors/badrequest.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# BadRequest
|
||||
|
||||
Invalid token.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { BadRequest } from "coolify/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | Invalid token. |
|
||||
17
docs/models/errors/disableapiresponsebody.md
Normal file
17
docs/models/errors/disableapiresponsebody.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# DisableApiResponseBody
|
||||
|
||||
You are not allowed to disable the API.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DisableApiResponseBody } from "coolify/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | You are not allowed to disable the API. |
|
||||
17
docs/models/errors/enableapiresponsebody.md
Normal file
17
docs/models/errors/enableapiresponsebody.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# EnableApiResponseBody
|
||||
|
||||
You are not allowed to enable the API.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { EnableApiResponseBody } from "coolify/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | You are not allowed to enable the API. |
|
||||
18
docs/models/errors/internalservererror.md
Normal file
18
docs/models/errors/internalservererror.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# InternalServerError
|
||||
|
||||
A collection of status codes that generally mean the server failed in an unexpected way
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { InternalServerError } from "coolify/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `additionalProperties` | Record<string, *any*> | :heavy_minus_sign: | N/A |
|
||||
17
docs/models/errors/notfound.md
Normal file
17
docs/models/errors/notfound.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# NotFound
|
||||
|
||||
Resource not found.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { NotFound } from "coolify/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | Resource not found. |
|
||||
18
docs/models/errors/ratelimited.md
Normal file
18
docs/models/errors/ratelimited.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# RateLimited
|
||||
|
||||
Status codes relating to the client being rate limited by the server
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { RateLimited } from "coolify/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `additionalProperties` | Record<string, *any*> | :heavy_minus_sign: | N/A |
|
||||
18
docs/models/errors/timeout.md
Normal file
18
docs/models/errors/timeout.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Timeout
|
||||
|
||||
Timeouts occurred with the request
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Timeout } from "coolify/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `additionalProperties` | Record<string, *any*> | :heavy_minus_sign: | N/A |
|
||||
17
docs/models/errors/unauthenticated.md
Normal file
17
docs/models/errors/unauthenticated.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# Unauthenticated
|
||||
|
||||
Unauthenticated.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Unauthenticated } from "coolify/models/errors";
|
||||
|
||||
// No examples available for this model
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | Unauthenticated. |
|
||||
17
docs/models/operations/buildpack.md
Normal file
17
docs/models/operations/buildpack.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# BuildPack
|
||||
|
||||
The build pack type.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { BuildPack } from "coolify/models/operations";
|
||||
|
||||
let value: BuildPack = "dockerfile";
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
```typescript
|
||||
"nixpacks" | "static" | "dockerfile" | "dockercompose"
|
||||
```
|
||||
@@ -0,0 +1,39 @@
|
||||
# CreateDatabaseClickhouseRequestBody
|
||||
|
||||
Database data
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateDatabaseClickhouseRequestBody } from "coolify/models/operations";
|
||||
|
||||
let value: CreateDatabaseClickhouseRequestBody = {
|
||||
serverUuid: "<id>",
|
||||
projectUuid: "<id>",
|
||||
environmentName: "<value>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `serverUuid` | *string* | :heavy_check_mark: | UUID of the server |
|
||||
| `projectUuid` | *string* | :heavy_check_mark: | UUID of the project |
|
||||
| `environmentName` | *string* | :heavy_check_mark: | Name of the environment |
|
||||
| `destinationUuid` | *string* | :heavy_minus_sign: | UUID of the destination if the server has multiple destinations |
|
||||
| `clickhouseAdminUser` | *string* | :heavy_minus_sign: | Clickhouse admin user |
|
||||
| `clickhouseAdminPassword` | *string* | :heavy_minus_sign: | Clickhouse admin password |
|
||||
| `name` | *string* | :heavy_minus_sign: | Name of the database |
|
||||
| `description` | *string* | :heavy_minus_sign: | Description of the database |
|
||||
| `image` | *string* | :heavy_minus_sign: | Docker Image of the database |
|
||||
| `isPublic` | *boolean* | :heavy_minus_sign: | Is the database public? |
|
||||
| `publicPort` | *number* | :heavy_minus_sign: | Public port of the database |
|
||||
| `limitsMemory` | *string* | :heavy_minus_sign: | Memory limit of the database |
|
||||
| `limitsMemorySwap` | *string* | :heavy_minus_sign: | Memory swap limit of the database |
|
||||
| `limitsMemorySwappiness` | *number* | :heavy_minus_sign: | Memory swappiness of the database |
|
||||
| `limitsMemoryReservation` | *string* | :heavy_minus_sign: | Memory reservation of the database |
|
||||
| `limitsCpus` | *string* | :heavy_minus_sign: | CPU limit of the database |
|
||||
| `limitsCpuset` | *string* | :heavy_minus_sign: | CPU set of the database |
|
||||
| `limitsCpuShares` | *number* | :heavy_minus_sign: | CPU shares of the database |
|
||||
| `instantDeploy` | *boolean* | :heavy_minus_sign: | Instant deploy the database |
|
||||
38
docs/models/operations/createdatabasedragonflyrequestbody.md
Normal file
38
docs/models/operations/createdatabasedragonflyrequestbody.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# CreateDatabaseDragonflyRequestBody
|
||||
|
||||
Database data
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateDatabaseDragonflyRequestBody } from "coolify/models/operations";
|
||||
|
||||
let value: CreateDatabaseDragonflyRequestBody = {
|
||||
serverUuid: "<id>",
|
||||
projectUuid: "<id>",
|
||||
environmentName: "<value>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `serverUuid` | *string* | :heavy_check_mark: | UUID of the server |
|
||||
| `projectUuid` | *string* | :heavy_check_mark: | UUID of the project |
|
||||
| `environmentName` | *string* | :heavy_check_mark: | Name of the environment |
|
||||
| `destinationUuid` | *string* | :heavy_minus_sign: | UUID of the destination if the server has multiple destinations |
|
||||
| `dragonflyPassword` | *string* | :heavy_minus_sign: | DragonFly password |
|
||||
| `name` | *string* | :heavy_minus_sign: | Name of the database |
|
||||
| `description` | *string* | :heavy_minus_sign: | Description of the database |
|
||||
| `image` | *string* | :heavy_minus_sign: | Docker Image of the database |
|
||||
| `isPublic` | *boolean* | :heavy_minus_sign: | Is the database public? |
|
||||
| `publicPort` | *number* | :heavy_minus_sign: | Public port of the database |
|
||||
| `limitsMemory` | *string* | :heavy_minus_sign: | Memory limit of the database |
|
||||
| `limitsMemorySwap` | *string* | :heavy_minus_sign: | Memory swap limit of the database |
|
||||
| `limitsMemorySwappiness` | *number* | :heavy_minus_sign: | Memory swappiness of the database |
|
||||
| `limitsMemoryReservation` | *string* | :heavy_minus_sign: | Memory reservation of the database |
|
||||
| `limitsCpus` | *string* | :heavy_minus_sign: | CPU limit of the database |
|
||||
| `limitsCpuset` | *string* | :heavy_minus_sign: | CPU set of the database |
|
||||
| `limitsCpuShares` | *number* | :heavy_minus_sign: | CPU shares of the database |
|
||||
| `instantDeploy` | *boolean* | :heavy_minus_sign: | Instant deploy the database |
|
||||
39
docs/models/operations/createdatabasekeydbrequestbody.md
Normal file
39
docs/models/operations/createdatabasekeydbrequestbody.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# CreateDatabaseKeydbRequestBody
|
||||
|
||||
Database data
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateDatabaseKeydbRequestBody } from "coolify/models/operations";
|
||||
|
||||
let value: CreateDatabaseKeydbRequestBody = {
|
||||
serverUuid: "<id>",
|
||||
projectUuid: "<id>",
|
||||
environmentName: "<value>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `serverUuid` | *string* | :heavy_check_mark: | UUID of the server |
|
||||
| `projectUuid` | *string* | :heavy_check_mark: | UUID of the project |
|
||||
| `environmentName` | *string* | :heavy_check_mark: | Name of the environment |
|
||||
| `destinationUuid` | *string* | :heavy_minus_sign: | UUID of the destination if the server has multiple destinations |
|
||||
| `keydbPassword` | *string* | :heavy_minus_sign: | KeyDB password |
|
||||
| `keydbConf` | *string* | :heavy_minus_sign: | KeyDB conf |
|
||||
| `name` | *string* | :heavy_minus_sign: | Name of the database |
|
||||
| `description` | *string* | :heavy_minus_sign: | Description of the database |
|
||||
| `image` | *string* | :heavy_minus_sign: | Docker Image of the database |
|
||||
| `isPublic` | *boolean* | :heavy_minus_sign: | Is the database public? |
|
||||
| `publicPort` | *number* | :heavy_minus_sign: | Public port of the database |
|
||||
| `limitsMemory` | *string* | :heavy_minus_sign: | Memory limit of the database |
|
||||
| `limitsMemorySwap` | *string* | :heavy_minus_sign: | Memory swap limit of the database |
|
||||
| `limitsMemorySwappiness` | *number* | :heavy_minus_sign: | Memory swappiness of the database |
|
||||
| `limitsMemoryReservation` | *string* | :heavy_minus_sign: | Memory reservation of the database |
|
||||
| `limitsCpus` | *string* | :heavy_minus_sign: | CPU limit of the database |
|
||||
| `limitsCpuset` | *string* | :heavy_minus_sign: | CPU set of the database |
|
||||
| `limitsCpuShares` | *number* | :heavy_minus_sign: | CPU shares of the database |
|
||||
| `instantDeploy` | *boolean* | :heavy_minus_sign: | Instant deploy the database |
|
||||
42
docs/models/operations/createdatabasemariadbrequestbody.md
Normal file
42
docs/models/operations/createdatabasemariadbrequestbody.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# CreateDatabaseMariadbRequestBody
|
||||
|
||||
Database data
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateDatabaseMariadbRequestBody } from "coolify/models/operations";
|
||||
|
||||
let value: CreateDatabaseMariadbRequestBody = {
|
||||
serverUuid: "<id>",
|
||||
projectUuid: "<id>",
|
||||
environmentName: "<value>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `serverUuid` | *string* | :heavy_check_mark: | UUID of the server |
|
||||
| `projectUuid` | *string* | :heavy_check_mark: | UUID of the project |
|
||||
| `environmentName` | *string* | :heavy_check_mark: | Name of the environment |
|
||||
| `destinationUuid` | *string* | :heavy_minus_sign: | UUID of the destination if the server has multiple destinations |
|
||||
| `mariadbConf` | *string* | :heavy_minus_sign: | MariaDB conf |
|
||||
| `mariadbRootPassword` | *string* | :heavy_minus_sign: | MariaDB root password |
|
||||
| `mariadbUser` | *string* | :heavy_minus_sign: | MariaDB user |
|
||||
| `mariadbPassword` | *string* | :heavy_minus_sign: | MariaDB password |
|
||||
| `mariadbDatabase` | *string* | :heavy_minus_sign: | MariaDB database |
|
||||
| `name` | *string* | :heavy_minus_sign: | Name of the database |
|
||||
| `description` | *string* | :heavy_minus_sign: | Description of the database |
|
||||
| `image` | *string* | :heavy_minus_sign: | Docker Image of the database |
|
||||
| `isPublic` | *boolean* | :heavy_minus_sign: | Is the database public? |
|
||||
| `publicPort` | *number* | :heavy_minus_sign: | Public port of the database |
|
||||
| `limitsMemory` | *string* | :heavy_minus_sign: | Memory limit of the database |
|
||||
| `limitsMemorySwap` | *string* | :heavy_minus_sign: | Memory swap limit of the database |
|
||||
| `limitsMemorySwappiness` | *number* | :heavy_minus_sign: | Memory swappiness of the database |
|
||||
| `limitsMemoryReservation` | *string* | :heavy_minus_sign: | Memory reservation of the database |
|
||||
| `limitsCpus` | *string* | :heavy_minus_sign: | CPU limit of the database |
|
||||
| `limitsCpuset` | *string* | :heavy_minus_sign: | CPU set of the database |
|
||||
| `limitsCpuShares` | *number* | :heavy_minus_sign: | CPU shares of the database |
|
||||
| `instantDeploy` | *boolean* | :heavy_minus_sign: | Instant deploy the database |
|
||||
39
docs/models/operations/createdatabasemongodbrequestbody.md
Normal file
39
docs/models/operations/createdatabasemongodbrequestbody.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# CreateDatabaseMongodbRequestBody
|
||||
|
||||
Database data
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateDatabaseMongodbRequestBody } from "coolify/models/operations";
|
||||
|
||||
let value: CreateDatabaseMongodbRequestBody = {
|
||||
serverUuid: "<id>",
|
||||
projectUuid: "<id>",
|
||||
environmentName: "<value>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `serverUuid` | *string* | :heavy_check_mark: | UUID of the server |
|
||||
| `projectUuid` | *string* | :heavy_check_mark: | UUID of the project |
|
||||
| `environmentName` | *string* | :heavy_check_mark: | Name of the environment |
|
||||
| `destinationUuid` | *string* | :heavy_minus_sign: | UUID of the destination if the server has multiple destinations |
|
||||
| `mongoConf` | *string* | :heavy_minus_sign: | MongoDB conf |
|
||||
| `mongoInitdbRootUsername` | *string* | :heavy_minus_sign: | MongoDB initdb root username |
|
||||
| `name` | *string* | :heavy_minus_sign: | Name of the database |
|
||||
| `description` | *string* | :heavy_minus_sign: | Description of the database |
|
||||
| `image` | *string* | :heavy_minus_sign: | Docker Image of the database |
|
||||
| `isPublic` | *boolean* | :heavy_minus_sign: | Is the database public? |
|
||||
| `publicPort` | *number* | :heavy_minus_sign: | Public port of the database |
|
||||
| `limitsMemory` | *string* | :heavy_minus_sign: | Memory limit of the database |
|
||||
| `limitsMemorySwap` | *string* | :heavy_minus_sign: | Memory swap limit of the database |
|
||||
| `limitsMemorySwappiness` | *number* | :heavy_minus_sign: | Memory swappiness of the database |
|
||||
| `limitsMemoryReservation` | *string* | :heavy_minus_sign: | Memory reservation of the database |
|
||||
| `limitsCpus` | *string* | :heavy_minus_sign: | CPU limit of the database |
|
||||
| `limitsCpuset` | *string* | :heavy_minus_sign: | CPU set of the database |
|
||||
| `limitsCpuShares` | *number* | :heavy_minus_sign: | CPU shares of the database |
|
||||
| `instantDeploy` | *boolean* | :heavy_minus_sign: | Instant deploy the database |
|
||||
41
docs/models/operations/createdatabasemysqlrequestbody.md
Normal file
41
docs/models/operations/createdatabasemysqlrequestbody.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# CreateDatabaseMysqlRequestBody
|
||||
|
||||
Database data
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateDatabaseMysqlRequestBody } from "coolify/models/operations";
|
||||
|
||||
let value: CreateDatabaseMysqlRequestBody = {
|
||||
serverUuid: "<id>",
|
||||
projectUuid: "<id>",
|
||||
environmentName: "<value>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `serverUuid` | *string* | :heavy_check_mark: | UUID of the server |
|
||||
| `projectUuid` | *string* | :heavy_check_mark: | UUID of the project |
|
||||
| `environmentName` | *string* | :heavy_check_mark: | Name of the environment |
|
||||
| `destinationUuid` | *string* | :heavy_minus_sign: | UUID of the destination if the server has multiple destinations |
|
||||
| `mysqlRootPassword` | *string* | :heavy_minus_sign: | MySQL root password |
|
||||
| `mysqlUser` | *string* | :heavy_minus_sign: | MySQL user |
|
||||
| `mysqlDatabase` | *string* | :heavy_minus_sign: | MySQL database |
|
||||
| `mysqlConf` | *string* | :heavy_minus_sign: | MySQL conf |
|
||||
| `name` | *string* | :heavy_minus_sign: | Name of the database |
|
||||
| `description` | *string* | :heavy_minus_sign: | Description of the database |
|
||||
| `image` | *string* | :heavy_minus_sign: | Docker Image of the database |
|
||||
| `isPublic` | *boolean* | :heavy_minus_sign: | Is the database public? |
|
||||
| `publicPort` | *number* | :heavy_minus_sign: | Public port of the database |
|
||||
| `limitsMemory` | *string* | :heavy_minus_sign: | Memory limit of the database |
|
||||
| `limitsMemorySwap` | *string* | :heavy_minus_sign: | Memory swap limit of the database |
|
||||
| `limitsMemorySwappiness` | *number* | :heavy_minus_sign: | Memory swappiness of the database |
|
||||
| `limitsMemoryReservation` | *string* | :heavy_minus_sign: | Memory reservation of the database |
|
||||
| `limitsCpus` | *string* | :heavy_minus_sign: | CPU limit of the database |
|
||||
| `limitsCpuset` | *string* | :heavy_minus_sign: | CPU set of the database |
|
||||
| `limitsCpuShares` | *number* | :heavy_minus_sign: | CPU shares of the database |
|
||||
| `instantDeploy` | *boolean* | :heavy_minus_sign: | Instant deploy the database |
|
||||
@@ -0,0 +1,43 @@
|
||||
# CreateDatabasePostgresqlRequestBody
|
||||
|
||||
Database data
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateDatabasePostgresqlRequestBody } from "coolify/models/operations";
|
||||
|
||||
let value: CreateDatabasePostgresqlRequestBody = {
|
||||
serverUuid: "<id>",
|
||||
projectUuid: "<id>",
|
||||
environmentName: "<value>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `serverUuid` | *string* | :heavy_check_mark: | UUID of the server |
|
||||
| `projectUuid` | *string* | :heavy_check_mark: | UUID of the project |
|
||||
| `environmentName` | *string* | :heavy_check_mark: | Name of the environment |
|
||||
| `postgresUser` | *string* | :heavy_minus_sign: | PostgreSQL user |
|
||||
| `postgresPassword` | *string* | :heavy_minus_sign: | PostgreSQL password |
|
||||
| `postgresDb` | *string* | :heavy_minus_sign: | PostgreSQL database |
|
||||
| `postgresInitdbArgs` | *string* | :heavy_minus_sign: | PostgreSQL initdb args |
|
||||
| `postgresHostAuthMethod` | *string* | :heavy_minus_sign: | PostgreSQL host auth method |
|
||||
| `postgresConf` | *string* | :heavy_minus_sign: | PostgreSQL conf |
|
||||
| `destinationUuid` | *string* | :heavy_minus_sign: | UUID of the destination if the server has multiple destinations |
|
||||
| `name` | *string* | :heavy_minus_sign: | Name of the database |
|
||||
| `description` | *string* | :heavy_minus_sign: | Description of the database |
|
||||
| `image` | *string* | :heavy_minus_sign: | Docker Image of the database |
|
||||
| `isPublic` | *boolean* | :heavy_minus_sign: | Is the database public? |
|
||||
| `publicPort` | *number* | :heavy_minus_sign: | Public port of the database |
|
||||
| `limitsMemory` | *string* | :heavy_minus_sign: | Memory limit of the database |
|
||||
| `limitsMemorySwap` | *string* | :heavy_minus_sign: | Memory swap limit of the database |
|
||||
| `limitsMemorySwappiness` | *number* | :heavy_minus_sign: | Memory swappiness of the database |
|
||||
| `limitsMemoryReservation` | *string* | :heavy_minus_sign: | Memory reservation of the database |
|
||||
| `limitsCpus` | *string* | :heavy_minus_sign: | CPU limit of the database |
|
||||
| `limitsCpuset` | *string* | :heavy_minus_sign: | CPU set of the database |
|
||||
| `limitsCpuShares` | *number* | :heavy_minus_sign: | CPU shares of the database |
|
||||
| `instantDeploy` | *boolean* | :heavy_minus_sign: | Instant deploy the database |
|
||||
39
docs/models/operations/createdatabaseredisrequestbody.md
Normal file
39
docs/models/operations/createdatabaseredisrequestbody.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# CreateDatabaseRedisRequestBody
|
||||
|
||||
Database data
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateDatabaseRedisRequestBody } from "coolify/models/operations";
|
||||
|
||||
let value: CreateDatabaseRedisRequestBody = {
|
||||
serverUuid: "<id>",
|
||||
projectUuid: "<id>",
|
||||
environmentName: "<value>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `serverUuid` | *string* | :heavy_check_mark: | UUID of the server |
|
||||
| `projectUuid` | *string* | :heavy_check_mark: | UUID of the project |
|
||||
| `environmentName` | *string* | :heavy_check_mark: | Name of the environment |
|
||||
| `destinationUuid` | *string* | :heavy_minus_sign: | UUID of the destination if the server has multiple destinations |
|
||||
| `redisPassword` | *string* | :heavy_minus_sign: | Redis password |
|
||||
| `redisConf` | *string* | :heavy_minus_sign: | Redis conf |
|
||||
| `name` | *string* | :heavy_minus_sign: | Name of the database |
|
||||
| `description` | *string* | :heavy_minus_sign: | Description of the database |
|
||||
| `image` | *string* | :heavy_minus_sign: | Docker Image of the database |
|
||||
| `isPublic` | *boolean* | :heavy_minus_sign: | Is the database public? |
|
||||
| `publicPort` | *number* | :heavy_minus_sign: | Public port of the database |
|
||||
| `limitsMemory` | *string* | :heavy_minus_sign: | Memory limit of the database |
|
||||
| `limitsMemorySwap` | *string* | :heavy_minus_sign: | Memory swap limit of the database |
|
||||
| `limitsMemorySwappiness` | *number* | :heavy_minus_sign: | Memory swappiness of the database |
|
||||
| `limitsMemoryReservation` | *string* | :heavy_minus_sign: | Memory reservation of the database |
|
||||
| `limitsCpus` | *string* | :heavy_minus_sign: | CPU limit of the database |
|
||||
| `limitsCpuset` | *string* | :heavy_minus_sign: | CPU set of the database |
|
||||
| `limitsCpuShares` | *number* | :heavy_minus_sign: | CPU shares of the database |
|
||||
| `instantDeploy` | *boolean* | :heavy_minus_sign: | Instant deploy the database |
|
||||
@@ -0,0 +1,30 @@
|
||||
# CreateDockercomposeApplicationRequestBody
|
||||
|
||||
Application object that needs to be created.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateDockercomposeApplicationRequestBody } from "coolify/models/operations";
|
||||
|
||||
let value: CreateDockercomposeApplicationRequestBody = {
|
||||
projectUuid: "<id>",
|
||||
serverUuid: "<id>",
|
||||
environmentName: "<value>",
|
||||
dockerComposeRaw: "<value>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `projectUuid` | *string* | :heavy_check_mark: | The project UUID. |
|
||||
| `serverUuid` | *string* | :heavy_check_mark: | The server UUID. |
|
||||
| `environmentName` | *string* | :heavy_check_mark: | The environment name. |
|
||||
| `dockerComposeRaw` | *string* | :heavy_check_mark: | The Docker Compose raw content. |
|
||||
| `destinationUuid` | *string* | :heavy_minus_sign: | The destination UUID if the server has more than one destinations. |
|
||||
| `name` | *string* | :heavy_minus_sign: | The application name. |
|
||||
| `description` | *string* | :heavy_minus_sign: | The application description. |
|
||||
| `instantDeploy` | *boolean* | :heavy_minus_sign: | The flag to indicate if the application should be deployed instantly. |
|
||||
| `useBuildServer` | *boolean* | :heavy_minus_sign: | Use build server. |
|
||||
@@ -0,0 +1,17 @@
|
||||
# CreateDockerfileApplicationBuildPack
|
||||
|
||||
The build pack type.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateDockerfileApplicationBuildPack } from "coolify/models/operations";
|
||||
|
||||
let value: CreateDockerfileApplicationBuildPack = "dockerfile";
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
```typescript
|
||||
"nixpacks" | "static" | "dockerfile" | "dockercompose"
|
||||
```
|
||||
@@ -0,0 +1,17 @@
|
||||
# CreateDockerfileApplicationRedirect
|
||||
|
||||
How to set redirect with Traefik / Caddy. www<->non-www.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateDockerfileApplicationRedirect } from "coolify/models/operations";
|
||||
|
||||
let value: CreateDockerfileApplicationRedirect = "both";
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
```typescript
|
||||
"www" | "non-www" | "both"
|
||||
```
|
||||
@@ -0,0 +1,67 @@
|
||||
# CreateDockerfileApplicationRequestBody
|
||||
|
||||
Application object that needs to be created.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateDockerfileApplicationRequestBody } from "coolify/models/operations";
|
||||
|
||||
let value: CreateDockerfileApplicationRequestBody = {
|
||||
projectUuid: "<id>",
|
||||
serverUuid: "<id>",
|
||||
environmentName: "<value>",
|
||||
dockerfile: "<value>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
|
||||
| `projectUuid` | *string* | :heavy_check_mark: | The project UUID. |
|
||||
| `serverUuid` | *string* | :heavy_check_mark: | The server UUID. |
|
||||
| `environmentName` | *string* | :heavy_check_mark: | The environment name. |
|
||||
| `dockerfile` | *string* | :heavy_check_mark: | The Dockerfile content. |
|
||||
| `buildPack` | [operations.CreateDockerfileApplicationBuildPack](../../models/operations/createdockerfileapplicationbuildpack.md) | :heavy_minus_sign: | The build pack type. |
|
||||
| `portsExposes` | *string* | :heavy_minus_sign: | The ports to expose. |
|
||||
| `destinationUuid` | *string* | :heavy_minus_sign: | The destination UUID. |
|
||||
| `name` | *string* | :heavy_minus_sign: | The application name. |
|
||||
| `description` | *string* | :heavy_minus_sign: | The application description. |
|
||||
| `domains` | *string* | :heavy_minus_sign: | The application domains. |
|
||||
| `dockerRegistryImageName` | *string* | :heavy_minus_sign: | The docker registry image name. |
|
||||
| `dockerRegistryImageTag` | *string* | :heavy_minus_sign: | The docker registry image tag. |
|
||||
| `portsMappings` | *string* | :heavy_minus_sign: | The ports mappings. |
|
||||
| `baseDirectory` | *string* | :heavy_minus_sign: | The base directory for all commands. |
|
||||
| `healthCheckEnabled` | *boolean* | :heavy_minus_sign: | Health check enabled. |
|
||||
| `healthCheckPath` | *string* | :heavy_minus_sign: | Health check path. |
|
||||
| `healthCheckPort` | *string* | :heavy_minus_sign: | Health check port. |
|
||||
| `healthCheckHost` | *string* | :heavy_minus_sign: | Health check host. |
|
||||
| `healthCheckMethod` | *string* | :heavy_minus_sign: | Health check method. |
|
||||
| `healthCheckReturnCode` | *number* | :heavy_minus_sign: | Health check return code. |
|
||||
| `healthCheckScheme` | *string* | :heavy_minus_sign: | Health check scheme. |
|
||||
| `healthCheckResponseText` | *string* | :heavy_minus_sign: | Health check response text. |
|
||||
| `healthCheckInterval` | *number* | :heavy_minus_sign: | Health check interval in seconds. |
|
||||
| `healthCheckTimeout` | *number* | :heavy_minus_sign: | Health check timeout in seconds. |
|
||||
| `healthCheckRetries` | *number* | :heavy_minus_sign: | Health check retries count. |
|
||||
| `healthCheckStartPeriod` | *number* | :heavy_minus_sign: | Health check start period in seconds. |
|
||||
| `limitsMemory` | *string* | :heavy_minus_sign: | Memory limit. |
|
||||
| `limitsMemorySwap` | *string* | :heavy_minus_sign: | Memory swap limit. |
|
||||
| `limitsMemorySwappiness` | *number* | :heavy_minus_sign: | Memory swappiness. |
|
||||
| `limitsMemoryReservation` | *string* | :heavy_minus_sign: | Memory reservation. |
|
||||
| `limitsCpus` | *string* | :heavy_minus_sign: | CPU limit. |
|
||||
| `limitsCpuset` | *string* | :heavy_minus_sign: | CPU set. |
|
||||
| `limitsCpuShares` | *number* | :heavy_minus_sign: | CPU shares. |
|
||||
| `customLabels` | *string* | :heavy_minus_sign: | Custom labels. |
|
||||
| `customDockerRunOptions` | *string* | :heavy_minus_sign: | Custom docker run options. |
|
||||
| `postDeploymentCommand` | *string* | :heavy_minus_sign: | Post deployment command. |
|
||||
| `postDeploymentCommandContainer` | *string* | :heavy_minus_sign: | Post deployment command container. |
|
||||
| `preDeploymentCommand` | *string* | :heavy_minus_sign: | Pre deployment command. |
|
||||
| `preDeploymentCommandContainer` | *string* | :heavy_minus_sign: | Pre deployment command container. |
|
||||
| `manualWebhookSecretGithub` | *string* | :heavy_minus_sign: | Manual webhook secret for Github. |
|
||||
| `manualWebhookSecretGitlab` | *string* | :heavy_minus_sign: | Manual webhook secret for Gitlab. |
|
||||
| `manualWebhookSecretBitbucket` | *string* | :heavy_minus_sign: | Manual webhook secret for Bitbucket. |
|
||||
| `manualWebhookSecretGitea` | *string* | :heavy_minus_sign: | Manual webhook secret for Gitea. |
|
||||
| `redirect` | [operations.CreateDockerfileApplicationRedirect](../../models/operations/createdockerfileapplicationredirect.md) | :heavy_minus_sign: | How to set redirect with Traefik / Caddy. www<->non-www. |
|
||||
| `instantDeploy` | *boolean* | :heavy_minus_sign: | The flag to indicate if the application should be deployed instantly. |
|
||||
| `useBuildServer` | *boolean* | :heavy_minus_sign: | Use build server. |
|
||||
@@ -0,0 +1,17 @@
|
||||
# CreateDockerimageApplicationRedirect
|
||||
|
||||
How to set redirect with Traefik / Caddy. www<->non-www.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateDockerimageApplicationRedirect } from "coolify/models/operations";
|
||||
|
||||
let value: CreateDockerimageApplicationRedirect = "www";
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
```typescript
|
||||
"www" | "non-www" | "both"
|
||||
```
|
||||
@@ -0,0 +1,65 @@
|
||||
# CreateDockerimageApplicationRequestBody
|
||||
|
||||
Application object that needs to be created.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateDockerimageApplicationRequestBody } from "coolify/models/operations";
|
||||
|
||||
let value: CreateDockerimageApplicationRequestBody = {
|
||||
projectUuid: "<id>",
|
||||
serverUuid: "<id>",
|
||||
environmentName: "<value>",
|
||||
dockerRegistryImageName: "<value>",
|
||||
portsExposes: "<value>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
|
||||
| `projectUuid` | *string* | :heavy_check_mark: | The project UUID. |
|
||||
| `serverUuid` | *string* | :heavy_check_mark: | The server UUID. |
|
||||
| `environmentName` | *string* | :heavy_check_mark: | The environment name. |
|
||||
| `dockerRegistryImageName` | *string* | :heavy_check_mark: | The docker registry image name. |
|
||||
| `dockerRegistryImageTag` | *string* | :heavy_minus_sign: | The docker registry image tag. |
|
||||
| `portsExposes` | *string* | :heavy_check_mark: | The ports to expose. |
|
||||
| `destinationUuid` | *string* | :heavy_minus_sign: | The destination UUID. |
|
||||
| `name` | *string* | :heavy_minus_sign: | The application name. |
|
||||
| `description` | *string* | :heavy_minus_sign: | The application description. |
|
||||
| `domains` | *string* | :heavy_minus_sign: | The application domains. |
|
||||
| `portsMappings` | *string* | :heavy_minus_sign: | The ports mappings. |
|
||||
| `healthCheckEnabled` | *boolean* | :heavy_minus_sign: | Health check enabled. |
|
||||
| `healthCheckPath` | *string* | :heavy_minus_sign: | Health check path. |
|
||||
| `healthCheckPort` | *string* | :heavy_minus_sign: | Health check port. |
|
||||
| `healthCheckHost` | *string* | :heavy_minus_sign: | Health check host. |
|
||||
| `healthCheckMethod` | *string* | :heavy_minus_sign: | Health check method. |
|
||||
| `healthCheckReturnCode` | *number* | :heavy_minus_sign: | Health check return code. |
|
||||
| `healthCheckScheme` | *string* | :heavy_minus_sign: | Health check scheme. |
|
||||
| `healthCheckResponseText` | *string* | :heavy_minus_sign: | Health check response text. |
|
||||
| `healthCheckInterval` | *number* | :heavy_minus_sign: | Health check interval in seconds. |
|
||||
| `healthCheckTimeout` | *number* | :heavy_minus_sign: | Health check timeout in seconds. |
|
||||
| `healthCheckRetries` | *number* | :heavy_minus_sign: | Health check retries count. |
|
||||
| `healthCheckStartPeriod` | *number* | :heavy_minus_sign: | Health check start period in seconds. |
|
||||
| `limitsMemory` | *string* | :heavy_minus_sign: | Memory limit. |
|
||||
| `limitsMemorySwap` | *string* | :heavy_minus_sign: | Memory swap limit. |
|
||||
| `limitsMemorySwappiness` | *number* | :heavy_minus_sign: | Memory swappiness. |
|
||||
| `limitsMemoryReservation` | *string* | :heavy_minus_sign: | Memory reservation. |
|
||||
| `limitsCpus` | *string* | :heavy_minus_sign: | CPU limit. |
|
||||
| `limitsCpuset` | *string* | :heavy_minus_sign: | CPU set. |
|
||||
| `limitsCpuShares` | *number* | :heavy_minus_sign: | CPU shares. |
|
||||
| `customLabels` | *string* | :heavy_minus_sign: | Custom labels. |
|
||||
| `customDockerRunOptions` | *string* | :heavy_minus_sign: | Custom docker run options. |
|
||||
| `postDeploymentCommand` | *string* | :heavy_minus_sign: | Post deployment command. |
|
||||
| `postDeploymentCommandContainer` | *string* | :heavy_minus_sign: | Post deployment command container. |
|
||||
| `preDeploymentCommand` | *string* | :heavy_minus_sign: | Pre deployment command. |
|
||||
| `preDeploymentCommandContainer` | *string* | :heavy_minus_sign: | Pre deployment command container. |
|
||||
| `manualWebhookSecretGithub` | *string* | :heavy_minus_sign: | Manual webhook secret for Github. |
|
||||
| `manualWebhookSecretGitlab` | *string* | :heavy_minus_sign: | Manual webhook secret for Gitlab. |
|
||||
| `manualWebhookSecretBitbucket` | *string* | :heavy_minus_sign: | Manual webhook secret for Bitbucket. |
|
||||
| `manualWebhookSecretGitea` | *string* | :heavy_minus_sign: | Manual webhook secret for Gitea. |
|
||||
| `redirect` | [operations.CreateDockerimageApplicationRedirect](../../models/operations/createdockerimageapplicationredirect.md) | :heavy_minus_sign: | How to set redirect with Traefik / Caddy. www<->non-www. |
|
||||
| `instantDeploy` | *boolean* | :heavy_minus_sign: | The flag to indicate if the application should be deployed instantly. |
|
||||
| `useBuildServer` | *boolean* | :heavy_minus_sign: | Use build server. |
|
||||
19
docs/models/operations/createenvbyapplicationuuidrequest.md
Normal file
19
docs/models/operations/createenvbyapplicationuuidrequest.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# CreateEnvByApplicationUuidRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateEnvByApplicationUuidRequest } from "coolify/models/operations";
|
||||
|
||||
let value: CreateEnvByApplicationUuidRequest = {
|
||||
uuid: "56ecb1eb-f2d2-491d-8c96-1b7bdfd05b28",
|
||||
requestBody: {},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `uuid` | *string* | :heavy_check_mark: | UUID of the application. |
|
||||
| `requestBody` | [operations.CreateEnvByApplicationUuidRequestBody](../../models/operations/createenvbyapplicationuuidrequestbody.md) | :heavy_check_mark: | Env created. |
|
||||
@@ -0,0 +1,23 @@
|
||||
# CreateEnvByApplicationUuidRequestBody
|
||||
|
||||
Env created.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateEnvByApplicationUuidRequestBody } from "coolify/models/operations";
|
||||
|
||||
let value: CreateEnvByApplicationUuidRequestBody = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||
| `key` | *string* | :heavy_minus_sign: | The key of the environment variable. |
|
||||
| `value` | *string* | :heavy_minus_sign: | The value of the environment variable. |
|
||||
| `isPreview` | *boolean* | :heavy_minus_sign: | The flag to indicate if the environment variable is used in preview deployments. |
|
||||
| `isBuildTime` | *boolean* | :heavy_minus_sign: | The flag to indicate if the environment variable is used in build time. |
|
||||
| `isLiteral` | *boolean* | :heavy_minus_sign: | The flag to indicate if the environment variable is a literal, nothing espaced. |
|
||||
| `isMultiline` | *boolean* | :heavy_minus_sign: | The flag to indicate if the environment variable is multiline. |
|
||||
| `isShownOnce` | *boolean* | :heavy_minus_sign: | The flag to indicate if the environment variable's value is shown on the UI. |
|
||||
@@ -0,0 +1,19 @@
|
||||
# CreateEnvByApplicationUuidResponseBody
|
||||
|
||||
Environment variable created.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateEnvByApplicationUuidResponseBody } from "coolify/models/operations";
|
||||
|
||||
let value: CreateEnvByApplicationUuidResponseBody = {
|
||||
uuid: "nc0k04gk8g0cgsk440g0koko",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `uuid` | *string* | :heavy_minus_sign: | N/A | nc0k04gk8g0cgsk440g0koko |
|
||||
19
docs/models/operations/createenvbyserviceuuidrequest.md
Normal file
19
docs/models/operations/createenvbyserviceuuidrequest.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# CreateEnvByServiceUuidRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateEnvByServiceUuidRequest } from "coolify/models/operations";
|
||||
|
||||
let value: CreateEnvByServiceUuidRequest = {
|
||||
uuid: "c8177365-2748-40ed-98df-1aff92903f5a",
|
||||
requestBody: {},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `uuid` | *string* | :heavy_check_mark: | UUID of the service. |
|
||||
| `requestBody` | [operations.CreateEnvByServiceUuidRequestBody](../../models/operations/createenvbyserviceuuidrequestbody.md) | :heavy_check_mark: | Env created. |
|
||||
23
docs/models/operations/createenvbyserviceuuidrequestbody.md
Normal file
23
docs/models/operations/createenvbyserviceuuidrequestbody.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# CreateEnvByServiceUuidRequestBody
|
||||
|
||||
Env created.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateEnvByServiceUuidRequestBody } from "coolify/models/operations";
|
||||
|
||||
let value: CreateEnvByServiceUuidRequestBody = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||
| `key` | *string* | :heavy_minus_sign: | The key of the environment variable. |
|
||||
| `value` | *string* | :heavy_minus_sign: | The value of the environment variable. |
|
||||
| `isPreview` | *boolean* | :heavy_minus_sign: | The flag to indicate if the environment variable is used in preview deployments. |
|
||||
| `isBuildTime` | *boolean* | :heavy_minus_sign: | The flag to indicate if the environment variable is used in build time. |
|
||||
| `isLiteral` | *boolean* | :heavy_minus_sign: | The flag to indicate if the environment variable is a literal, nothing espaced. |
|
||||
| `isMultiline` | *boolean* | :heavy_minus_sign: | The flag to indicate if the environment variable is multiline. |
|
||||
| `isShownOnce` | *boolean* | :heavy_minus_sign: | The flag to indicate if the environment variable's value is shown on the UI. |
|
||||
19
docs/models/operations/createenvbyserviceuuidresponsebody.md
Normal file
19
docs/models/operations/createenvbyserviceuuidresponsebody.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# CreateEnvByServiceUuidResponseBody
|
||||
|
||||
Environment variable created.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateEnvByServiceUuidResponseBody } from "coolify/models/operations";
|
||||
|
||||
let value: CreateEnvByServiceUuidResponseBody = {
|
||||
uuid: "nc0k04gk8g0cgsk440g0koko",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `uuid` | *string* | :heavy_minus_sign: | N/A | nc0k04gk8g0cgsk440g0koko |
|
||||
@@ -0,0 +1,17 @@
|
||||
# CreatePrivateDeployKeyApplicationBuildPack
|
||||
|
||||
The build pack type.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreatePrivateDeployKeyApplicationBuildPack } from "coolify/models/operations";
|
||||
|
||||
let value: CreatePrivateDeployKeyApplicationBuildPack = "static";
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
```typescript
|
||||
"nixpacks" | "static" | "dockerfile" | "dockercompose"
|
||||
```
|
||||
@@ -0,0 +1,17 @@
|
||||
# CreatePrivateDeployKeyApplicationRedirect
|
||||
|
||||
How to set redirect with Traefik / Caddy. www<->non-www.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreatePrivateDeployKeyApplicationRedirect } from "coolify/models/operations";
|
||||
|
||||
let value: CreatePrivateDeployKeyApplicationRedirect = "both";
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
```typescript
|
||||
"www" | "non-www" | "both"
|
||||
```
|
||||
@@ -0,0 +1,87 @@
|
||||
# CreatePrivateDeployKeyApplicationRequestBody
|
||||
|
||||
Application object that needs to be created.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreatePrivateDeployKeyApplicationRequestBody } from "coolify/models/operations";
|
||||
|
||||
let value: CreatePrivateDeployKeyApplicationRequestBody = {
|
||||
projectUuid: "<id>",
|
||||
serverUuid: "<id>",
|
||||
environmentName: "<value>",
|
||||
privateKeyUuid: "<id>",
|
||||
gitRepository: "<value>",
|
||||
gitBranch: "<value>",
|
||||
portsExposes: "<value>",
|
||||
buildPack: "dockerfile",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `projectUuid` | *string* | :heavy_check_mark: | The project UUID. |
|
||||
| `serverUuid` | *string* | :heavy_check_mark: | The server UUID. |
|
||||
| `environmentName` | *string* | :heavy_check_mark: | The environment name. |
|
||||
| `privateKeyUuid` | *string* | :heavy_check_mark: | The private key UUID. |
|
||||
| `gitRepository` | *string* | :heavy_check_mark: | The git repository URL. |
|
||||
| `gitBranch` | *string* | :heavy_check_mark: | The git branch. |
|
||||
| `portsExposes` | *string* | :heavy_check_mark: | The ports to expose. |
|
||||
| `destinationUuid` | *string* | :heavy_minus_sign: | The destination UUID. |
|
||||
| `buildPack` | [operations.CreatePrivateDeployKeyApplicationBuildPack](../../models/operations/createprivatedeploykeyapplicationbuildpack.md) | :heavy_check_mark: | The build pack type. |
|
||||
| `name` | *string* | :heavy_minus_sign: | The application name. |
|
||||
| `description` | *string* | :heavy_minus_sign: | The application description. |
|
||||
| `domains` | *string* | :heavy_minus_sign: | The application domains. |
|
||||
| `gitCommitSha` | *string* | :heavy_minus_sign: | The git commit SHA. |
|
||||
| `dockerRegistryImageName` | *string* | :heavy_minus_sign: | The docker registry image name. |
|
||||
| `dockerRegistryImageTag` | *string* | :heavy_minus_sign: | The docker registry image tag. |
|
||||
| `isStatic` | *boolean* | :heavy_minus_sign: | The flag to indicate if the application is static. |
|
||||
| `staticImage` | [operations.CreatePrivateDeployKeyApplicationStaticImage](../../models/operations/createprivatedeploykeyapplicationstaticimage.md) | :heavy_minus_sign: | The static image. |
|
||||
| `installCommand` | *string* | :heavy_minus_sign: | The install command. |
|
||||
| `buildCommand` | *string* | :heavy_minus_sign: | The build command. |
|
||||
| `startCommand` | *string* | :heavy_minus_sign: | The start command. |
|
||||
| `portsMappings` | *string* | :heavy_minus_sign: | The ports mappings. |
|
||||
| `baseDirectory` | *string* | :heavy_minus_sign: | The base directory for all commands. |
|
||||
| `publishDirectory` | *string* | :heavy_minus_sign: | The publish directory. |
|
||||
| `healthCheckEnabled` | *boolean* | :heavy_minus_sign: | Health check enabled. |
|
||||
| `healthCheckPath` | *string* | :heavy_minus_sign: | Health check path. |
|
||||
| `healthCheckPort` | *string* | :heavy_minus_sign: | Health check port. |
|
||||
| `healthCheckHost` | *string* | :heavy_minus_sign: | Health check host. |
|
||||
| `healthCheckMethod` | *string* | :heavy_minus_sign: | Health check method. |
|
||||
| `healthCheckReturnCode` | *number* | :heavy_minus_sign: | Health check return code. |
|
||||
| `healthCheckScheme` | *string* | :heavy_minus_sign: | Health check scheme. |
|
||||
| `healthCheckResponseText` | *string* | :heavy_minus_sign: | Health check response text. |
|
||||
| `healthCheckInterval` | *number* | :heavy_minus_sign: | Health check interval in seconds. |
|
||||
| `healthCheckTimeout` | *number* | :heavy_minus_sign: | Health check timeout in seconds. |
|
||||
| `healthCheckRetries` | *number* | :heavy_minus_sign: | Health check retries count. |
|
||||
| `healthCheckStartPeriod` | *number* | :heavy_minus_sign: | Health check start period in seconds. |
|
||||
| `limitsMemory` | *string* | :heavy_minus_sign: | Memory limit. |
|
||||
| `limitsMemorySwap` | *string* | :heavy_minus_sign: | Memory swap limit. |
|
||||
| `limitsMemorySwappiness` | *number* | :heavy_minus_sign: | Memory swappiness. |
|
||||
| `limitsMemoryReservation` | *string* | :heavy_minus_sign: | Memory reservation. |
|
||||
| `limitsCpus` | *string* | :heavy_minus_sign: | CPU limit. |
|
||||
| `limitsCpuset` | *string* | :heavy_minus_sign: | CPU set. |
|
||||
| `limitsCpuShares` | *number* | :heavy_minus_sign: | CPU shares. |
|
||||
| `customLabels` | *string* | :heavy_minus_sign: | Custom labels. |
|
||||
| `customDockerRunOptions` | *string* | :heavy_minus_sign: | Custom docker run options. |
|
||||
| `postDeploymentCommand` | *string* | :heavy_minus_sign: | Post deployment command. |
|
||||
| `postDeploymentCommandContainer` | *string* | :heavy_minus_sign: | Post deployment command container. |
|
||||
| `preDeploymentCommand` | *string* | :heavy_minus_sign: | Pre deployment command. |
|
||||
| `preDeploymentCommandContainer` | *string* | :heavy_minus_sign: | Pre deployment command container. |
|
||||
| `manualWebhookSecretGithub` | *string* | :heavy_minus_sign: | Manual webhook secret for Github. |
|
||||
| `manualWebhookSecretGitlab` | *string* | :heavy_minus_sign: | Manual webhook secret for Gitlab. |
|
||||
| `manualWebhookSecretBitbucket` | *string* | :heavy_minus_sign: | Manual webhook secret for Bitbucket. |
|
||||
| `manualWebhookSecretGitea` | *string* | :heavy_minus_sign: | Manual webhook secret for Gitea. |
|
||||
| `redirect` | [operations.CreatePrivateDeployKeyApplicationRedirect](../../models/operations/createprivatedeploykeyapplicationredirect.md) | :heavy_minus_sign: | How to set redirect with Traefik / Caddy. www<->non-www. |
|
||||
| `instantDeploy` | *boolean* | :heavy_minus_sign: | The flag to indicate if the application should be deployed instantly. |
|
||||
| `dockerfile` | *string* | :heavy_minus_sign: | The Dockerfile content. |
|
||||
| `dockerComposeLocation` | *string* | :heavy_minus_sign: | The Docker Compose location. |
|
||||
| `dockerComposeRaw` | *string* | :heavy_minus_sign: | The Docker Compose raw content. |
|
||||
| `dockerComposeCustomStartCommand` | *string* | :heavy_minus_sign: | The Docker Compose custom start command. |
|
||||
| `dockerComposeCustomBuildCommand` | *string* | :heavy_minus_sign: | The Docker Compose custom build command. |
|
||||
| `dockerComposeDomains` | *any*[] | :heavy_minus_sign: | The Docker Compose domains. |
|
||||
| `watchPaths` | *string* | :heavy_minus_sign: | The watch paths. |
|
||||
| `useBuildServer` | *boolean* | :heavy_minus_sign: | Use build server. |
|
||||
@@ -0,0 +1,17 @@
|
||||
# CreatePrivateDeployKeyApplicationStaticImage
|
||||
|
||||
The static image.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreatePrivateDeployKeyApplicationStaticImage } from "coolify/models/operations";
|
||||
|
||||
let value: CreatePrivateDeployKeyApplicationStaticImage = "nginx:alpine";
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
```typescript
|
||||
"nginx:alpine"
|
||||
```
|
||||
@@ -0,0 +1,17 @@
|
||||
# CreatePrivateGithubAppApplicationBuildPack
|
||||
|
||||
The build pack type.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreatePrivateGithubAppApplicationBuildPack } from "coolify/models/operations";
|
||||
|
||||
let value: CreatePrivateGithubAppApplicationBuildPack = "static";
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
```typescript
|
||||
"nixpacks" | "static" | "dockerfile" | "dockercompose"
|
||||
```
|
||||
@@ -0,0 +1,17 @@
|
||||
# CreatePrivateGithubAppApplicationRedirect
|
||||
|
||||
How to set redirect with Traefik / Caddy. www<->non-www.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreatePrivateGithubAppApplicationRedirect } from "coolify/models/operations";
|
||||
|
||||
let value: CreatePrivateGithubAppApplicationRedirect = "both";
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
```typescript
|
||||
"www" | "non-www" | "both"
|
||||
```
|
||||
@@ -0,0 +1,87 @@
|
||||
# CreatePrivateGithubAppApplicationRequestBody
|
||||
|
||||
Application object that needs to be created.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreatePrivateGithubAppApplicationRequestBody } from "coolify/models/operations";
|
||||
|
||||
let value: CreatePrivateGithubAppApplicationRequestBody = {
|
||||
projectUuid: "<id>",
|
||||
serverUuid: "<id>",
|
||||
environmentName: "<value>",
|
||||
githubAppUuid: "<id>",
|
||||
gitRepository: "<value>",
|
||||
gitBranch: "<value>",
|
||||
portsExposes: "<value>",
|
||||
buildPack: "dockercompose",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `projectUuid` | *string* | :heavy_check_mark: | The project UUID. |
|
||||
| `serverUuid` | *string* | :heavy_check_mark: | The server UUID. |
|
||||
| `environmentName` | *string* | :heavy_check_mark: | The environment name. |
|
||||
| `githubAppUuid` | *string* | :heavy_check_mark: | The Github App UUID. |
|
||||
| `gitRepository` | *string* | :heavy_check_mark: | The git repository URL. |
|
||||
| `gitBranch` | *string* | :heavy_check_mark: | The git branch. |
|
||||
| `portsExposes` | *string* | :heavy_check_mark: | The ports to expose. |
|
||||
| `destinationUuid` | *string* | :heavy_minus_sign: | The destination UUID. |
|
||||
| `buildPack` | [operations.CreatePrivateGithubAppApplicationBuildPack](../../models/operations/createprivategithubappapplicationbuildpack.md) | :heavy_check_mark: | The build pack type. |
|
||||
| `name` | *string* | :heavy_minus_sign: | The application name. |
|
||||
| `description` | *string* | :heavy_minus_sign: | The application description. |
|
||||
| `domains` | *string* | :heavy_minus_sign: | The application domains. |
|
||||
| `gitCommitSha` | *string* | :heavy_minus_sign: | The git commit SHA. |
|
||||
| `dockerRegistryImageName` | *string* | :heavy_minus_sign: | The docker registry image name. |
|
||||
| `dockerRegistryImageTag` | *string* | :heavy_minus_sign: | The docker registry image tag. |
|
||||
| `isStatic` | *boolean* | :heavy_minus_sign: | The flag to indicate if the application is static. |
|
||||
| `staticImage` | [operations.CreatePrivateGithubAppApplicationStaticImage](../../models/operations/createprivategithubappapplicationstaticimage.md) | :heavy_minus_sign: | The static image. |
|
||||
| `installCommand` | *string* | :heavy_minus_sign: | The install command. |
|
||||
| `buildCommand` | *string* | :heavy_minus_sign: | The build command. |
|
||||
| `startCommand` | *string* | :heavy_minus_sign: | The start command. |
|
||||
| `portsMappings` | *string* | :heavy_minus_sign: | The ports mappings. |
|
||||
| `baseDirectory` | *string* | :heavy_minus_sign: | The base directory for all commands. |
|
||||
| `publishDirectory` | *string* | :heavy_minus_sign: | The publish directory. |
|
||||
| `healthCheckEnabled` | *boolean* | :heavy_minus_sign: | Health check enabled. |
|
||||
| `healthCheckPath` | *string* | :heavy_minus_sign: | Health check path. |
|
||||
| `healthCheckPort` | *string* | :heavy_minus_sign: | Health check port. |
|
||||
| `healthCheckHost` | *string* | :heavy_minus_sign: | Health check host. |
|
||||
| `healthCheckMethod` | *string* | :heavy_minus_sign: | Health check method. |
|
||||
| `healthCheckReturnCode` | *number* | :heavy_minus_sign: | Health check return code. |
|
||||
| `healthCheckScheme` | *string* | :heavy_minus_sign: | Health check scheme. |
|
||||
| `healthCheckResponseText` | *string* | :heavy_minus_sign: | Health check response text. |
|
||||
| `healthCheckInterval` | *number* | :heavy_minus_sign: | Health check interval in seconds. |
|
||||
| `healthCheckTimeout` | *number* | :heavy_minus_sign: | Health check timeout in seconds. |
|
||||
| `healthCheckRetries` | *number* | :heavy_minus_sign: | Health check retries count. |
|
||||
| `healthCheckStartPeriod` | *number* | :heavy_minus_sign: | Health check start period in seconds. |
|
||||
| `limitsMemory` | *string* | :heavy_minus_sign: | Memory limit. |
|
||||
| `limitsMemorySwap` | *string* | :heavy_minus_sign: | Memory swap limit. |
|
||||
| `limitsMemorySwappiness` | *number* | :heavy_minus_sign: | Memory swappiness. |
|
||||
| `limitsMemoryReservation` | *string* | :heavy_minus_sign: | Memory reservation. |
|
||||
| `limitsCpus` | *string* | :heavy_minus_sign: | CPU limit. |
|
||||
| `limitsCpuset` | *string* | :heavy_minus_sign: | CPU set. |
|
||||
| `limitsCpuShares` | *number* | :heavy_minus_sign: | CPU shares. |
|
||||
| `customLabels` | *string* | :heavy_minus_sign: | Custom labels. |
|
||||
| `customDockerRunOptions` | *string* | :heavy_minus_sign: | Custom docker run options. |
|
||||
| `postDeploymentCommand` | *string* | :heavy_minus_sign: | Post deployment command. |
|
||||
| `postDeploymentCommandContainer` | *string* | :heavy_minus_sign: | Post deployment command container. |
|
||||
| `preDeploymentCommand` | *string* | :heavy_minus_sign: | Pre deployment command. |
|
||||
| `preDeploymentCommandContainer` | *string* | :heavy_minus_sign: | Pre deployment command container. |
|
||||
| `manualWebhookSecretGithub` | *string* | :heavy_minus_sign: | Manual webhook secret for Github. |
|
||||
| `manualWebhookSecretGitlab` | *string* | :heavy_minus_sign: | Manual webhook secret for Gitlab. |
|
||||
| `manualWebhookSecretBitbucket` | *string* | :heavy_minus_sign: | Manual webhook secret for Bitbucket. |
|
||||
| `manualWebhookSecretGitea` | *string* | :heavy_minus_sign: | Manual webhook secret for Gitea. |
|
||||
| `redirect` | [operations.CreatePrivateGithubAppApplicationRedirect](../../models/operations/createprivategithubappapplicationredirect.md) | :heavy_minus_sign: | How to set redirect with Traefik / Caddy. www<->non-www. |
|
||||
| `instantDeploy` | *boolean* | :heavy_minus_sign: | The flag to indicate if the application should be deployed instantly. |
|
||||
| `dockerfile` | *string* | :heavy_minus_sign: | The Dockerfile content. |
|
||||
| `dockerComposeLocation` | *string* | :heavy_minus_sign: | The Docker Compose location. |
|
||||
| `dockerComposeRaw` | *string* | :heavy_minus_sign: | The Docker Compose raw content. |
|
||||
| `dockerComposeCustomStartCommand` | *string* | :heavy_minus_sign: | The Docker Compose custom start command. |
|
||||
| `dockerComposeCustomBuildCommand` | *string* | :heavy_minus_sign: | The Docker Compose custom build command. |
|
||||
| `dockerComposeDomains` | *any*[] | :heavy_minus_sign: | The Docker Compose domains. |
|
||||
| `watchPaths` | *string* | :heavy_minus_sign: | The watch paths. |
|
||||
| `useBuildServer` | *boolean* | :heavy_minus_sign: | Use build server. |
|
||||
@@ -0,0 +1,17 @@
|
||||
# CreatePrivateGithubAppApplicationStaticImage
|
||||
|
||||
The static image.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreatePrivateGithubAppApplicationStaticImage } from "coolify/models/operations";
|
||||
|
||||
let value: CreatePrivateGithubAppApplicationStaticImage = "nginx:alpine";
|
||||
```
|
||||
|
||||
## Values
|
||||
|
||||
```typescript
|
||||
"nginx:alpine"
|
||||
```
|
||||
19
docs/models/operations/createprivatekeyrequestbody.md
Normal file
19
docs/models/operations/createprivatekeyrequestbody.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# CreatePrivateKeyRequestBody
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreatePrivateKeyRequestBody } from "coolify/models/operations";
|
||||
|
||||
let value: CreatePrivateKeyRequestBody = {
|
||||
privateKey: "<value>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `name` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `description` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `privateKey` | *string* | :heavy_check_mark: | N/A |
|
||||
17
docs/models/operations/createprivatekeyresponsebody.md
Normal file
17
docs/models/operations/createprivatekeyresponsebody.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# CreatePrivateKeyResponseBody
|
||||
|
||||
The created private key's UUID.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreatePrivateKeyResponseBody } from "coolify/models/operations";
|
||||
|
||||
let value: CreatePrivateKeyResponseBody = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `uuid` | *string* | :heavy_minus_sign: | N/A |
|
||||
18
docs/models/operations/createprojectrequestbody.md
Normal file
18
docs/models/operations/createprojectrequestbody.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# CreateProjectRequestBody
|
||||
|
||||
Project created.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateProjectRequestBody } from "coolify/models/operations";
|
||||
|
||||
let value: CreateProjectRequestBody = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| `name` | *string* | :heavy_minus_sign: | The name of the project. |
|
||||
| `description` | *string* | :heavy_minus_sign: | The description of the project. |
|
||||
19
docs/models/operations/createprojectresponsebody.md
Normal file
19
docs/models/operations/createprojectresponsebody.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# CreateProjectResponseBody
|
||||
|
||||
Project created.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateProjectResponseBody } from "coolify/models/operations";
|
||||
|
||||
let value: CreateProjectResponseBody = {
|
||||
uuid: "og888os",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `uuid` | *string* | :heavy_minus_sign: | The UUID of the project. | og888os |
|
||||
85
docs/models/operations/createpublicapplicationrequestbody.md
Normal file
85
docs/models/operations/createpublicapplicationrequestbody.md
Normal file
@@ -0,0 +1,85 @@
|
||||
# CreatePublicApplicationRequestBody
|
||||
|
||||
Application object that needs to be created.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreatePublicApplicationRequestBody } from "coolify/models/operations";
|
||||
|
||||
let value: CreatePublicApplicationRequestBody = {
|
||||
projectUuid: "<id>",
|
||||
serverUuid: "<id>",
|
||||
environmentName: "<value>",
|
||||
gitRepository: "<value>",
|
||||
gitBranch: "<value>",
|
||||
buildPack: "dockerfile",
|
||||
portsExposes: "<value>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- |
|
||||
| `projectUuid` | *string* | :heavy_check_mark: | The project UUID. |
|
||||
| `serverUuid` | *string* | :heavy_check_mark: | The server UUID. |
|
||||
| `environmentName` | *string* | :heavy_check_mark: | The environment name. |
|
||||
| `gitRepository` | *string* | :heavy_check_mark: | The git repository URL. |
|
||||
| `gitBranch` | *string* | :heavy_check_mark: | The git branch. |
|
||||
| `buildPack` | [operations.BuildPack](../../models/operations/buildpack.md) | :heavy_check_mark: | The build pack type. |
|
||||
| `portsExposes` | *string* | :heavy_check_mark: | The ports to expose. |
|
||||
| `destinationUuid` | *string* | :heavy_minus_sign: | The destination UUID. |
|
||||
| `name` | *string* | :heavy_minus_sign: | The application name. |
|
||||
| `description` | *string* | :heavy_minus_sign: | The application description. |
|
||||
| `domains` | *string* | :heavy_minus_sign: | The application domains. |
|
||||
| `gitCommitSha` | *string* | :heavy_minus_sign: | The git commit SHA. |
|
||||
| `dockerRegistryImageName` | *string* | :heavy_minus_sign: | The docker registry image name. |
|
||||
| `dockerRegistryImageTag` | *string* | :heavy_minus_sign: | The docker registry image tag. |
|
||||
| `isStatic` | *boolean* | :heavy_minus_sign: | The flag to indicate if the application is static. |
|
||||
| `staticImage` | [operations.StaticImage](../../models/operations/staticimage.md) | :heavy_minus_sign: | The static image. |
|
||||
| `installCommand` | *string* | :heavy_minus_sign: | The install command. |
|
||||
| `buildCommand` | *string* | :heavy_minus_sign: | The build command. |
|
||||
| `startCommand` | *string* | :heavy_minus_sign: | The start command. |
|
||||
| `portsMappings` | *string* | :heavy_minus_sign: | The ports mappings. |
|
||||
| `baseDirectory` | *string* | :heavy_minus_sign: | The base directory for all commands. |
|
||||
| `publishDirectory` | *string* | :heavy_minus_sign: | The publish directory. |
|
||||
| `healthCheckEnabled` | *boolean* | :heavy_minus_sign: | Health check enabled. |
|
||||
| `healthCheckPath` | *string* | :heavy_minus_sign: | Health check path. |
|
||||
| `healthCheckPort` | *string* | :heavy_minus_sign: | Health check port. |
|
||||
| `healthCheckHost` | *string* | :heavy_minus_sign: | Health check host. |
|
||||
| `healthCheckMethod` | *string* | :heavy_minus_sign: | Health check method. |
|
||||
| `healthCheckReturnCode` | *number* | :heavy_minus_sign: | Health check return code. |
|
||||
| `healthCheckScheme` | *string* | :heavy_minus_sign: | Health check scheme. |
|
||||
| `healthCheckResponseText` | *string* | :heavy_minus_sign: | Health check response text. |
|
||||
| `healthCheckInterval` | *number* | :heavy_minus_sign: | Health check interval in seconds. |
|
||||
| `healthCheckTimeout` | *number* | :heavy_minus_sign: | Health check timeout in seconds. |
|
||||
| `healthCheckRetries` | *number* | :heavy_minus_sign: | Health check retries count. |
|
||||
| `healthCheckStartPeriod` | *number* | :heavy_minus_sign: | Health check start period in seconds. |
|
||||
| `limitsMemory` | *string* | :heavy_minus_sign: | Memory limit. |
|
||||
| `limitsMemorySwap` | *string* | :heavy_minus_sign: | Memory swap limit. |
|
||||
| `limitsMemorySwappiness` | *number* | :heavy_minus_sign: | Memory swappiness. |
|
||||
| `limitsMemoryReservation` | *string* | :heavy_minus_sign: | Memory reservation. |
|
||||
| `limitsCpus` | *string* | :heavy_minus_sign: | CPU limit. |
|
||||
| `limitsCpuset` | *string* | :heavy_minus_sign: | CPU set. |
|
||||
| `limitsCpuShares` | *number* | :heavy_minus_sign: | CPU shares. |
|
||||
| `customLabels` | *string* | :heavy_minus_sign: | Custom labels. |
|
||||
| `customDockerRunOptions` | *string* | :heavy_minus_sign: | Custom docker run options. |
|
||||
| `postDeploymentCommand` | *string* | :heavy_minus_sign: | Post deployment command. |
|
||||
| `postDeploymentCommandContainer` | *string* | :heavy_minus_sign: | Post deployment command container. |
|
||||
| `preDeploymentCommand` | *string* | :heavy_minus_sign: | Pre deployment command. |
|
||||
| `preDeploymentCommandContainer` | *string* | :heavy_minus_sign: | Pre deployment command container. |
|
||||
| `manualWebhookSecretGithub` | *string* | :heavy_minus_sign: | Manual webhook secret for Github. |
|
||||
| `manualWebhookSecretGitlab` | *string* | :heavy_minus_sign: | Manual webhook secret for Gitlab. |
|
||||
| `manualWebhookSecretBitbucket` | *string* | :heavy_minus_sign: | Manual webhook secret for Bitbucket. |
|
||||
| `manualWebhookSecretGitea` | *string* | :heavy_minus_sign: | Manual webhook secret for Gitea. |
|
||||
| `redirect` | [operations.Redirect](../../models/operations/redirect.md) | :heavy_minus_sign: | How to set redirect with Traefik / Caddy. www<->non-www. |
|
||||
| `instantDeploy` | *boolean* | :heavy_minus_sign: | The flag to indicate if the application should be deployed instantly. |
|
||||
| `dockerfile` | *string* | :heavy_minus_sign: | The Dockerfile content. |
|
||||
| `dockerComposeLocation` | *string* | :heavy_minus_sign: | The Docker Compose location. |
|
||||
| `dockerComposeRaw` | *string* | :heavy_minus_sign: | The Docker Compose raw content. |
|
||||
| `dockerComposeCustomStartCommand` | *string* | :heavy_minus_sign: | The Docker Compose custom start command. |
|
||||
| `dockerComposeCustomBuildCommand` | *string* | :heavy_minus_sign: | The Docker Compose custom build command. |
|
||||
| `dockerComposeDomains` | *any*[] | :heavy_minus_sign: | The Docker Compose domains. |
|
||||
| `watchPaths` | *string* | :heavy_minus_sign: | The watch paths. |
|
||||
| `useBuildServer` | *boolean* | :heavy_minus_sign: | Use build server. |
|
||||
35
docs/models/operations/createserverrequestbody.md
Normal file
35
docs/models/operations/createserverrequestbody.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# CreateServerRequestBody
|
||||
|
||||
Server created.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateServerRequestBody } from "coolify/models/operations";
|
||||
|
||||
let value: CreateServerRequestBody = {
|
||||
name: "My Server",
|
||||
description: "My Server Description",
|
||||
ip: "127.0.0.1",
|
||||
port: 22,
|
||||
user: "root",
|
||||
privateKeyUuid: "og888os",
|
||||
isBuildServer: false,
|
||||
instantValidate: false,
|
||||
proxyType: "traefik",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||
| `name` | *string* | :heavy_minus_sign: | The name of the server. | My Server |
|
||||
| `description` | *string* | :heavy_minus_sign: | The description of the server. | My Server Description |
|
||||
| `ip` | *string* | :heavy_minus_sign: | The IP of the server. | 127.0.0.1 |
|
||||
| `port` | *number* | :heavy_minus_sign: | The port of the server. | 22 |
|
||||
| `user` | *string* | :heavy_minus_sign: | The user of the server. | root |
|
||||
| `privateKeyUuid` | *string* | :heavy_minus_sign: | The UUID of the private key. | og888os |
|
||||
| `isBuildServer` | *boolean* | :heavy_minus_sign: | Is build server. | false |
|
||||
| `instantValidate` | *boolean* | :heavy_minus_sign: | Instant validate. | false |
|
||||
| `proxyType` | [operations.ProxyType](../../models/operations/proxytype.md) | :heavy_minus_sign: | The proxy type. | traefik |
|
||||
19
docs/models/operations/createserverresponsebody.md
Normal file
19
docs/models/operations/createserverresponsebody.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# CreateServerResponseBody
|
||||
|
||||
Server created.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateServerResponseBody } from "coolify/models/operations";
|
||||
|
||||
let value: CreateServerResponseBody = {
|
||||
uuid: "og888os",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------- | ----------------------- | ----------------------- | ----------------------- | ----------------------- |
|
||||
| `uuid` | *string* | :heavy_minus_sign: | The UUID of the server. | og888os |
|
||||
27
docs/models/operations/createservicerequestbody.md
Normal file
27
docs/models/operations/createservicerequestbody.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# CreateServiceRequestBody
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateServiceRequestBody } from "coolify/models/operations";
|
||||
|
||||
let value: CreateServiceRequestBody = {
|
||||
type: "classicpress-with-mysql",
|
||||
projectUuid: "<id>",
|
||||
environmentName: "<value>",
|
||||
serverUuid: "<id>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
|
||||
| `type` | [operations.Type](../../models/operations/type.md) | :heavy_check_mark: | The one-click service type |
|
||||
| `name` | *string* | :heavy_minus_sign: | Name of the service. |
|
||||
| `description` | *string* | :heavy_minus_sign: | Description of the service. |
|
||||
| `projectUuid` | *string* | :heavy_check_mark: | Project UUID. |
|
||||
| `environmentName` | *string* | :heavy_check_mark: | Environment name. |
|
||||
| `serverUuid` | *string* | :heavy_check_mark: | Server UUID. |
|
||||
| `destinationUuid` | *string* | :heavy_minus_sign: | Destination UUID. Required if server has multiple destinations. |
|
||||
| `instantDeploy` | *boolean* | :heavy_minus_sign: | Start the service immediately after creation. |
|
||||
18
docs/models/operations/createserviceresponsebody.md
Normal file
18
docs/models/operations/createserviceresponsebody.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# CreateServiceResponseBody
|
||||
|
||||
Create a service.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { CreateServiceResponseBody } from "coolify/models/operations";
|
||||
|
||||
let value: CreateServiceResponseBody = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `uuid` | *string* | :heavy_minus_sign: | Service UUID. |
|
||||
| `domains` | *string*[] | :heavy_minus_sign: | Service domains. |
|
||||
21
docs/models/operations/data.md
Normal file
21
docs/models/operations/data.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# Data
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Data } from "coolify/models/operations";
|
||||
|
||||
let value: Data = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||
| `key` | *string* | :heavy_minus_sign: | The key of the environment variable. |
|
||||
| `value` | *string* | :heavy_minus_sign: | The value of the environment variable. |
|
||||
| `isPreview` | *boolean* | :heavy_minus_sign: | The flag to indicate if the environment variable is used in preview deployments. |
|
||||
| `isBuildTime` | *boolean* | :heavy_minus_sign: | The flag to indicate if the environment variable is used in build time. |
|
||||
| `isLiteral` | *boolean* | :heavy_minus_sign: | The flag to indicate if the environment variable is a literal, nothing espaced. |
|
||||
| `isMultiline` | *boolean* | :heavy_minus_sign: | The flag to indicate if the environment variable is multiline. |
|
||||
| `isShownOnce` | *boolean* | :heavy_minus_sign: | The flag to indicate if the environment variable's value is shown on the UI. |
|
||||
21
docs/models/operations/deleteapplicationbyuuidrequest.md
Normal file
21
docs/models/operations/deleteapplicationbyuuidrequest.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# DeleteApplicationByUuidRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeleteApplicationByUuidRequest } from "coolify/models/operations";
|
||||
|
||||
let value: DeleteApplicationByUuidRequest = {
|
||||
uuid: "325597f1-32a4-4732-91a2-35d1d1f7f9b0",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------- | -------------------------- | -------------------------- | -------------------------- |
|
||||
| `uuid` | *string* | :heavy_check_mark: | UUID of the application. |
|
||||
| `deleteConfigurations` | *boolean* | :heavy_minus_sign: | Delete configurations. |
|
||||
| `deleteVolumes` | *boolean* | :heavy_minus_sign: | Delete volumes. |
|
||||
| `dockerCleanup` | *boolean* | :heavy_minus_sign: | Run docker cleanup. |
|
||||
| `deleteConnectedNetworks` | *boolean* | :heavy_minus_sign: | Delete connected networks. |
|
||||
@@ -0,0 +1,19 @@
|
||||
# DeleteApplicationByUuidResponseBody
|
||||
|
||||
Application deleted.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeleteApplicationByUuidResponseBody } from "coolify/models/operations";
|
||||
|
||||
let value: DeleteApplicationByUuidResponseBody = {
|
||||
message: "Application deleted.",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | Application deleted. |
|
||||
21
docs/models/operations/deletedatabasebyuuidrequest.md
Normal file
21
docs/models/operations/deletedatabasebyuuidrequest.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# DeleteDatabaseByUuidRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeleteDatabaseByUuidRequest } from "coolify/models/operations";
|
||||
|
||||
let value: DeleteDatabaseByUuidRequest = {
|
||||
uuid: "f31f3b0b-e465-4b32-974d-38fadfcbff71",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------- | -------------------------- | -------------------------- | -------------------------- |
|
||||
| `uuid` | *string* | :heavy_check_mark: | UUID of the database. |
|
||||
| `deleteConfigurations` | *boolean* | :heavy_minus_sign: | Delete configurations. |
|
||||
| `deleteVolumes` | *boolean* | :heavy_minus_sign: | Delete volumes. |
|
||||
| `dockerCleanup` | *boolean* | :heavy_minus_sign: | Run docker cleanup. |
|
||||
| `deleteConnectedNetworks` | *boolean* | :heavy_minus_sign: | Delete connected networks. |
|
||||
19
docs/models/operations/deletedatabasebyuuidresponsebody.md
Normal file
19
docs/models/operations/deletedatabasebyuuidresponsebody.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# DeleteDatabaseByUuidResponseBody
|
||||
|
||||
Database deleted.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeleteDatabaseByUuidResponseBody } from "coolify/models/operations";
|
||||
|
||||
let value: DeleteDatabaseByUuidResponseBody = {
|
||||
message: "Database deleted.",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | Database deleted. |
|
||||
19
docs/models/operations/deleteenvbyapplicationuuidrequest.md
Normal file
19
docs/models/operations/deleteenvbyapplicationuuidrequest.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# DeleteEnvByApplicationUuidRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeleteEnvByApplicationUuidRequest } from "coolify/models/operations";
|
||||
|
||||
let value: DeleteEnvByApplicationUuidRequest = {
|
||||
uuid: "365749d1-82b6-4922-a75f-cbe189f4310e",
|
||||
envUuid: "c4917fe5-f3ff-4cad-84d9-052f77a52d38",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
|
||||
| `uuid` | *string* | :heavy_check_mark: | UUID of the application. |
|
||||
| `envUuid` | *string* | :heavy_check_mark: | UUID of the environment variable. |
|
||||
@@ -0,0 +1,19 @@
|
||||
# DeleteEnvByApplicationUuidResponseBody
|
||||
|
||||
Environment variable deleted.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeleteEnvByApplicationUuidResponseBody } from "coolify/models/operations";
|
||||
|
||||
let value: DeleteEnvByApplicationUuidResponseBody = {
|
||||
message: "Environment variable deleted.",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | Environment variable deleted. |
|
||||
19
docs/models/operations/deleteenvbyserviceuuidrequest.md
Normal file
19
docs/models/operations/deleteenvbyserviceuuidrequest.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# DeleteEnvByServiceUuidRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeleteEnvByServiceUuidRequest } from "coolify/models/operations";
|
||||
|
||||
let value: DeleteEnvByServiceUuidRequest = {
|
||||
uuid: "064feda5-8d1c-40dc-80a8-22c9fff1f37c",
|
||||
envUuid: "9211506a-6114-42f2-bc99-8f5c86f916cb",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- |
|
||||
| `uuid` | *string* | :heavy_check_mark: | UUID of the service. |
|
||||
| `envUuid` | *string* | :heavy_check_mark: | UUID of the environment variable. |
|
||||
19
docs/models/operations/deleteenvbyserviceuuidresponsebody.md
Normal file
19
docs/models/operations/deleteenvbyserviceuuidresponsebody.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# DeleteEnvByServiceUuidResponseBody
|
||||
|
||||
Environment variable deleted.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeleteEnvByServiceUuidResponseBody } from "coolify/models/operations";
|
||||
|
||||
let value: DeleteEnvByServiceUuidResponseBody = {
|
||||
message: "Environment variable deleted.",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- | ----------------------------- |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | Environment variable deleted. |
|
||||
17
docs/models/operations/deleteprivatekeybyuuidrequest.md
Normal file
17
docs/models/operations/deleteprivatekeybyuuidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# DeletePrivateKeyByUuidRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeletePrivateKeyByUuidRequest } from "coolify/models/operations";
|
||||
|
||||
let value: DeletePrivateKeyByUuidRequest = {
|
||||
uuid: "91fe6347-0a66-4cbf-95ec-594d1326b870",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `uuid` | *string* | :heavy_check_mark: | Private Key UUID |
|
||||
19
docs/models/operations/deleteprivatekeybyuuidresponsebody.md
Normal file
19
docs/models/operations/deleteprivatekeybyuuidresponsebody.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# DeletePrivateKeyByUuidResponseBody
|
||||
|
||||
Private Key deleted.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeletePrivateKeyByUuidResponseBody } from "coolify/models/operations";
|
||||
|
||||
let value: DeletePrivateKeyByUuidResponseBody = {
|
||||
message: "Private Key deleted.",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------- | -------------------- | -------------------- | -------------------- | -------------------- |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | Private Key deleted. |
|
||||
17
docs/models/operations/deleteprojectbyuuidrequest.md
Normal file
17
docs/models/operations/deleteprojectbyuuidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# DeleteProjectByUuidRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeleteProjectByUuidRequest } from "coolify/models/operations";
|
||||
|
||||
let value: DeleteProjectByUuidRequest = {
|
||||
uuid: "ba6691da-b816-4650-ab19-baf1d0868530",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `uuid` | *string* | :heavy_check_mark: | UUID of the application. |
|
||||
19
docs/models/operations/deleteprojectbyuuidresponsebody.md
Normal file
19
docs/models/operations/deleteprojectbyuuidresponsebody.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# DeleteProjectByUuidResponseBody
|
||||
|
||||
Project deleted.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeleteProjectByUuidResponseBody } from "coolify/models/operations";
|
||||
|
||||
let value: DeleteProjectByUuidResponseBody = {
|
||||
message: "Project deleted.",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | Project deleted. |
|
||||
17
docs/models/operations/deleteserverbyuuidrequest.md
Normal file
17
docs/models/operations/deleteserverbyuuidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# DeleteServerByUuidRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeleteServerByUuidRequest } from "coolify/models/operations";
|
||||
|
||||
let value: DeleteServerByUuidRequest = {
|
||||
uuid: "eb2725ee-459f-424d-b7e2-855765ebb49c",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------- | ------------------- | ------------------- | ------------------- |
|
||||
| `uuid` | *string* | :heavy_check_mark: | UUID of the server. |
|
||||
19
docs/models/operations/deleteserverbyuuidresponsebody.md
Normal file
19
docs/models/operations/deleteserverbyuuidresponsebody.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# DeleteServerByUuidResponseBody
|
||||
|
||||
Server deleted.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeleteServerByUuidResponseBody } from "coolify/models/operations";
|
||||
|
||||
let value: DeleteServerByUuidResponseBody = {
|
||||
message: "Server deleted.",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | Server deleted. |
|
||||
21
docs/models/operations/deleteservicebyuuidrequest.md
Normal file
21
docs/models/operations/deleteservicebyuuidrequest.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# DeleteServiceByUuidRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeleteServiceByUuidRequest } from "coolify/models/operations";
|
||||
|
||||
let value: DeleteServiceByUuidRequest = {
|
||||
uuid: "b06ad7f4-074d-434c-8b8b-600810fd20f4",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------- | -------------------------- | -------------------------- | -------------------------- |
|
||||
| `uuid` | *string* | :heavy_check_mark: | Service UUID |
|
||||
| `deleteConfigurations` | *boolean* | :heavy_minus_sign: | Delete configurations. |
|
||||
| `deleteVolumes` | *boolean* | :heavy_minus_sign: | Delete volumes. |
|
||||
| `dockerCleanup` | *boolean* | :heavy_minus_sign: | Run docker cleanup. |
|
||||
| `deleteConnectedNetworks` | *boolean* | :heavy_minus_sign: | Delete connected networks. |
|
||||
19
docs/models/operations/deleteservicebyuuidresponsebody.md
Normal file
19
docs/models/operations/deleteservicebyuuidresponsebody.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# DeleteServiceByUuidResponseBody
|
||||
|
||||
Delete a service by UUID
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeleteServiceByUuidResponseBody } from "coolify/models/operations";
|
||||
|
||||
let value: DeleteServiceByUuidResponseBody = {
|
||||
message: "Service deletion request queued.",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | Service deletion request queued. |
|
||||
17
docs/models/operations/deploybytagoruuidrequest.md
Normal file
17
docs/models/operations/deploybytagoruuidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# DeployByTagOrUuidRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeployByTagOrUuidRequest } from "coolify/models/operations";
|
||||
|
||||
let value: DeployByTagOrUuidRequest = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
|
||||
| `tag` | *string* | :heavy_minus_sign: | Tag name(s). Comma separated list is also accepted. |
|
||||
| `uuid` | *string* | :heavy_minus_sign: | Resource UUID(s). Comma separated list is also accepted. |
|
||||
| `force` | *boolean* | :heavy_minus_sign: | Force rebuild (without cache) |
|
||||
17
docs/models/operations/deploybytagoruuidresponsebody.md
Normal file
17
docs/models/operations/deploybytagoruuidresponsebody.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# DeployByTagOrUuidResponseBody
|
||||
|
||||
Get deployment(s) UUID's
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DeployByTagOrUuidResponseBody } from "coolify/models/operations";
|
||||
|
||||
let value: DeployByTagOrUuidResponseBody = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
|
||||
| `deployments` | [operations.Deployments](../../models/operations/deployments.md)[] | :heavy_minus_sign: | N/A |
|
||||
17
docs/models/operations/deployments.md
Normal file
17
docs/models/operations/deployments.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# Deployments
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { Deployments } from "coolify/models/operations";
|
||||
|
||||
let value: Deployments = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `resourceUuid` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `deploymentUuid` | *string* | :heavy_minus_sign: | N/A |
|
||||
19
docs/models/operations/disableapiresponsebody.md
Normal file
19
docs/models/operations/disableapiresponsebody.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# DisableApiResponseBody
|
||||
|
||||
Disable API.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { DisableApiResponseBody } from "coolify/models/operations";
|
||||
|
||||
let value: DisableApiResponseBody = {
|
||||
message: "API disabled.",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | API disabled. |
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user