coolipy.models.common

Shared models reused across multiple coolipy resources.

Classes

class BulkEnvsUpdate (**data: Any)
Expand source code 
class BulkEnvsUpdate(CoolipyBaseModel):
    """Body for bulk-updating environment variables."""

    data: list[EnvironmentVariableCreate] = Field(default_factory=list)

Body for bulk-updating environment variables.

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

Class variables

var data : list[EnvironmentVariableCreate]
var model_config
class DeploymentQueuedResponse (**data: Any)
Expand source code 
class DeploymentQueuedResponse(CoolipyBaseModel):
    """A response indicating a deployment was queued."""

    message: str | None = None
    deployment_uuid: str | None = None

A response indicating a deployment was queued.

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

Class variables

var deployment_uuid : str | None
var message : str | None
var model_config
class Destination (**data: Any)
Expand source code 
class Destination(CoolipyBaseModel):
    """A Docker network destination attached to a server."""

    uuid: str | None = None
    name: str | None = None
    network: str | None = None
    type: str | None = None
    server_uuid: str | None = None
    created_at: datetime | None = None
    updated_at: datetime | None = None

A Docker network destination attached to 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

Class variables

var created_at : datetime.datetime | None
var model_config
var name : str | None
var network : str | None
var server_uuid : str | None
var type : str | None
var updated_at : datetime.datetime | None
var uuid : str | None
class DestinationCreate (**data: Any)
Expand source code 
class DestinationCreate(CoolipyBaseModel):
    """Body for creating a destination."""

    name: str | None = None
    network: str | None = None
    type: str | None = None

Body for creating a destination.

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

Class variables

var model_config
var name : str | None
var network : str | None
var type : str | None
class EnvironmentVariable (**data: Any)
Expand source code 
class EnvironmentVariable(CoolipyBaseModel):
    """An environment variable as returned by the API."""

    id: int | None = None
    uuid: str | None = None
    resourceable_type: str | None = None
    resourceable_id: int | None = None
    is_literal: bool | None = None
    is_multiline: bool | None = None
    is_preview: bool | None = None
    is_runtime: bool | None = None
    is_buildtime: bool | None = None
    is_shared: bool | None = None
    is_shown_once: bool | None = None
    key: str | None = None
    value: str | None = None
    real_value: str | None = None
    comment: str | None = None
    version: str | None = None
    created_at: datetime | None = None
    updated_at: datetime | None = None

An environment variable 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

Class variables

var comment : str | None
var created_at : datetime.datetime | None
var id : int | None
var is_buildtime : bool | None
var is_literal : bool | None
var is_multiline : bool | None
var is_preview : bool | None
var is_runtime : bool | None
var is_shared : bool | None
var is_shown_once : bool | None
var key : str | None
var model_config
var real_value : str | None
var resourceable_id : int | None
var resourceable_type : str | None
var updated_at : datetime.datetime | None
var uuid : str | None
var value : str | None
var version : str | None
class EnvironmentVariableCreate (**data: Any)
Expand source code 
class EnvironmentVariableCreate(CoolipyBaseModel):
    """Body for creating an environment variable."""

    key: str | None = None
    value: str | None = None
    is_preview: bool | None = None
    is_literal: bool | None = None
    is_multiline: bool | None = None
    is_shown_once: bool | None = None

Body for creating an environment variable.

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

Class variables

var is_literal : bool | None
var is_multiline : bool | None
var is_preview : bool | None
var is_shown_once : bool | None
var key : str | None
var model_config
var value : str | None
class EnvironmentVariableUpdate (**data: Any)
Expand source code 
class EnvironmentVariableUpdate(CoolipyBaseModel):
    """Body for updating an environment variable."""

    key: str | None = None
    value: str | None = None
    is_preview: bool | None = None
    is_literal: bool | None = None
    is_multiline: bool | None = None
    is_shown_once: bool | None = None

Body for updating an environment variable.

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

Class variables

var is_literal : bool | None
var is_multiline : bool | None
var is_preview : bool | None
var is_shown_once : bool | None
var key : str | None
var model_config
var value : str | None
class Logs (**data: Any)
Expand source code 
class Logs(CoolipyBaseModel):
    """Log output returned by a logs endpoint."""

    logs: str | None = None

Log output returned by a logs endpoint.

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

Class variables

var logs : str | None
var model_config
class MessageResponse (**data: Any)
Expand source code 
class MessageResponse(CoolipyBaseModel):
    """A response carrying a single ``message``."""

    message: str | None = None

A response carrying a single message.

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

Class variables

var message : str | None
var model_config
class ScheduledTask (**data: Any)
Expand source code 
class ScheduledTask(CoolipyBaseModel):
    """A scheduled task as returned by the API."""

    id: int | None = None
    uuid: str | None = None
    enabled: bool | None = None
    name: str | None = None
    command: str | None = None
    frequency: str | None = None
    container: str | None = None
    timeout: int | None = None
    created_at: datetime | None = None
    updated_at: datetime | None = None

A scheduled task 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

Class variables

var command : str | None
var container : str | None
var created_at : datetime.datetime | None
var enabled : bool | None
var frequency : str | None
var id : int | None
var model_config
var name : str | None
var timeout : int | None
var updated_at : datetime.datetime | None
var uuid : str | None
class ScheduledTaskCreate (**data: Any)
Expand source code 
class ScheduledTaskCreate(CoolipyBaseModel):
    """Body for creating a scheduled task."""

    enabled: bool | None = None
    name: str | None = None
    command: str | None = None
    frequency: str | None = None
    container: str | None = None
    timeout: int | None = None

Body for creating a scheduled task.

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

Class variables

var command : str | None
var container : str | None
var enabled : bool | None
var frequency : str | None
var model_config
var name : str | None
var timeout : int | None
class ScheduledTaskExecution (**data: Any)
Expand source code 
class ScheduledTaskExecution(CoolipyBaseModel):
    """An execution of a scheduled task."""

    uuid: str | None = None
    status: str | None = None
    message: str | None = None
    retry_count: int | None = None
    duration: float | None = None
    started_at: datetime | None = None
    finished_at: datetime | None = None
    created_at: datetime | None = None
    updated_at: datetime | None = None

An execution of a scheduled task.

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

Class variables

var created_at : datetime.datetime | None
var duration : float | None
var finished_at : datetime.datetime | None
var message : str | None
var model_config
var retry_count : int | None
var started_at : datetime.datetime | None
var status : str | None
var updated_at : datetime.datetime | None
var uuid : str | None
class ScheduledTaskUpdate (**data: Any)
Expand source code 
class ScheduledTaskUpdate(CoolipyBaseModel):
    """Body for updating a scheduled task."""

    enabled: bool | None = None
    name: str | None = None
    command: str | None = None
    frequency: str | None = None
    container: str | None = None
    timeout: int | None = None

Body for updating a scheduled task.

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

Class variables

var command : str | None
var container : str | None
var enabled : bool | None
var frequency : str | None
var model_config
var name : str | None
var timeout : int | None
class StorageCreate (**data: Any)
Expand source code 
class StorageCreate(CoolipyBaseModel):
    """Body for creating a persistent or file storage."""

    type: str | None = None
    name: str | None = None
    mount_path: str | None = None
    host_path: str | None = None
    content: str | None = None
    is_directory: bool | None = None
    fs_path: str | None = None

Body for creating a persistent or file storage.

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

Class variables

var content : str | None
var fs_path : str | None
var host_path : str | None
var is_directory : bool | None
var model_config
var mount_path : str | None
var name : str | None
var type : str | None
class StorageUpdate (**data: Any)
Expand source code 
class StorageUpdate(CoolipyBaseModel):
    """Body for updating a persistent or file storage."""

    uuid: str | None = None
    id: int | None = None
    type: str | None = None
    is_preview_suffix_enabled: bool | None = None
    name: str | None = None
    mount_path: str | None = None
    host_path: str | None = None
    content: str | None = None

Body for updating a persistent or file storage.

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

Class variables

var content : str | None
var host_path : str | None
var id : int | None
var is_preview_suffix_enabled : bool | None
var model_config
var mount_path : str | None
var name : str | None
var type : str | None
var uuid : str | None
class Tag (**data: Any)
Expand source code 
class Tag(CoolipyBaseModel):
    """A tag attached to a resource."""

    uuid: str | None = None
    name: str | None = None
    created_at: datetime | None = None
    updated_at: datetime | None = None

A tag attached to a resource.

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

Class variables

var created_at : datetime.datetime | None
var model_config
var name : str | None
var updated_at : datetime.datetime | None
var uuid : str | None
class TagCreate (**data: Any)
Expand source code 
class TagCreate(CoolipyBaseModel):
    """Body for creating a global tag."""

    name: str | None = None

Body for creating a global tag.

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

Class variables

var model_config
var name : str | None
class TagUpdate (**data: Any)
Expand source code 
class TagUpdate(CoolipyBaseModel):
    """Body for updating a global tag."""

    name: str | None = None

Body for updating a global tag.

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

Class variables

var model_config
var name : str | None
class TagsCreate (**data: Any)
Expand source code 
class TagsCreate(CoolipyBaseModel):
    """Body for adding one or more tags to a resource."""

    tag_name: str | None = None
    tag_names: list[str] | None = None

Body for adding one or more tags to a resource.

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

Class variables

var model_config
var tag_name : str | None
var tag_names : list[str] | None
class UUIDResponse (**data: Any)
Expand source code 
class UUIDResponse(CoolipyBaseModel):
    """A response carrying a single ``uuid``."""

    uuid: str | None = None

A response carrying a single uuid.

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

Class variables

var model_config
var uuid : str | None
class VolumeBackupScheduleRequest (**data: Any)
Expand source code 
class VolumeBackupScheduleRequest(CoolipyBaseModel):
    """Body for scheduling volume backups."""

    frequency: str | None = None
    enabled: bool | None = None
    save_s3: bool | None = None
    disable_local_backup: bool | None = None
    stop_during_backup: bool | None = None
    s3_storage_uuid: str | None = None
    retention_amount_locally: int | None = None
    retention_days_locally: int | None = None
    retention_max_storage_locally: float | None = None
    retention_amount_s3: int | None = None
    retention_days_s3: int | None = None
    retention_max_storage_s3: float | None = None
    timeout: int | None = None

Body for scheduling volume backups.

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

Class variables

var disable_local_backup : bool | None
var enabled : bool | None
var frequency : str | None
var model_config
var retention_amount_locally : int | None
var retention_amount_s3 : int | None
var retention_days_locally : int | None
var retention_days_s3 : int | None
var retention_max_storage_locally : float | None
var retention_max_storage_s3 : float | None
var s3_storage_uuid : str | None
var save_s3 : bool | None
var stop_during_backup : bool | None
var timeout : int | None
class VolumeBackupScheduleResponse (**data: Any)
Expand source code 
class VolumeBackupScheduleResponse(CoolipyBaseModel):
    """A scheduled volume backup as returned by the API."""

    uuid: str | None = None
    message: str | None = None
    storage_uuid: str | None = None
    storage_type: str | None = None
    frequency: str | None = None
    enabled: bool | None = None
    save_s3: bool | None = None
    disable_local_backup: bool | None = None
    stop_during_backup: bool | None = None
    s3_storage_uuid: str | None = None
    retention_amount_locally: int | None = None
    retention_days_locally: int | None = None
    retention_max_storage_locally: float | None = None
    retention_amount_s3: int | None = None
    retention_days_s3: int | None = None
    retention_max_storage_s3: float | None = None
    timeout: int | None = None

A scheduled volume backup 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

Class variables

var disable_local_backup : bool | None
var enabled : bool | None
var frequency : str | None
var message : str | None
var model_config
var retention_amount_locally : int | None
var retention_amount_s3 : int | None
var retention_days_locally : int | None
var retention_days_s3 : int | None
var retention_max_storage_locally : float | None
var retention_max_storage_s3 : float | None
var s3_storage_uuid : str | None
var save_s3 : bool | None
var stop_during_backup : bool | None
var storage_type : str | None
var storage_uuid : str | None
var timeout : int | None
var uuid : str | None