coolipy.models

Data models for coolipy.

Sub-modules

coolipy.models.applications

Application models for the Coolify API.

coolipy.models.base

Base model shared by all coolipy data models.

coolipy.models.common

Shared models reused across multiple coolipy resources.

coolipy.models.databases

Database models for the Coolify API.

coolipy.models.deployments

Deployment models for the Coolify API.

coolipy.models.projects

Project and environment models for the Coolify API.

coolipy.models.s3_storages

S3 storage models for the Coolify API.

coolipy.models.security

Private key models for the Coolify API.

coolipy.models.servers

Server models for the Coolify API.

coolipy.models.services

Service models for the Coolify API.

coolipy.models.system

Models for the system-level Coolify endpoints.

coolipy.models.teams

Team and user models for the Coolify API.

Classes

class CoolipyBaseModel (**data: Any)

Expand source code

class CoolipyBaseModel(BaseModel):
    """Base class for every coolipy request and response model.

    Unknown fields are ignored so that responses carrying fields coolipy does
    not model yet still validate.
    """

    model_config = ConfigDict(extra="ignore")

Base class for every coolipy request and response model.

Unknown fields are ignored so that responses carrying fields coolipy does not model yet still validate.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

• pydantic.main.BaseModel

Subclasses

• ApplicationBaseModel
• ApplicationModel
• ApplicationSetting
• DockerComposeDomain
• BulkEnvsUpdate
• DeploymentQueuedResponse
• Destination
• DestinationCreate
• EnvironmentVariable
• EnvironmentVariableCreate
• EnvironmentVariableUpdate
• Logs
• MessageResponse
• ScheduledTask
• ScheduledTaskCreate
• ScheduledTaskExecution
• ScheduledTaskUpdate
• StorageCreate
• StorageUpdate
• Tag
• TagCreate
• TagUpdate
• TagsCreate
• UUIDResponse
• VolumeBackupScheduleRequest
• VolumeBackupScheduleResponse
• DatabaseBackupCreate
• DatabaseBaseModel
• DeployResponse
• DeploymentEntry
• DeploymentModel
• EnvironmentCreateModel
• EnvironmentModel
• EnvironmentUpdateModel
• ProjectCreateModel
• ProjectModel
• ProjectUpdateModel
• S3StorageCreateModel
• S3StorageModel
• S3StorageUpdateModel
• PrivateKeyCreateModel
• PrivateKeyModel
• PrivateKeyUpdateModel
• ServerCreateModel
• ServerModel
• ServerSetting
• ServerUpdateModel
• ServiceCreateModel
• ServiceModel
• ServiceURL
• ServiceUpdateModel
• SystemMessage
• TeamModel
• UserModel

Class variables

var model_config

class SystemMessage (**data: Any)

Expand source code

class SystemMessage(CoolipyBaseModel):
    """A message returned by system endpoints (e.g. enable/disable API, MCP)."""

    message: str

A message returned by system endpoints (e.g. enable/disable API, MCP).

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Ancestors

• CoolipyBaseModel
• pydantic.main.BaseModel

Class variables

var message : str

var model_config