coolipy.models.services

Service models for the Coolify API.

Classes

class ServiceCreateModel (**data: Any)

Expand source code

class ServiceCreateModel(CoolipyBaseModel):
    """Body for creating a service (one-click or custom)."""

    type: str | None = None
    name: str | None = None
    description: str | None = None
    project_uuid: str | None = None
    environment_name: str | None = None
    environment_uuid: str | None = None
    server_uuid: str | None = None
    destination_uuid: str | None = None
    instant_deploy: bool | None = None
    docker_compose_raw: str | None = None
    urls: list[ServiceURL] | None = None
    force_domain_override: bool | None = None
    is_container_label_escape_enabled: bool | None = None
    tags: list[str] | None = None

Body for creating a service (one-click or custom).

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 description : str | None

var destination_uuid : str | None

var docker_compose_raw : str | None

var environment_name : str | None

var environment_uuid : str | None

var force_domain_override : bool | None

var instant_deploy : bool | None

var is_container_label_escape_enabled : bool | None

var model_config

var name : str | None

var project_uuid : str | None

var server_uuid : str | None

var tags : list[str] | None

var type : str | None

var urls : list[ServiceURL] | None

class ServiceModel (**data: Any)

Expand source code

class ServiceModel(CoolipyBaseModel):
    """A service as returned by the API."""

    id: int | None = None
    uuid: str | None = None
    name: str | None = None
    environment_id: int | None = None
    server_id: int | None = None
    description: str | None = None
    docker_compose_raw: str | None = None
    docker_compose: str | None = None
    destination_type: str | None = None
    destination_id: int | None = None
    connect_to_docker_network: bool | None = None
    is_container_label_escape_enabled: bool | None = None
    is_container_label_readonly_enabled: bool | None = None
    config_hash: str | None = None
    service_type: str | None = None
    created_at: datetime | None = None
    updated_at: datetime | None = None
    deleted_at: datetime | None = None

A service as returned by the API.

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 config_hash : str | None

var connect_to_docker_network : bool | None

var created_at : datetime.datetime | None

var deleted_at : datetime.datetime | None

var description : str | None

var destination_id : int | None

var destination_type : str | None

var docker_compose : str | None

var docker_compose_raw : str | None

var environment_id : int | None

var id : int | None

var is_container_label_escape_enabled : bool | None

var is_container_label_readonly_enabled : bool | None

var model_config

var name : str | None

var server_id : int | None

var service_type : str | None

var updated_at : datetime.datetime | None

var uuid : str | None

class ServiceURL (**data: Any)

Expand source code

class ServiceURL(CoolipyBaseModel):
    """A per-service URL mapping for docker-compose services."""

    name: str | None = None
    url: str | None = None

A per-service URL mapping for docker-compose services.

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 model_config

var name : str | None

var url : str | None

class ServiceUpdateModel (**data: Any)

Expand source code

class ServiceUpdateModel(CoolipyBaseModel):
    """Body for updating a service."""

    name: str | None = None
    description: str | None = None
    docker_compose_raw: str | None = None
    is_container_label_escape_enabled: bool | None = None
    force_domain_override: bool | None = None
    urls: list[ServiceURL] | None = None

Body for updating a service.

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 description : str | None

var docker_compose_raw : str | None

var force_domain_override : bool | None

var is_container_label_escape_enabled : bool | None

var model_config

var name : str | None

var urls : list[ServiceURL] | None