coolipy.models.servers

Server models for the Coolify API.

Classes

class ServerCreateModel (**data: Any)

Expand source code

class ServerCreateModel(CoolipyBaseModel):
    """Body for creating a server."""

    name: str | None = None
    description: str | None = None
    ip: str | None = None
    port: int | None = None
    user: str | None = None
    private_key_uuid: str | None = None
    is_build_server: bool | None = None
    instant_validate: bool | None = None
    proxy_type: ProxyType | None = None

Body for creating a server.

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

var ip : str | None

var is_build_server : bool | None

var model_config

var name : str | None

var port : int | None

var private_key_uuid : str | None

var proxy_type : ProxyType | None

var user : str | None

class ServerModel (**data: Any)

Expand source code

class ServerModel(CoolipyBaseModel):
    """A server as returned by the API."""

    id: int | None = None
    uuid: str | None = None
    name: str | None = None
    description: str | None = None
    ip: str | None = None
    user: str | None = None
    port: int | None = None
    proxy: dict | None = None
    proxy_type: str | None = None
    is_coolify_host: bool | None = None
    is_reachable: bool | None = None
    is_usable: bool | None = None
    high_disk_usage_notification_sent: bool | None = None
    unreachable_notification_sent: bool | None = None
    unreachable_count: int | None = None
    validation_logs: str | None = None
    log_drain_notification_sent: bool | None = None
    swarm_cluster: str | None = None
    settings: ServerSetting | None = None

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

var high_disk_usage_notification_sent : bool | None

var id : int | None

var ip : str | None

var is_coolify_host : bool | None

var is_reachable : bool | None

var is_usable : bool | None

var log_drain_notification_sent : bool | None

var model_config

var name : str | None

var port : int | None

var proxy : dict | None

var proxy_type : str | None

var settings : ServerSetting | None

var swarm_cluster : str | None

var unreachable_count : int | None

var unreachable_notification_sent : bool | None

var user : str | None

var uuid : str | None

var validation_logs : str | None

class ServerSetting (**data: Any)

Expand source code

class ServerSetting(CoolipyBaseModel):
    """Server settings returned as part of a server model."""

    id: int | None = None
    concurrent_builds: int | None = None
    deployment_queue_limit: int | None = None
    dynamic_timeout: int | None = None
    force_disabled: bool | None = None
    force_server_cleanup: bool | None = None
    is_build_server: bool | None = None
    is_cloudflare_tunnel: bool | None = None
    is_jump_server: bool | None = None
    is_logdrain_axiom_enabled: bool | None = None
    is_logdrain_custom_enabled: bool | None = None
    is_logdrain_highlight_enabled: bool | None = None
    is_logdrain_newrelic_enabled: bool | None = None
    is_metrics_enabled: bool | None = None
    is_reachable: bool | None = None
    is_sentinel_enabled: bool | None = None
    is_swarm_manager: bool | None = None
    is_swarm_worker: bool | None = None
    is_terminal_enabled: bool | None = None
    is_usable: bool | None = None
    logdrain_axiom_api_key: str | None = None
    logdrain_axiom_dataset_name: str | None = None
    logdrain_custom_config: str | None = None
    logdrain_custom_config_parser: str | None = None
    logdrain_highlight_project_id: str | None = None
    logdrain_newrelic_base_uri: str | None = None
    logdrain_newrelic_license_key: str | None = None
    sentinel_metrics_history_days: int | None = None
    sentinel_metrics_refresh_rate_seconds: int | None = None
    sentinel_token: str | None = None
    docker_cleanup_frequency: str | None = None
    docker_cleanup_threshold: int | None = None
    server_id: int | None = None
    wildcard_domain: str | None = None
    created_at: datetime | None = None
    updated_at: datetime | None = None
    delete_unused_volumes: bool | None = None
    delete_unused_networks: bool | None = None
    connection_timeout: int | None = None

Server settings returned as part of a server 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 concurrent_builds : int | None

var connection_timeout : int | None

var created_at : datetime.datetime | None

var delete_unused_networks : bool | None

var delete_unused_volumes : bool | None

var deployment_queue_limit : int | None

var docker_cleanup_frequency : str | None

var docker_cleanup_threshold : int | None

var dynamic_timeout : int | None

var force_disabled : bool | None

var force_server_cleanup : bool | None

var id : int | None

var is_build_server : bool | None

var is_cloudflare_tunnel : bool | None

var is_jump_server : bool | None

var is_logdrain_axiom_enabled : bool | None

var is_logdrain_custom_enabled : bool | None

var is_logdrain_highlight_enabled : bool | None

var is_logdrain_newrelic_enabled : bool | None

var is_metrics_enabled : bool | None

var is_reachable : bool | None

var is_sentinel_enabled : bool | None

var is_swarm_manager : bool | None

var is_swarm_worker : bool | None

var is_terminal_enabled : bool | None

var is_usable : bool | None

var logdrain_axiom_api_key : str | None

var logdrain_axiom_dataset_name : str | None

var logdrain_custom_config : str | None

var logdrain_custom_config_parser : str | None

var logdrain_highlight_project_id : str | None

var logdrain_newrelic_base_uri : str | None

var logdrain_newrelic_license_key : str | None

var model_config

var sentinel_metrics_history_days : int | None

var sentinel_metrics_refresh_rate_seconds : int | None

var sentinel_token : str | None

var server_id : int | None

var updated_at : datetime.datetime | None

var wildcard_domain : str | None

class ServerUpdateModel (**data: Any)

Expand source code

class ServerUpdateModel(CoolipyBaseModel):
    """Body for updating a server."""

    name: str | None = None
    description: str | None = None
    ip: str | None = None
    port: int | None = None
    user: str | None = None
    private_key_uuid: str | None = None
    is_build_server: bool | None = None
    instant_validate: bool | None = None
    proxy_type: ProxyType | None = None
    concurrent_builds: int | None = None
    dynamic_timeout: int | None = None
    deployment_queue_limit: int | None = None
    server_disk_usage_notification_threshold: int | None = None
    server_disk_usage_check_frequency: str | None = None
    connection_timeout: int | None = None

Body for updating a server.

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 concurrent_builds : int | None

var connection_timeout : int | None

var deployment_queue_limit : int | None

var description : str | None

var dynamic_timeout : int | None

var instant_validate : bool | None

var ip : str | None

var is_build_server : bool | None

var model_config

var name : str | None

var port : int | None

var private_key_uuid : str | None

var proxy_type : ProxyType | None

var server_disk_usage_check_frequency : str | None

var server_disk_usage_notification_threshold : int | None

var user : str | None