Clever Cloud DeleteDrain

Clever Cloud DeleteDrain
Certified
Delete a Clever Cloud log drain

Deletes a log drain via DELETE /v4/drains/organisations/{organisationId}/applications/{applicationId}/drains/{drainId}.

organisationId is always required here: unlike the rest of this plugin, the v4 drains API has no /self shortcut for personal accounts.

yaml
type: io.kestra.plugin.clevercloud.logs.DeleteDrain

Examples

Delete a log drain

yaml
id: teardown_log_drain
namespace: company.team

tasks:
  - id: delete_drain
    type: io.kestra.plugin.clevercloud.logs.DeleteDrain
    apiToken: "{{ secret('CC_API_TOKEN') }}"
    organisationId: "orga_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    applicationId: "app_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    drainId: "{{ outputs.create_drain.id }}"

Properties

apiToken *string

API token

Bearer token for the Clever Cloud API. Store as a Kestra secret and reference with {{ secret('CC_API_TOKEN') }}.

applicationId *string

Application ID

drainId *string

Log drain ID to delete

organisationId *string

Organisation ID

The Clever Cloud organisation or personal account ID that owns the application (orga_xxx or user_xxx). Unlike the rest of this plugin, the v4 logs and log drain APIs have no /self shortcut, so this is always required.

options

HTTP client options

Optional HttpConfiguration applied to every Clever Cloud API call, including timeouts and proxy settings.

Definitions

io.kestra.core.http.client.configurations.HttpConfiguration

allowFailedbooleanstring

Defaultfalse

If true, allow a failed response code (response code >= 400)

allowedResponseCodesarray

SubTypeinteger

List of response code allowed for this request

auth

The authentication to use.

io.kestra.core.http.client.configurations.BasicAuthConfiguration

type*object

passwordstring

The password for HTTP basic authentication.

usernamestring

The username for HTTP basic authentication.

io.kestra.core.http.client.configurations.BearerAuthConfiguration

type*object

tokenstring

The token for bearer token authentication.

io.kestra.core.http.client.configurations.DigestAuthConfiguration

type*object

passwordstring

The password for HTTP Digest authentication.

usernamestring

The username for HTTP Digest authentication.

defaultCharsetstring

DefaultUTF-8

The default charset for the request.

java.nio.charset.Charset

enabledTcpExtendedKeepAlivebooleanstring

Defaulttrue

Whether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).

Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.

followRedirectsbooleanstring

Defaulttrue

Whether redirects should be followed automatically.

logsarray

SubTypestring

Possible Values

REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODY

The enabled log.

proxy

The proxy configuration.

io.kestra.core.http.client.configurations.ProxyConfiguration

addressstring

The address of the proxy server.

passwordstring

The password for proxy authentication.

portintegerstring

The port of the proxy server.

typestring

DefaultDIRECT

Possible Values

DIRECTHTTPSOCKS

The type of proxy to use.

usernamestring

The username for proxy authentication.

ssl

The SSL request options

io.kestra.core.http.client.configurations.SslOptions

insecureTrustAllCertificatesbooleanstring

Whether to disable checking of the remote SSL certificate.

Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.

timeout

The timeout configuration.

io.kestra.core.http.client.configurations.TimeoutConfiguration

connectTimeoutstring

The time allowed to establish a connection to the server before failing.

readIdleTimeoutstring

DefaultPT5M

The time allowed for a read connection to remain idle before closing it.