coolipy.resources.security

Security (private keys) resource clients (sync + async).

Classes

class AsyncSecurity (transport: AsyncTransport)

Expand source code

class AsyncSecurity(AsyncResourceBase):
    """Asynchronous client for Coolify private keys."""

    async def list(self) -> CoolipyAPIResponse[PrivateKeyList]:
        """List all private keys."""
        return await self._get("/security/keys", response_model=list[PrivateKeyModel])

    async def get(self, uuid: str) -> CoolipyAPIResponse[PrivateKeyModel]:
        """Get a private key by UUID."""
        return await self._get(f"/security/keys/{uuid}", response_model=PrivateKeyModel)

    async def create(self, model: PrivateKeyCreateModel) -> CoolipyAPIResponse[UUIDResponse]:
        """Create a private key."""
        return await self._post("/security/keys", json=_dump(model), response_model=UUIDResponse)

    async def update(
        self, uuid: str, model: PrivateKeyUpdateModel
    ) -> CoolipyAPIResponse[UUIDResponse]:
        """Update a private key by UUID."""
        return await self._patch(
            f"/security/keys/{uuid}", json=_dump(model), response_model=UUIDResponse
        )

    async def delete(self, uuid: str) -> CoolipyAPIResponse[MessageResponse]:
        """Delete a private key by UUID."""
        return await self._delete(f"/security/keys/{uuid}", response_model=MessageResponse)

Asynchronous client for Coolify private keys.

Ancestors

• coolipy._base.AsyncResourceBase

Methods

async def create(self, model: PrivateKeyCreateModel) ‑> coolipy._response.CoolipyAPIResponse[UUIDResponse]

Expand source code

async def create(self, model: PrivateKeyCreateModel) -> CoolipyAPIResponse[UUIDResponse]:
    """Create a private key."""
    return await self._post("/security/keys", json=_dump(model), response_model=UUIDResponse)

Create a private key.

async def delete(self, uuid: str) ‑> coolipy._response.CoolipyAPIResponse[MessageResponse]

Expand source code

async def delete(self, uuid: str) -> CoolipyAPIResponse[MessageResponse]:
    """Delete a private key by UUID."""
    return await self._delete(f"/security/keys/{uuid}", response_model=MessageResponse)

Delete a private key by UUID.

async def get(self, uuid: str) ‑> coolipy._response.CoolipyAPIResponse[PrivateKeyModel]

Expand source code

async def get(self, uuid: str) -> CoolipyAPIResponse[PrivateKeyModel]:
    """Get a private key by UUID."""
    return await self._get(f"/security/keys/{uuid}", response_model=PrivateKeyModel)

Get a private key by UUID.

async def list(self) ‑> coolipy._response.CoolipyAPIResponse[list[PrivateKeyModel]]

Expand source code

async def list(self) -> CoolipyAPIResponse[PrivateKeyList]:
    """List all private keys."""
    return await self._get("/security/keys", response_model=list[PrivateKeyModel])

List all private keys.

async def update(self, uuid: str, model: PrivateKeyUpdateModel) ‑> coolipy._response.CoolipyAPIResponse[UUIDResponse]

Expand source code

async def update(
    self, uuid: str, model: PrivateKeyUpdateModel
) -> CoolipyAPIResponse[UUIDResponse]:
    """Update a private key by UUID."""
    return await self._patch(
        f"/security/keys/{uuid}", json=_dump(model), response_model=UUIDResponse
    )

Update a private key by UUID.

class Security (transport: SyncTransport)

Expand source code

class Security(ResourceBase):
    """Synchronous client for Coolify private keys."""

    def list(self) -> CoolipyAPIResponse[PrivateKeyList]:
        """List all private keys."""
        return self._get("/security/keys", response_model=list[PrivateKeyModel])

    def get(self, uuid: str) -> CoolipyAPIResponse[PrivateKeyModel]:
        """Get a private key by UUID."""
        return self._get(f"/security/keys/{uuid}", response_model=PrivateKeyModel)

    def create(self, model: PrivateKeyCreateModel) -> CoolipyAPIResponse[UUIDResponse]:
        """Create a private key."""
        return self._post("/security/keys", json=_dump(model), response_model=UUIDResponse)

    def update(self, uuid: str, model: PrivateKeyUpdateModel) -> CoolipyAPIResponse[UUIDResponse]:
        """Update a private key by UUID."""
        return self._patch(f"/security/keys/{uuid}", json=_dump(model), response_model=UUIDResponse)

    def delete(self, uuid: str) -> CoolipyAPIResponse[MessageResponse]:
        """Delete a private key by UUID."""
        return self._delete(f"/security/keys/{uuid}", response_model=MessageResponse)

Synchronous client for Coolify private keys.

Ancestors

• coolipy._base.ResourceBase

Methods

def create(self, model: PrivateKeyCreateModel) ‑> coolipy._response.CoolipyAPIResponse[UUIDResponse]

Expand source code

def create(self, model: PrivateKeyCreateModel) -> CoolipyAPIResponse[UUIDResponse]:
    """Create a private key."""
    return self._post("/security/keys", json=_dump(model), response_model=UUIDResponse)

Create a private key.

def delete(self, uuid: str) ‑> coolipy._response.CoolipyAPIResponse[MessageResponse]

Expand source code

def delete(self, uuid: str) -> CoolipyAPIResponse[MessageResponse]:
    """Delete a private key by UUID."""
    return self._delete(f"/security/keys/{uuid}", response_model=MessageResponse)

Delete a private key by UUID.

def get(self, uuid: str) ‑> coolipy._response.CoolipyAPIResponse[PrivateKeyModel]

Expand source code

def get(self, uuid: str) -> CoolipyAPIResponse[PrivateKeyModel]:
    """Get a private key by UUID."""
    return self._get(f"/security/keys/{uuid}", response_model=PrivateKeyModel)

Get a private key by UUID.

def list(self) ‑> coolipy._response.CoolipyAPIResponse[list[PrivateKeyModel]]

Expand source code

def list(self) -> CoolipyAPIResponse[PrivateKeyList]:
    """List all private keys."""
    return self._get("/security/keys", response_model=list[PrivateKeyModel])

List all private keys.

def update(self, uuid: str, model: PrivateKeyUpdateModel) ‑> coolipy._response.CoolipyAPIResponse[UUIDResponse]

Expand source code

def update(self, uuid: str, model: PrivateKeyUpdateModel) -> CoolipyAPIResponse[UUIDResponse]:
    """Update a private key by UUID."""
    return self._patch(f"/security/keys/{uuid}", json=_dump(model), response_model=UUIDResponse)

Update a private key by UUID.