Delete Sink

client.pipelines.sinks.delete(, ?, ?): SinkDeleteResponse

DELETE/accounts/{account_id}/pipelines/v1/sinks/{sink_id}

Delete Pipeline in Account.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

ParametersExpand Collapse

sinkId: string

Specifies the publid ID of the sink.

maxLength32

minLength32

params: SinkDeleteParams { account_id, force }

account_id?: string

Path param: Specifies the public ID of the account.

force?: string

Query param: Delete sink forcefully, including deleting any dependent pipelines.

ReturnsExpand Collapse

SinkDeleteResponse = unknown

Delete Sink

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const sink = await client.pipelines.sinks.delete('0223105f4ecef8ad9ca31a8372d0c353', {
  account_id: '0123105f4ecef8ad9ca31a8372d0c353',
});

console.log(sink);

{
  "result": {},
  "success": true
}

Returns Examples

{
  "result": {},
  "success": true
}