Organization API: Organization deployments: Drains

Part of Organization deployments.

GET /api/v1/orgs/{org_slug}/deployments/{deployment_uuid}/drains

The deployment's drains, oldest first, and limit: allowed (the plan's deploy_log_drains for the account, null when no plan limits it), used (drains on the account's deployments), plans_apply, deployment_used and deployment_max. A drain's url hides its query values; its secret is never shown again.

POST /api/v1/orgs/{org_slug}/deployments/{deployment_uuid}/drains

A drain that forwards the lines collected from now on. http: an https:// address that receives POSTs of NDJSON signed with X-Coritan-Signature: t=<unix>,v1=<hex HMAC-SHA256(secret, "<t>." + body)>; without secret one is generated and returned this once as secret. syslog: syslog+tls://host:port, RFC 5424 over TLS, with no secret. The address may not be private, reserved or the platform's own. 402 past deploy_log_drains; 409 past the per-deployment cap.

application/json (required)

PATCH /api/v1/orgs/{org_slug}/deployments/{deployment_uuid}/drains/{drain_id}

Change what was sent: url (checked as on creation), enabled, filters, and for an http drain secret or rotate_secret (a generated secret, returned this once). A new address or a drain enabled again starts with no failures counted and no error.

application/json (required)

DELETE /api/v1/orgs/{org_slug}/deployments/{deployment_uuid}/drains/{drain_id}

Remove the drain; nothing more is sent to it.

POST /api/v1/orgs/{org_slug}/deployments/{deployment_uuid}/drains/{drain_id}/test

Send one sample line now, shaped as the forwarded ones (test: true), and keep the outcome on the drain: delivered, status (the HTTP answer, when there was one), error. A disabled drain may be tested before it is enabled again.