Get dataset download URL

client.radar.datasets.download(, ?): DatasetDownloadResponse { dataset }

POST/radar/datasets/download

Retrieves an URL to download a single dataset.

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

Accepted Permissions (at least one required)

User Details WriteUser Details Read

ParametersExpand Collapse

params: DatasetDownloadParams { datasetId, format }

datasetId: number

Body param

format?: "JSON" | "CSV"

Query param: Format in which results will be returned.

One of the following:

"JSON"

"CSV"

ReturnsExpand Collapse

DatasetDownloadResponse { dataset }

dataset: Dataset { url }

url: string

Get dataset download URL

import Cloudflare from 'cloudflare';

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

const response = await client.radar.datasets.download({ datasetId: 3 });

console.log(response.dataset);

{
  "result": {
    "dataset": {
      "url": "https://example.com/download"
    }
  }
}

Returns Examples

{
  "result": {
    "dataset": {
      "url": "https://example.com/download"
    }
  }
}