coolipy.models.applications

Application models for the Coolify API.

Classes

class ApplicationBaseModel (**data: Any)

Expand source code

class ApplicationBaseModel(CoolipyBaseModel):
    """Shared fields for application create/update request bodies."""

    project_uuid: str | None = None
    server_uuid: str | None = None
    environment_name: str | None = None
    environment_uuid: str | None = None
    git_repository: str | None = None
    git_branch: str | None = None
    build_pack: BuildPack | None = None
    ports_exposes: str | None = None
    destination_uuid: str | None = None
    name: str | None = None
    description: str | None = None
    domains: str | None = None
    noindex_domains: list[str] | None = None
    git_commit_sha: str | None = None
    docker_registry_image_name: str | None = None
    docker_registry_image_tag: str | None = None
    is_static: bool | None = None
    is_spa: bool | None = None
    is_auto_deploy_enabled: bool | None = None
    is_force_https_enabled: bool | None = None
    is_preview_deployments_enabled: bool | None = None
    static_image: str | None = None
    install_command: str | None = None
    build_command: str | None = None
    start_command: str | None = None
    ports_mappings: str | None = None
    base_directory: str | None = None
    publish_directory: str | None = None
    health_check_enabled: bool | None = None
    health_check_path: str | None = None
    health_check_port: str | None = None
    health_check_host: str | None = None
    health_check_method: str | None = None
    health_check_return_code: int | None = None
    health_check_scheme: str | None = None
    health_check_response_text: str | None = None
    health_check_interval: int | None = None
    health_check_timeout: int | None = None
    health_check_retries: int | None = None
    health_check_start_period: int | None = None
    limits_memory: str | None = None
    limits_memory_swap: str | None = None
    limits_memory_swappiness: int | None = None
    limits_memory_reservation: str | None = None
    limits_cpus: str | None = None
    limits_cpuset: str | None = None
    limits_cpu_shares: int | None = None
    custom_labels: str | None = None
    custom_docker_run_options: str | None = None
    post_deployment_command: str | None = None
    post_deployment_command_container: str | None = None
    pre_deployment_command: str | None = None
    pre_deployment_command_container: str | None = None
    manual_webhook_secret_github: str | None = None
    manual_webhook_secret_gitlab: str | None = None
    manual_webhook_secret_bitbucket: str | None = None
    manual_webhook_secret_gitea: str | None = None
    redirect: Redirect | None = None
    instant_deploy: bool | None = None
    dockerfile: str | None = None
    dockerfile_location: str | None = None
    docker_compose_location: str | None = None
    docker_compose_custom_start_command: str | None = None
    docker_compose_custom_build_command: str | None = None
    docker_compose_domains: list[DockerComposeDomain] | None = None
    watch_paths: str | None = None
    use_build_server: bool | None = None
    use_build_secrets: bool | None = None
    is_git_submodules_enabled: bool | None = None
    is_git_lfs_enabled: bool | None = None
    is_git_shallow_clone_enabled: bool | None = None
    disable_build_cache: bool | None = None
    inject_build_args_to_dockerfile: bool | None = None
    include_source_commit_in_build: bool | None = None
    is_env_sorting_enabled: bool | None = None
    is_pr_deployments_public_enabled: bool | None = None
    stop_grace_period: int | None = None
    docker_images_to_keep: int | None = None
    is_gzip_enabled: bool | None = None
    is_stripprefix_enabled: bool | None = None
    is_raw_compose_deployment_enabled: bool | None = None
    is_log_drain_enabled: bool | None = None
    is_gpu_enabled: bool | None = None
    gpu_driver: str | None = None
    gpu_count: str | None = None
    gpu_device_ids: str | None = None
    gpu_options: str | None = None
    is_consistent_container_name_enabled: bool | None = None
    custom_internal_name: str | None = None
    preview_url_template: str | None = None
    max_restart_count: int | None = None
    is_http_basic_auth_enabled: bool | None = None
    http_basic_auth_username: str | None = None
    http_basic_auth_password: str | None = None
    connect_to_docker_network: bool | None = None
    force_domain_override: bool | None = None
    autogenerate_domain: bool | None = None
    is_container_label_escape_enabled: bool | None = None
    tags: list[str] | None = None
    is_preserve_repository_enabled: bool | None = None
    github_app_uuid: str | None = None
    private_key_uuid: str | None = None

Shared fields for application create/update request bodies.

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

Subclasses

• ApplicationDockerImageModelCreate
• ApplicationDockerfileModelCreate
• ApplicationPrivateDeployKeyModelCreate
• ApplicationPrivateGHModelCreate
• ApplicationPublicModelCreate
• ApplicationUpdateModel

Class variables

var autogenerate_domain : bool | None

var base_directory : str | None

var build_command : str | None

var build_pack : BuildPack | None

var connect_to_docker_network : bool | None

var custom_docker_run_options : str | None

var custom_internal_name : str | None

var custom_labels : str | None

var description : str | None

var destination_uuid : str | None

var disable_build_cache : bool | None

var docker_compose_custom_build_command : str | None

var docker_compose_custom_start_command : str | None

var docker_compose_domains : list[DockerComposeDomain] | None

var docker_compose_location : str | None

var docker_images_to_keep : int | None

var docker_registry_image_name : str | None

var docker_registry_image_tag : str | None

var dockerfile : str | None

var dockerfile_location : str | None

var domains : str | None

var environment_name : str | None

var environment_uuid : str | None

var force_domain_override : bool | None

var git_branch : str | None

var git_commit_sha : str | None

var git_repository : str | None

var github_app_uuid : str | None

var gpu_count : str | None

var gpu_device_ids : str | None

var gpu_driver : str | None

var gpu_options : str | None

var health_check_enabled : bool | None

var health_check_host : str | None

var health_check_interval : int | None

var health_check_method : str | None

var health_check_path : str | None

var health_check_port : str | None

var health_check_response_text : str | None

var health_check_retries : int | None

var health_check_return_code : int | None

var health_check_scheme : str | None

var health_check_start_period : int | None

var health_check_timeout : int | None

var http_basic_auth_password : str | None

var http_basic_auth_username : str | None

var include_source_commit_in_build : bool | None

var inject_build_args_to_dockerfile : bool | None

var install_command : str | None

var instant_deploy : bool | None

var is_auto_deploy_enabled : bool | None

var is_consistent_container_name_enabled : bool | None

var is_container_label_escape_enabled : bool | None

var is_env_sorting_enabled : bool | None

var is_force_https_enabled : bool | None

var is_git_lfs_enabled : bool | None

var is_git_shallow_clone_enabled : bool | None

var is_git_submodules_enabled : bool | None

var is_gpu_enabled : bool | None

var is_gzip_enabled : bool | None

var is_http_basic_auth_enabled : bool | None

var is_log_drain_enabled : bool | None

var is_pr_deployments_public_enabled : bool | None

var is_preserve_repository_enabled : bool | None

var is_preview_deployments_enabled : bool | None

var is_raw_compose_deployment_enabled : bool | None

var is_spa : bool | None

var is_static : bool | None

var is_stripprefix_enabled : bool | None

var limits_cpu_shares : int | None

var limits_cpus : str | None

var limits_cpuset : str | None

var limits_memory : str | None

var limits_memory_reservation : str | None

var limits_memory_swap : str | None

var limits_memory_swappiness : int | None

var manual_webhook_secret_bitbucket : str | None

var manual_webhook_secret_gitea : str | None

var manual_webhook_secret_github : str | None

var manual_webhook_secret_gitlab : str | None

var max_restart_count : int | None

var model_config

var name : str | None

var noindex_domains : list[str] | None

var ports_exposes : str | None

var ports_mappings : str | None

var post_deployment_command : str | None

var post_deployment_command_container : str | None

var pre_deployment_command : str | None

var pre_deployment_command_container : str | None

var preview_url_template : str | None

var private_key_uuid : str | None

var project_uuid : str | None

var publish_directory : str | None

var redirect : Redirect | None

var server_uuid : str | None

var start_command : str | None

var static_image : str | None

var stop_grace_period : int | None

var tags : list[str] | None

var use_build_secrets : bool | None

var use_build_server : bool | None

var watch_paths : str | None

class ApplicationDockerImageModelCreate (**data: Any)

Expand source code

class ApplicationDockerImageModelCreate(ApplicationBaseModel):
    """Create an application from a prebuilt Docker image."""

Create an application from a prebuilt Docker image.

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

• ApplicationBaseModel
• CoolipyBaseModel
• pydantic.main.BaseModel

Class variables

var model_config

class ApplicationDockerfileModelCreate (**data: Any)

Expand source code

class ApplicationDockerfileModelCreate(ApplicationBaseModel):
    """Create an application from a Dockerfile."""

Create an application from a Dockerfile.

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

• ApplicationBaseModel
• CoolipyBaseModel
• pydantic.main.BaseModel

Class variables

var model_config

class ApplicationModel (**data: Any)

Expand source code

class ApplicationModel(CoolipyBaseModel):
    """An application as returned by the API."""

    id: int | None = None
    description: str | None = None
    repository_project_id: int | None = None
    uuid: str | None = None
    name: str | None = None
    fqdn: str | None = None
    noindex_domains: list[str] | None = None
    config_hash: str | None = None
    git_repository: str | None = None
    git_branch: str | None = None
    git_commit_sha: str | None = None
    git_full_url: str | None = None
    docker_registry_image_name: str | None = None
    docker_registry_image_tag: str | None = None
    build_pack: str | None = None
    static_image: str | None = None
    install_command: str | None = None
    build_command: str | None = None
    start_command: str | None = None
    ports_exposes: str | None = None
    ports_mappings: str | None = None
    custom_network_aliases: str | None = None
    base_directory: str | None = None
    publish_directory: str | None = None
    health_check_enabled: bool | None = None
    health_check_path: str | None = None
    health_check_port: str | None = None
    health_check_host: str | None = None
    health_check_method: str | None = None
    health_check_return_code: int | None = None
    health_check_scheme: str | None = None
    health_check_response_text: str | None = None
    health_check_interval: int | None = None
    health_check_timeout: int | None = None
    health_check_retries: int | None = None
    health_check_start_period: int | None = None
    health_check_type: str | None = None
    health_check_command: str | None = None
    limits_memory: str | None = None
    limits_memory_swap: str | None = None
    limits_memory_swappiness: int | None = None
    limits_memory_reservation: str | None = None
    limits_cpus: str | None = None
    limits_cpuset: str | None = None
    limits_cpu_shares: int | None = None
    status: str | None = None
    preview_url_template: str | None = None
    max_restart_count: int | None = None
    destination_type: str | None = None
    destination_id: int | None = None
    source_id: int | None = None
    private_key_id: int | None = None
    environment_id: int | None = None
    dockerfile: str | None = None
    dockerfile_location: str | None = None
    custom_labels: str | None = None
    dockerfile_target_build: str | None = None
    manual_webhook_secret_github: str | None = None
    manual_webhook_secret_gitlab: str | None = None
    manual_webhook_secret_bitbucket: str | None = None
    manual_webhook_secret_gitea: str | None = None
    docker_compose_location: str | None = None
    docker_compose: str | None = None
    docker_compose_raw: str | None = None
    docker_compose_domains: str | None = None
    docker_compose_custom_start_command: str | None = None
    docker_compose_custom_build_command: str | None = None
    swarm_replicas: int | None = None
    swarm_placement_constraints: str | None = None
    custom_docker_run_options: str | None = None
    post_deployment_command: str | None = None
    post_deployment_command_container: str | None = None
    pre_deployment_command: str | None = None
    pre_deployment_command_container: str | None = None
    watch_paths: str | None = None
    custom_healthcheck_found: bool | None = None
    redirect: str | None = None
    created_at: datetime | None = None
    updated_at: datetime | None = None
    deleted_at: datetime | None = None
    compose_parsing_version: str | None = None
    custom_nginx_configuration: str | None = None
    is_http_basic_auth_enabled: bool | None = None
    http_basic_auth_username: str | None = None
    http_basic_auth_password: str | None = None
    settings: ApplicationSetting | None = None

An application 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 base_directory : str | None

var build_command : str | None

var build_pack : str | None

var compose_parsing_version : str | None

var config_hash : str | None

var created_at : datetime.datetime | None

var custom_docker_run_options : str | None

var custom_healthcheck_found : bool | None

var custom_labels : str | None

var custom_network_aliases : str | None

var custom_nginx_configuration : str | 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_custom_build_command : str | None

var docker_compose_custom_start_command : str | None

var docker_compose_domains : str | None

var docker_compose_location : str | None

var docker_compose_raw : str | None

var docker_registry_image_name : str | None

var docker_registry_image_tag : str | None

var dockerfile : str | None

var dockerfile_location : str | None

var dockerfile_target_build : str | None

var environment_id : int | None

var fqdn : str | None

var git_branch : str | None

var git_commit_sha : str | None

var git_full_url : str | None

var git_repository : str | None

var health_check_command : str | None

var health_check_enabled : bool | None

var health_check_host : str | None

var health_check_interval : int | None

var health_check_method : str | None

var health_check_path : str | None

var health_check_port : str | None

var health_check_response_text : str | None

var health_check_retries : int | None

var health_check_return_code : int | None

var health_check_scheme : str | None

var health_check_start_period : int | None

var health_check_timeout : int | None

var health_check_type : str | None

var http_basic_auth_password : str | None

var http_basic_auth_username : str | None

var id : int | None

var install_command : str | None

var is_http_basic_auth_enabled : bool | None

var limits_cpu_shares : int | None

var limits_cpus : str | None

var limits_cpuset : str | None

var limits_memory : str | None

var limits_memory_reservation : str | None

var limits_memory_swap : str | None

var limits_memory_swappiness : int | None

var manual_webhook_secret_bitbucket : str | None

var manual_webhook_secret_gitea : str | None

var manual_webhook_secret_github : str | None

var manual_webhook_secret_gitlab : str | None

var max_restart_count : int | None

var model_config

var name : str | None

var noindex_domains : list[str] | None

var ports_exposes : str | None

var ports_mappings : str | None

var post_deployment_command : str | None

var post_deployment_command_container : str | None

var pre_deployment_command : str | None

var pre_deployment_command_container : str | None

var preview_url_template : str | None

var private_key_id : int | None

var publish_directory : str | None

var redirect : str | None

var repository_project_id : int | None

var settings : ApplicationSetting | None

var source_id : int | None

var start_command : str | None

var static_image : str | None

var status : str | None

var swarm_placement_constraints : str | None

var swarm_replicas : int | None

var updated_at : datetime.datetime | None

var uuid : str | None

var watch_paths : str | None

class ApplicationPrivateDeployKeyModelCreate (**data: Any)

Expand source code

class ApplicationPrivateDeployKeyModelCreate(ApplicationBaseModel):
    """Create an application from a private repository via a deploy key."""

Create an application from a private repository via a deploy key.

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

• ApplicationBaseModel
• CoolipyBaseModel
• pydantic.main.BaseModel

Class variables

var model_config

class ApplicationPrivateGHModelCreate (**data: Any)

Expand source code

class ApplicationPrivateGHModelCreate(ApplicationBaseModel):
    """Create an application from a private repository via a GitHub App."""

Create an application from a private repository via a GitHub App.

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

• ApplicationBaseModel
• CoolipyBaseModel
• pydantic.main.BaseModel

Class variables

var model_config

class ApplicationPublicModelCreate (**data: Any)

Expand source code

class ApplicationPublicModelCreate(ApplicationBaseModel):
    """Create an application from a public git repository."""

Create an application from a public git repository.

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

• ApplicationBaseModel
• CoolipyBaseModel
• pydantic.main.BaseModel

Class variables

var model_config

class ApplicationSetting (**data: Any)

Expand source code

class ApplicationSetting(CoolipyBaseModel):
    """Application settings returned as part of an application model."""

    is_static: bool | None = None
    is_git_submodules_enabled: bool | None = None
    is_git_lfs_enabled: bool | None = None
    is_auto_deploy_enabled: bool | None = None
    is_force_https_enabled: bool | None = None
    is_debug_enabled: bool | None = None
    is_preview_deployments_enabled: bool | None = None
    is_log_drain_enabled: bool | None = None
    is_gpu_enabled: bool | None = None
    gpu_driver: str | None = None
    gpu_count: str | None = None
    gpu_device_ids: str | None = None
    gpu_options: str | None = None
    is_include_timestamps: bool | None = None
    is_swarm_only_worker_nodes: bool | None = None
    is_raw_compose_deployment_enabled: bool | None = None
    is_build_server_enabled: bool | None = None
    is_consistent_container_name_enabled: bool | None = None
    is_gzip_enabled: bool | None = None
    is_stripprefix_enabled: bool | None = None
    connect_to_docker_network: bool | None = None
    custom_internal_name: str | None = None
    is_container_label_escape_enabled: bool | None = None
    is_env_sorting_enabled: bool | None = None
    is_container_label_readonly_enabled: bool | None = None
    is_preserve_repository_enabled: bool | None = None
    disable_build_cache: bool | None = None
    is_spa: bool | None = None
    is_git_shallow_clone_enabled: bool | None = None
    is_pr_deployments_public_enabled: bool | None = None
    use_build_secrets: bool | None = None
    inject_build_args_to_dockerfile: bool | None = None
    include_source_commit_in_build: bool | None = None
    docker_images_to_keep: int | None = None
    stop_grace_period: int | None = None

Application settings returned as part of an application model.

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 connect_to_docker_network : bool | None

var custom_internal_name : str | None

var disable_build_cache : bool | None

var docker_images_to_keep : int | None

var gpu_count : str | None

var gpu_device_ids : str | None

var gpu_driver : str | None

var gpu_options : str | None

var include_source_commit_in_build : bool | None

var inject_build_args_to_dockerfile : bool | None

var is_auto_deploy_enabled : bool | None

var is_build_server_enabled : bool | None

var is_consistent_container_name_enabled : bool | None

var is_container_label_escape_enabled : bool | None

var is_container_label_readonly_enabled : bool | None

var is_debug_enabled : bool | None

var is_env_sorting_enabled : bool | None

var is_force_https_enabled : bool | None

var is_git_lfs_enabled : bool | None

var is_git_shallow_clone_enabled : bool | None

var is_git_submodules_enabled : bool | None

var is_gpu_enabled : bool | None

var is_gzip_enabled : bool | None

var is_include_timestamps : bool | None

var is_log_drain_enabled : bool | None

var is_pr_deployments_public_enabled : bool | None

var is_preserve_repository_enabled : bool | None

var is_preview_deployments_enabled : bool | None

var is_raw_compose_deployment_enabled : bool | None

var is_spa : bool | None

var is_static : bool | None

var is_stripprefix_enabled : bool | None

var is_swarm_only_worker_nodes : bool | None

var model_config

var stop_grace_period : int | None

var use_build_secrets : bool | None

class ApplicationUpdateModel (**data: Any)

Expand source code

class ApplicationUpdateModel(ApplicationBaseModel):
    """Body for updating an application."""

Body for updating an application.

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

• ApplicationBaseModel
• CoolipyBaseModel
• pydantic.main.BaseModel

Class variables

var model_config

class DockerComposeDomain (**data: Any)

Expand source code

class DockerComposeDomain(CoolipyBaseModel):
    """A per-service domain mapping for docker-compose applications."""

    name: str | None = None
    domain: str | None = None
    redirect: Redirect | None = None

A per-service domain mapping for docker-compose applications.

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

var model_config

var name : str | None

var redirect : Redirect | None