mirror of
https://github.com/LukeHagar/Coolify-TypeScript-SDK.git
synced 2025-12-06 20:37:44 +00:00
Saving initial generation
This commit is contained in:
Luke Hagar
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. |
|
||||
19
docs/models/operations/enableapiresponsebody.md
Normal file
19
docs/models/operations/enableapiresponsebody.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# EnableApiResponseBody
|
||||
|
||||
Enable API.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { EnableApiResponseBody } from "coolify/models/operations";
|
||||
|
||||
let value: EnableApiResponseBody = {
|
||||
message: "API enabled.",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | API enabled. |
|
||||
19
docs/models/operations/executecommandapplicationrequest.md
Normal file
19
docs/models/operations/executecommandapplicationrequest.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# ExecuteCommandApplicationRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ExecuteCommandApplicationRequest } from "coolify/models/operations";
|
||||
|
||||
let value: ExecuteCommandApplicationRequest = {
|
||||
uuid: "6164d0f5-5026-4e1f-ad75-390061434201",
|
||||
requestBody: {},
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
|
||||
| `uuid` | *string* | :heavy_check_mark: | UUID of the application. |
|
||||
| `requestBody` | [operations.ExecuteCommandApplicationRequestBody](../../models/operations/executecommandapplicationrequestbody.md) | :heavy_check_mark: | Command to execute. |
|
||||
@@ -0,0 +1,17 @@
|
||||
# ExecuteCommandApplicationRequestBody
|
||||
|
||||
Command to execute.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ExecuteCommandApplicationRequestBody } from "coolify/models/operations";
|
||||
|
||||
let value: ExecuteCommandApplicationRequestBody = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------- | ------------------- | ------------------- | ------------------- |
|
||||
| `command` | *string* | :heavy_minus_sign: | Command to execute. |
|
||||
@@ -0,0 +1,20 @@
|
||||
# ExecuteCommandApplicationResponseBody
|
||||
|
||||
Execute a command on the application's current container.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ExecuteCommandApplicationResponseBody } from "coolify/models/operations";
|
||||
|
||||
let value: ExecuteCommandApplicationResponseBody = {
|
||||
message: "Command executed.",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `message` | *string* | :heavy_minus_sign: | N/A | Command executed. |
|
||||
| `response` | *string* | :heavy_minus_sign: | N/A | |
|
||||
17
docs/models/operations/getapplicationbyuuidrequest.md
Normal file
17
docs/models/operations/getapplicationbyuuidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetApplicationByUuidRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetApplicationByUuidRequest } from "coolify/models/operations";
|
||||
|
||||
let value: GetApplicationByUuidRequest = {
|
||||
uuid: "10dcdfc7-c1a2-4f86-a4c7-90999fa56b0a",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `uuid` | *string* | :heavy_check_mark: | UUID of the application. |
|
||||
17
docs/models/operations/getdatabasebyuuidrequest.md
Normal file
17
docs/models/operations/getdatabasebyuuidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetDatabaseByUuidRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetDatabaseByUuidRequest } from "coolify/models/operations";
|
||||
|
||||
let value: GetDatabaseByUuidRequest = {
|
||||
uuid: "ff62a7f1-c43a-43a8-9684-b65de035dffe",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| --------------------- | --------------------- | --------------------- | --------------------- |
|
||||
| `uuid` | *string* | :heavy_check_mark: | UUID of the database. |
|
||||
17
docs/models/operations/getdeploymentbyuuidrequest.md
Normal file
17
docs/models/operations/getdeploymentbyuuidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetDeploymentByUuidRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetDeploymentByUuidRequest } from "coolify/models/operations";
|
||||
|
||||
let value: GetDeploymentByUuidRequest = {
|
||||
uuid: "438575f2-159a-46f5-8bad-fecb521368cf",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `uuid` | *string* | :heavy_check_mark: | Deployment UUID |
|
||||
17
docs/models/operations/getdomainsbyserveruuidrequest.md
Normal file
17
docs/models/operations/getdomainsbyserveruuidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetDomainsByServerUuidRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetDomainsByServerUuidRequest } from "coolify/models/operations";
|
||||
|
||||
let value: GetDomainsByServerUuidRequest = {
|
||||
uuid: "bd3f2425-78de-4391-9755-7b1eb2f8f384",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `uuid` | *string* | :heavy_check_mark: | Server's UUID |
|
||||
16
docs/models/operations/getdomainsbyserveruuidresponsebody.md
Normal file
16
docs/models/operations/getdomainsbyserveruuidresponsebody.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# GetDomainsByServerUuidResponseBody
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetDomainsByServerUuidResponseBody } from "coolify/models/operations";
|
||||
|
||||
let value: GetDomainsByServerUuidResponseBody = {};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `ip` | *string* | :heavy_minus_sign: | N/A |
|
||||
| `domains` | *string*[] | :heavy_minus_sign: | N/A |
|
||||
19
docs/models/operations/getenvironmentbynamerequest.md
Normal file
19
docs/models/operations/getenvironmentbynamerequest.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# GetEnvironmentByNameRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetEnvironmentByNameRequest } from "coolify/models/operations";
|
||||
|
||||
let value: GetEnvironmentByNameRequest = {
|
||||
uuid: "86547a48-120f-4029-b1eb-f848e84e5035",
|
||||
environmentName: "<value>",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `uuid` | *string* | :heavy_check_mark: | Project UUID |
|
||||
| `environmentName` | *string* | :heavy_check_mark: | Environment name |
|
||||
17
docs/models/operations/getmembersbyteamidrequest.md
Normal file
17
docs/models/operations/getmembersbyteamidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetMembersByTeamIdRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetMembersByTeamIdRequest } from "coolify/models/operations";
|
||||
|
||||
let value: GetMembersByTeamIdRequest = {
|
||||
id: 577590,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *number* | :heavy_check_mark: | Team ID |
|
||||
17
docs/models/operations/getprivatekeybyuuidrequest.md
Normal file
17
docs/models/operations/getprivatekeybyuuidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetPrivateKeyByUuidRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetPrivateKeyByUuidRequest } from "coolify/models/operations";
|
||||
|
||||
let value: GetPrivateKeyByUuidRequest = {
|
||||
uuid: "775eff6f-ca33-42e4-877c-d26dd1241619",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `uuid` | *string* | :heavy_check_mark: | Private Key UUID |
|
||||
17
docs/models/operations/getprojectbyuuidrequest.md
Normal file
17
docs/models/operations/getprojectbyuuidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetProjectByUuidRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetProjectByUuidRequest } from "coolify/models/operations";
|
||||
|
||||
let value: GetProjectByUuidRequest = {
|
||||
uuid: "19bdef66-2aad-4179-932d-0717f6d1466a",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `uuid` | *string* | :heavy_check_mark: | Project UUID |
|
||||
17
docs/models/operations/getresourcesbyserveruuidrequest.md
Normal file
17
docs/models/operations/getresourcesbyserveruuidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetResourcesByServerUuidRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetResourcesByServerUuidRequest } from "coolify/models/operations";
|
||||
|
||||
let value: GetResourcesByServerUuidRequest = {
|
||||
uuid: "5c5a87e8-db0c-43e0-9517-d425d231b64b",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `uuid` | *string* | :heavy_check_mark: | Server's UUID |
|
||||
17
docs/models/operations/getserverbyuuidrequest.md
Normal file
17
docs/models/operations/getserverbyuuidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetServerByUuidRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetServerByUuidRequest } from "coolify/models/operations";
|
||||
|
||||
let value: GetServerByUuidRequest = {
|
||||
uuid: "13e3dc29-1bac-47e0-a4b6-21d7eb658eb0",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `uuid` | *string* | :heavy_check_mark: | Server's UUID |
|
||||
17
docs/models/operations/getservicebyuuidrequest.md
Normal file
17
docs/models/operations/getservicebyuuidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetServiceByUuidRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetServiceByUuidRequest } from "coolify/models/operations";
|
||||
|
||||
let value: GetServiceByUuidRequest = {
|
||||
uuid: "4706739c-39af-4cd7-a2f2-71ffb5442825",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `uuid` | *string* | :heavy_check_mark: | Service UUID |
|
||||
17
docs/models/operations/getteambyidrequest.md
Normal file
17
docs/models/operations/getteambyidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# GetTeamByIdRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { GetTeamByIdRequest } from "coolify/models/operations";
|
||||
|
||||
let value: GetTeamByIdRequest = {
|
||||
id: 810302,
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `id` | *number* | :heavy_check_mark: | Team ID |
|
||||
17
docs/models/operations/listenvsbyapplicationuuidrequest.md
Normal file
17
docs/models/operations/listenvsbyapplicationuuidrequest.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# ListEnvsByApplicationUuidRequest
|
||||
|
||||
## Example Usage
|
||||
|
||||
```typescript
|
||||
import { ListEnvsByApplicationUuidRequest } from "coolify/models/operations";
|
||||
|
||||
let value: ListEnvsByApplicationUuidRequest = {
|
||||
uuid: "7db4d6e9-ebb8-4fa6-b904-a49624999aa6",
|
||||
};
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------ | ------------------------ | ------------------------ | ------------------------ |
|
||||
| `uuid` | *string* | :heavy_check_mark: | UUID of the application. |
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user