mirror of
https://github.com/LukeHagar/Coolify-TypeScript-SDK.git
synced 2025-12-07 12:27:46 +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. |
|
||||
Reference in New Issue
Block a user