Cloudflare

https://github.com/cloudflare/cloudflare-typescript
Admin
The official TypeScript API library for interacting with the Cloudflare REST API from server-side...
Tokens:3,524,475
Snippets:7,674
Trust Score:9.5
License:Apache-2.0
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### GET /accounts/{account_id}/magic/cloud/providers/{provider_id}/initial_setup

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/magic-cloud-networking/api.md

Retrieves initial setup information for a cloud integration.

```APIDOC
## GET /accounts/{account_id}/magic/cloud/providers/{provider_id}/initial_setup

### Description
Retrieves initial setup information for a cloud integration.

### Method
GET

### Endpoint
/accounts/{account_id}/magic/cloud/providers/{provider_id}/initial_setup

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.
- **provider_id** (string) - Required - The provider identifier.

### Request Example
{}

### Response
#### Success Response (200)
- **setup_url** (string) - The URL for initial setup.
- **status** (string) - The setup status.

#### Response Example
{
  "setup_url": "https://example.com/setup",
  "status": "pending"
}
```

--------------------------------

### GET /accounts/{account_id}/browser-rendering/devtools/browser

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/browser-rendering/api.md

Launches a new browser rendering session. This endpoint starts a new browser instance for rendering purposes.

```APIDOC
## GET /accounts/{account_id}/browser-rendering/devtools/browser

### Description
Launches a new browser rendering session. This endpoint starts a new browser instance for rendering purposes.

### Method
GET

### Endpoint
/accounts/{account_id}/browser-rendering/devtools/browser

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.

### Response
#### Success Response (200)
- **void** - No response body is returned.

```

--------------------------------

### Install cloudflare-typescript from GitHub

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/README.md

Install the library directly from the GitHub repository. Once the package is published to npm, the command will become `npm install cloudflare`.

```sh
npm install git+ssh://git@github.com:cloudflare/cloudflare-typescript.git
```

--------------------------------

### Install from git

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/CONTRIBUTING.md

Install the package directly from the git repository using npm.

```sh
$ npm install git+ssh://git@github.com:cloudflare/cloudflare-typescript.git
```

--------------------------------

### Make example executable and run it

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/CONTRIBUTING.md

Make the example file executable and run it against your API using tsn.

```sh
$ chmod +x examples/<your-example>.ts
# run the example against your api
$ yarn tsn -T examples/<your-example>.ts
```

--------------------------------

### Install dependencies and build with yarn

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/CONTRIBUTING.md

Run these commands in the repository root to install dependencies and build output files to dist/.

```sh
$ yarn
$ yarn build
```

--------------------------------

### Add an example TypeScript file

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/CONTRIBUTING.md

Place this comment at the top of a new file in examples/ to indicate it is an example. The shebang line allows running with npm run tsn -T.

```ts
// add an example to examples/<your-example>.ts

#!/usr/bin/env -S npm run tsn -T
…
```

--------------------------------

### get

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/tenant-custom-nameservers/api.md

Retrieves custom nameservers for a tenant. This operation sends a GET request to the specified endpoint.

```APIDOC
## GET /tenants/{tenant_tag}/custom_ns

### Description
Retrieves custom nameservers for a tenant.

### Method
GET

### Endpoint
/tenants/{tenant_tag}/custom_ns

### Parameters
#### Path Parameters
- **tenant_tag** (string) - Required - The tenant tag identifier.

### Request Example
```json
{
  "tenant_tag": "string"
}
```

### Response
#### Success Response (200)
- **result** (array) - List of custom nameserver objects.

#### Response Example
```json
{
  "result": []
}
```
```

--------------------------------

### GET /{accounts_or_zones}/{account_or_zone_id}/access/certificates/settings

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/zero-trust/api.md

Retrieves the certificate settings.

```APIDOC
## GET /{accounts_or_zones}/{account_or_zone_id}/access/certificates/settings

### Description
Retrieves the certificate settings.

### Method
GET

### Endpoint
/{accounts_or_zones}/{account_or_zone_id}/access/certificates/settings

### Parameters
#### Path Parameters
- **accounts_or_zones** (string) - Required - The account or zone identifier.
- **account_or_zone_id** (string) - Required - The account or zone identifier.

### Response
#### Success Response (200)
- **result** (CertificateSettings) - The certificate settings.

### Response Example
```json
{
  "result": {}
}
```
```

--------------------------------

### Start mock server

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/CONTRIBUTING.md

Run the mock server script to set up a mock server against the OpenAPI spec for testing.

```sh
$ ./scripts/mock
```

--------------------------------

### GET /zones/{zone_id}

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/zones/api.md

Gets a zone.

```APIDOC
## GET /zones/{zone_id}

### Description
Gets a zone.

### Method
GET

### Endpoint
/zones/{zone_id}

### Parameters
#### Path Parameters
- **zone_id** (string) - Required - The zone identifier.

### Response
#### Success Response (200)
- **Zone** (object) - The zone details.

#### Response Example
```json
{
  "id": "zone_id",
  "name": "example.com"
}
```
```

--------------------------------

### GET /zones/{zone_id}/tags

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/resource-tagging/api.md

Gets the tags for a zone.

```APIDOC
## GET /zones/{zone_id}/tags

### Description
Gets the tags for a zone.

### Method
GET

### Endpoint
/zones/{zone_id}/tags

### Parameters
#### Path Parameters
- **zone_id** (string) - Required - The zone identifier.

### Response
#### Success Response (200)
- **result** (object) - The zone tags.

#### Response Example
```json
{
  "result": {
    "tags": ["tag1", "tag2"]
  }
}
```
```

--------------------------------

### GET /accounts/{account_id}/tags

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/resource-tagging/api.md

Gets the tags for an account.

```APIDOC
## GET /accounts/{account_id}/tags

### Description
Gets the tags for an account.

### Method
GET

### Endpoint
/accounts/{account_id}/tags

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.

### Response
#### Success Response (200)
- **result** (object) - The account tags.

#### Response Example
```json
{
  "result": {
    "tags": ["tag1", "tag2"]
  }
}
```
```

--------------------------------

### POST /accounts/{account_id}/load_balancers/monitors/{monitor_id}/preview

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/load-balancers/api.md

Creates a preview for a load balancer monitor. Returns the preview response.

```APIDOC
## POST /accounts/{account_id}/load_balancers/monitors/{monitor_id}/preview

### Description
Creates a preview for a load balancer monitor.

### Method
POST

### Endpoint
/accounts/{account_id}/load_balancers/monitors/{monitor_id}/preview

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.
- **monitor_id** (string) - Required - The monitor identifier.

#### Request Body
- **params** (object) - Required - The preview parameters.

### Request Example
{
  "params": {}
}

### Response
#### Success Response (200)
- **PreviewCreateResponse** (object) - The preview creation response.

#### Response Example
{
  "preview": {}
}
```

--------------------------------

### post /accounts/{account_id}/realtime/kit/{app_id}/recordings

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/realtime-kit/api.md

Starts a new recording for a specific application. This method initiates a recording session.

```APIDOC
## POST /accounts/{account_id}/realtime/kit/{app_id}/recordings

### Description
Starts a new recording for a specific application.

### Method
POST

### Endpoint
/accounts/{account_id}/realtime/kit/{app_id}/recordings

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.
- **app_id** (string) - Required - The application identifier.

### Response
#### Success Response (200)
- **RecordingStartRecordingsResponse** - The response containing the started recording details.

```

--------------------------------

### GET /accounts/{account_id}/access/keys

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/zero-trust/api.md

Gets the access keys for an account.

```APIDOC
## GET /accounts/{account_id}/access/keys

### Description
Gets the access keys for an account.

### Method
GET

### Endpoint
/accounts/{account_id}/access/keys

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.

### Response
#### Success Response (200)
- **KeyGetResponse** (object) - The key details.

#### Response Example
```json
{
  "key_id": "string"
}
```
```

--------------------------------

### Run tests

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/CONTRIBUTING.md

Run the test suite after the mock server is set up.

```sh
$ yarn run test
```

--------------------------------

### GET /accounts/{account_id}/access/bookmarks/{bookmark_id}

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/zero-trust/api.md

Gets a bookmark for an account.

```APIDOC
## GET /accounts/{account_id}/access/bookmarks/{bookmark_id}

### Description
Gets a bookmark for an account.

### Method
GET

### Endpoint
/accounts/{account_id}/access/bookmarks/{bookmark_id}

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.
- **bookmark_id** (string) - Required - The bookmark identifier.

### Response
#### Success Response (200)
- **Bookmark** (object) - The bookmark.

#### Response Example
```json
{
  "id": "string",
  "name": "string"
}
```
```

--------------------------------

### Create a zone with Cloudflare client

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/README.md

Basic usage example: create a Cloudflare client with an API token and create a zone. The API token is read from the `CLOUDFLARE_API_TOKEN` environment variable by default.

```js
import Cloudflare from 'cloudflare';

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

const zone = await client.zones.create({
  account: { id: '023e105f4ecef8ad9ca31a8372d0c353' },
  name: 'example.com',
  type: 'full',
});

console.log(zone.id);
```

--------------------------------

### GET /zones/{zone_id}/observability/tracing/rules

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/zones/api.md

Gets tracing rules for a zone.

```APIDOC
## GET /zones/{zone_id}/observability/tracing/rules

### Description
Gets tracing rules for a zone.

### Method
GET

### Endpoint
/zones/{zone_id}/observability/tracing/rules

### Parameters
#### Path Parameters
- **zone_id** (string) - Required - The zone identifier.

### Response
#### Success Response (200)
- **RuleGetResponse** (object) - The tracing rules.

#### Response Example
```json
{
  "rules": []
}
```
```

--------------------------------

### GET /zones/{zone_id}/observability/tracing/settings

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/zones/api.md

Gets tracing settings for a zone.

```APIDOC
## GET /zones/{zone_id}/observability/tracing/settings

### Description
Gets tracing settings for a zone.

### Method
GET

### Endpoint
/zones/{zone_id}/observability/tracing/settings

### Parameters
#### Path Parameters
- **zone_id** (string) - Required - The zone identifier.

### Response
#### Success Response (200)
- **SettingGetResponse** (object) - The tracing settings.

#### Response Example
```json
{
  "enabled": true
}
```
```

--------------------------------

### After: Using fetchOptions with undici ProxyAgent

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/MIGRATION.md

Shows the new way to configure a proxy using fetchOptions and undici's ProxyAgent. This works with any runtime's built-in fetch implementation.

```ts
import Cloudflare from 'cloudflare';
import * as undici from 'undici';

const proxyAgent = new undici.ProxyAgent(process.env.PROXY_URL);
const client = new Cloudflare({
  fetchOptions: {
    dispatcher: proxyAgent,
  },
});
```

--------------------------------

### GET /zones/{zone_id}/security-center/securitytxt

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/security-txt/api.md

Gets the security.txt file for a zone.

```APIDOC
## GET /zones/{zone_id}/security-center/securitytxt

### Description
Gets the security.txt file for a zone.

### Method
GET

### Endpoint
/zones/{zone_id}/security-center/securitytxt

### Parameters
#### Path Parameters
- **zone_id** (string) - Required - The zone identifier.

### Response
#### Success Response (200)
- **result** (object) - The security.txt record.

#### Response Example
{
  "result": {}
}
```

--------------------------------

### GET /accounts/{account_id}/tags/summary

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/resource-tagging/api.md

Gets a summary of tags for an account.

```APIDOC
## GET /accounts/{account_id}/tags/summary

### Description
Gets a summary of tags for an account.

### Method
GET

### Endpoint
/accounts/{account_id}/tags/summary

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.

### Response
#### Success Response (200)
- **result** (object) - Summary of tags.

#### Response Example
```json
{
  "result": {
    "total_tags": 10,
    "total_keys": 5
  }
}
```
```

--------------------------------

### Configure proxy in Deno with Deno.createHttpClient

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/README.md

Use this snippet to configure a proxy in Deno by creating an HTTP client with Deno.createHttpClient and passing it via fetchOptions.

```ts
import Cloudflare from 'npm:cloudflare';

const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
const client = new Cloudflare({
  fetchOptions: {
    client: httpClient,
  },
});
```

--------------------------------

### GET /zones/{zone_id}/addressing/regional_hostnames/{hostname}

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/addressing/api.md

Gets a regional hostname.

```APIDOC
## GET /zones/{zone_id}/addressing/regional_hostnames/{hostname}

### Description
Gets a regional hostname.

### Method
GET

### Endpoint
/zones/{zone_id}/addressing/regional_hostnames/{hostname}

### Parameters
#### Path Parameters
- **zone_id** (string) - Required - The zone identifier.
- **hostname** (string) - Required - The hostname to retrieve.

### Response
#### Success Response (200)
- **RegionalHostnameGetResponse** - The regional hostname details.

```

--------------------------------

### GET /accounts/{account_id}/devices/ip-profiles/{profile_id}

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/zero-trust/api.md

Gets a specific IP profile.

```APIDOC
## GET /accounts/{account_id}/devices/ip-profiles/{profile_id}

### Description
Gets a specific IP profile.

### Method
GET

### Endpoint
/accounts/{account_id}/devices/ip-profiles/{profile_id}

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.
- **profile_id** (string) - Required - The IP profile identifier.

### Response
#### Success Response (200)
- **result** (object) - The IP profile object.

#### Response Example
```json
{
  "result": {}
}
```
```

--------------------------------

### GET /accounts/{account_id}/dex/devices/dex_tests/{dex_test_id}

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/zero-trust/api.md

Gets a specific DEX test.

```APIDOC
## GET /accounts/{account_id}/dex/devices/dex_tests/{dex_test_id}

### Description
Gets a specific DEX test.

### Method
GET

### Endpoint
/accounts/{account_id}/dex/devices/dex_tests/{dex_test_id}

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.
- **dex_test_id** (string) - Required - The DEX test identifier.

### Response
#### Success Response (200)
- **result** (object) - The DEX test object.

#### Response Example
```json
{
  "result": {}
}
```
```

--------------------------------

### GET /accounts/{account_id}/realtime/kit/{app_id}/webhooks

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/realtime-kit/api.md

Lists all webhooks for the specified realtime application. Returns an array of webhook configurations.

```APIDOC
## GET /accounts/{account_id}/realtime/kit/{app_id}/webhooks

### Description
Lists all webhooks for the specified realtime application.

### Method
GET

### Endpoint
/accounts/{account_id}/realtime/kit/{app_id}/webhooks

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.
- **app_id** (string) - Required - The application identifier.

### Response
#### Success Response (200)
- **webhooks** (array) - List of webhook objects.
  - **id** (string) - The webhook ID.
  - **url** (string) - The webhook URL.
  - **event_types** (array) - List of subscribed event types.

#### Response Example
{
  "webhooks": [
    {
      "id": "wh_123",
      "url": "https://example.com/webhook",
      "event_types": ["message.created"]
    }
  ]
}
```

--------------------------------

### GET /accounts/{account_id}/devices/registrations/{registration_id}

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/zero-trust/api.md

Gets a specific device registration.

```APIDOC
## GET /accounts/{account_id}/devices/registrations/{registration_id}

### Description
Gets a specific device registration.

### Method
GET

### Endpoint
/accounts/{account_id}/devices/registrations/{registration_id}

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.
- **registration_id** (string) - Required - The registration identifier.

### Response
#### Success Response (200)
- **result** (object) - The registration object.

#### Response Example
```json
{
  "result": {}
}
```
```

--------------------------------

### post /accounts/{account_id}/realtime/kit/{app_id}/recordings/track

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/realtime-kit/api.md

Starts a track recording for a specific application. This method initiates a recording for a specific track.

```APIDOC
## POST /accounts/{account_id}/realtime/kit/{app_id}/recordings/track

### Description
Starts a track recording for a specific application.

### Method
POST

### Endpoint
/accounts/{account_id}/realtime/kit/{app_id}/recordings/track

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.
- **app_id** (string) - Required - The application identifier.

### Response
#### Success Response (200)
- **RecordingStartTrackRecordingResponse** - The response containing the started track recording details.

```

--------------------------------

### GET /zones/{zone_id}/dns_records/{dns_record_id}

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/dns/api.md

Gets a DNS record by ID.

```APIDOC
## [GET] /zones/{zone_id}/dns_records/{dns_record_id}

### Description
Gets a DNS record by ID.

### Method
GET

### Endpoint
/zones/{zone_id}/dns_records/{dns_record_id}

### Parameters
#### Path Parameters
- **zone_id** (string) - Required - The zone ID.
- **dns_record_id** (string) - Required - The DNS record ID.

### Request Example
(No request body)

### Response
#### Success Response (200)
- **id** (string) - The record ID.
- **type** (string) - The record type.
- **name** (string) - The record name.
- **content** (string) - The record content.
- **ttl** (number) - Time to live.
- **proxied** (boolean) - Whether proxied.

#### Response Example
{
  "id": "12345",
  "type": "A",
  "name": "example.com",
  "content": "192.0.2.1",
  "ttl": 3600,
  "proxied": true
}
```

--------------------------------

### Tree-shaken client with createClient

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/README.md

Create a tree-shaken client that includes only the API resources you need, reducing bundle size. Specify the resources in the `resources` array and then make API calls as usual.

```ts
import { createClient } from 'cloudflare/tree-shakable';
import { Zones } from 'cloudflare/resources/zones/zones';
import { BaseAccounts } from 'cloudflare/resources/accounts/accounts';

const client = createClient({
  // Specify the resources you'd like to use ...
  resources: [Zones, BaseAccounts],
});

// ... then make API calls as usual.
const zone = await client.zones.create({
  account: {},
  name: 'example.com',
});
const account = await client.accounts.create({ name: 'name' });
```

--------------------------------

### GET /accounts/{account_id}/storage/kv/namespaces/{namespace_id}

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/kv/api.md

Gets a specific KV namespace.

```APIDOC
## GET /accounts/{account_id}/storage/kv/namespaces/{namespace_id}

### Description
Gets a specific KV namespace.

### Method
GET

### Endpoint
/accounts/{account_id}/storage/kv/namespaces/{namespace_id}

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.
- **namespace_id** (string) - Required - The namespace identifier.

### Response
#### Success Response (200)
- **id** (string) - Namespace identifier.
- **title** (string) - Namespace name.
- **supports_url_encoding** (boolean) - Whether the namespace supports URL encoding.

#### Response Example
{
  "id": "0f2ac74b498b48028cb68387c421e279",
  "title": "My Own Namespace",
  "supports_url_encoding": true
}
```

--------------------------------

### GET /accounts/{account_id}/magic/cloud/catalog-syncs/prebuilt-policies

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/magic-cloud-networking/api.md

Lists prebuilt policies. This endpoint is used to list prebuilt policies for catalog syncs.

```APIDOC
## GET /accounts/{account_id}/magic/cloud/catalog-syncs/prebuilt-policies

### Description
Lists prebuilt policies.

### Method
GET

### Endpoint
/accounts/{account_id}/magic/cloud/catalog-syncs/prebuilt-policies

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.

### Response
#### Success Response (200)
- **PrebuiltPolicyListResponsesSinglePage** - A page of prebuilt policies.

```

--------------------------------

### Before: Using cloudflare/shims/web

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/MIGRATION.md

Shows the previous way to configure global types using cloudflare/shims/web import.

```ts
// Tell TypeScript and the package to use the global Web fetch instead of node-fetch.
import 'cloudflare/shims/web';
import Cloudflare from 'cloudflare';
```

--------------------------------

### GET /zones/{zone_id}/email/routing/dns

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/email-routing/api.md

Gets DNS records for email routing.

```APIDOC
## GET /zones/{zone_id}/email/routing/dns

### Description
Gets DNS records for email routing.

### Method
GET

### Endpoint
/zones/{zone_id}/email/routing/dns

### Parameters
#### Path Parameters
- **zone_id** (string) - Required - The zone identifier.

### Response
#### Success Response (200)
Returns a list of DNS records.

#### Response Example
```json
{
  "result": [
    {
      "id": "string",
      "type": "string",
      "name": "string",
      "content": "string",
      "ttl": 1,
      "priority": 1,
      "proxied": true
    }
  ]
}
```
```

--------------------------------

### GET /zones/{zone_id}/email/routing

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/email-routing/api.md

Gets the email routing settings for a zone.

```APIDOC
## GET /zones/{zone_id}/email/routing

### Description
Gets the email routing settings for a zone.

### Method
GET

### Endpoint
/zones/{zone_id}/email/routing

### Parameters
#### Path Parameters
- **zone_id** (string) - Required - The zone identifier.

### Response
#### Success Response (200)
Returns the email routing settings.

#### Response Example
```json
{
  "id": "string",
  "enabled": true,
  "status": "string",
  "skip_wizard": true
}
```
```

--------------------------------

### create

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/tenant-custom-nameservers/api.md

Creates a new custom nameserver for a tenant. This operation sends a POST request to the specified endpoint.

```APIDOC
## POST /tenants/{tenant_tag}/custom_ns

### Description
Creates a new custom nameserver for a tenant.

### Method
POST

### Endpoint
/tenants/{tenant_tag}/custom_ns

### Parameters
#### Path Parameters
- **tenant_tag** (string) - Required - The tenant tag identifier.

#### Request Body
- **params** (object) - Required - Additional parameters for the request.

### Request Example
```json
{
  "tenant_tag": "string"
}
```

### Response
#### Success Response (200)
- **result** (object) - The created custom nameserver object.

#### Response Example
```json
{
  "result": {}
}
```
```

--------------------------------

### POST /accounts/{account_id}/flagship/apps

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/flagship/api.md

Creates a new flagship app.

```APIDOC
## POST /accounts/{account_id}/flagship/apps

### Description
Creates a new flagship app.

### Method
POST

### Endpoint
/accounts/{account_id}/flagship/apps

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.

### Response
#### Success Response (200)
- **AppCreateResponse** - The created app object.

```

--------------------------------

### GET /accounts/{account_id}/dex/rules/{rule_id}

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/zero-trust/api.md

Gets details of a specific DEX rule.

```APIDOC
## GET /accounts/{account_id}/dex/rules/{rule_id}

### Description
Retrieves details of a specific DEX rule.

### Method
GET

### Endpoint
/accounts/{account_id}/dex/rules/{rule_id}

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.
- **rule_id** (string) - Required - The rule identifier.

### Response
#### Success Response (200)
- **result** (object) - The rule details.

#### Response Example
{
  "result": {}
}
```

--------------------------------

### POST /zones/{zone_id}/waiting_rooms/preview

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/waiting-rooms/api.md

Previews a waiting room configuration. This method allows you to test a waiting room setup before applying it.

```APIDOC
## POST /zones/{zone_id}/waiting_rooms/preview

### Description
Preview a waiting room configuration to see how it will behave before deploying it.

### Method
POST

### Endpoint
/zones/{zone_id}/waiting_rooms/preview

### Parameters
#### Path Parameters
- **zone_id** (string) - Required - The identifier of the zone.

### Response
#### Success Response (200)
- **PagePreviewResponse** - The preview details.

#### Response Example
_No response example provided in source._
```

--------------------------------

### GET /accounts/{account_id}/dex/traceroute-tests/{test_id}

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/zero-trust/api.md

Gets details of a specific traceroute test.

```APIDOC
## GET /accounts/{account_id}/dex/traceroute-tests/{test_id}

### Description
Retrieves details of a specific traceroute test.

### Method
GET

### Endpoint
/accounts/{account_id}/dex/traceroute-tests/{test_id}

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.
- **test_id** (string) - Required - The test identifier.

### Response
#### Success Response (200)
- **result** (object) - Traceroute test data.

#### Response Example
{
  "result": {}
}
```

--------------------------------

### POST /accounts/{account_id}/access/bookmarks/{bookmark_id}

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/zero-trust/api.md

Creates a bookmark for an account.

```APIDOC
## POST /accounts/{account_id}/access/bookmarks/{bookmark_id}

### Description
Creates a bookmark for an account.

### Method
POST

### Endpoint
/accounts/{account_id}/access/bookmarks/{bookmark_id}

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.
- **bookmark_id** (string) - Required - The bookmark identifier.

#### Request Body
- **body** (object) - Required - The bookmark details.

### Response
#### Success Response (200)
- **Bookmark** (object) - The created bookmark.

#### Response Example
```json
{
  "id": "string",
  "name": "string"
}
```
```

--------------------------------

### GET /accounts/{account_id}/r2-catalog/{bucket_name}/maintenance-configs

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/r2-data-catalog/api.md

Gets the maintenance configuration for a bucket.

```APIDOC
## GET /accounts/{account_id}/r2-catalog/{bucket_name}/maintenance-configs

### Description
Gets the maintenance configuration for a bucket.

### Method
GET

### Endpoint
/accounts/{account_id}/r2-catalog/{bucket_name}/maintenance-configs

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account ID.
- **bucket_name** (string) - Required - The bucket name.

### Response
#### Success Response (200)
Returns a MaintenanceConfigGetResponse object.

#### Response Example
```json
{
  "example": "MaintenanceConfigGetResponse"
}
```
```

--------------------------------

### POST /accounts/{account_id}/devices/posture/integration

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/zero-trust/api.md

Creates a new device posture integration for the specified account.

```APIDOC
## POST /accounts/{account_id}/devices/posture/integration

### Description
Creates a new device posture integration for the specified account.

### Method
POST

### Endpoint
/accounts/{account_id}/devices/posture/integration

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.

#### Request Body
- **type** (string) - Required - The integration type (e.g., crowdstrike, tanium, workspace_one).
- **name** (string) - Required - The name of the integration.
- **interval** (string) - Required - The polling interval.
- **config** (object) - Required - The configuration for the integration.

### Request Example
```json
{
  "type": "crowdstrike",
  "name": "Example Integration",
  "interval": "1h",
  "config": {
    "api_url": "https://api.crowdstrike.com",
    "client_id": "client-id",
    "client_secret": "client-secret"
  }
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the integration.
- **type** (string) - The integration type.
- **name** (string) - The name of the integration.
- **interval** (string) - The polling interval.
- **config** (object) - The configuration.

#### Response Example
```json
{
  "id": "integration-id",
  "type": "crowdstrike",
  "name": "Example Integration",
  "interval": "1h",
  "config": {
    "api_url": "https://api.crowdstrike.com",
    "client_id": "client-id",
    "client_secret": "client-secret"
  }
}
```
```

--------------------------------

### Link local copy with yarn and pnpm

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/CONTRIBUTING.md

Clone the repository and link it locally using either yarn or pnpm, then link it into your package.

```sh
# Clone
$ git clone https://www.github.com/cloudflare/cloudflare-typescript
$ cd cloudflare-typescript

# With yarn
$ yarn link
$ cd ../my-package
$ yarn link cloudflare

# With pnpm
$ pnpm link --global
$ cd ../my-package
$ pnpm link --global cloudflare
```

--------------------------------

### POST /accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/live_view

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/browser-rendering/api.md

Creates a live view for a browser rendering session. This endpoint sets up a live view for the specified session.

```APIDOC
## POST /accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/live_view

### Description
Creates a live view for a browser rendering session. This endpoint sets up a live view for the specified session.

### Method
POST

### Endpoint
/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/live_view

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.
- **session_id** (string) - Required - The browser session identifier.

### Response
#### Success Response (200)
- **LiveViewCreateResponse** - The response object containing the created live view details.

#### Response Example
```json
{
  "live_view_id": "string"
}
```

```

--------------------------------

### GET /accounts/{account_id}/r2-catalog/{bucket_name}

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/r2-data-catalog/api.md

Gets the R2 data catalog configuration for a bucket.

```APIDOC
## GET /accounts/{account_id}/r2-catalog/{bucket_name}

### Description
Gets the R2 data catalog configuration for a bucket.

### Method
GET

### Endpoint
/accounts/{account_id}/r2-catalog/{bucket_name}

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account ID.
- **bucket_name** (string) - Required - The bucket name.

### Response
#### Success Response (200)
Returns an R2DataCatalogGetResponse object.

#### Response Example
```json
{
  "example": "R2DataCatalogGetResponse"
}
```
```

--------------------------------

### GET /accounts/{account_id}/r2-catalog/{bucket_name}/namespaces/{namespace}/tables

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/r2-data-catalog/api.md

Lists the tables in a namespace.

```APIDOC
## GET /accounts/{account_id}/r2-catalog/{bucket_name}/namespaces/{namespace}/tables

### Description
Lists the tables in a namespace.

### Method
GET

### Endpoint
/accounts/{account_id}/r2-catalog/{bucket_name}/namespaces/{namespace}/tables

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account ID.
- **bucket_name** (string) - Required - The bucket name.
- **namespace** (string) - Required - The namespace name.

### Response
#### Success Response (200)
Returns a TableListResponse object.

#### Response Example
```json
{
  "example": "TableListResponse"
}
```
```

--------------------------------

### GET /zones/{zone_id}/settings/origin_tls_compliance_modes

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/origin-tls-compliance-modes/api.md

Gets the Origin TLS compliance mode setting for a zone.

```APIDOC
## GET /zones/{zone_id}/settings/origin_tls_compliance_modes

### Description
Gets the Origin TLS compliance mode setting for a zone.

### Method
GET

### Endpoint
/zones/{zone_id}/settings/origin_tls_compliance_modes

### Parameters
#### Path Parameters
- **zone_id** (string) - Required - The zone identifier.

### Response
#### Success Response (200)
- **OriginTLSComplianceModeGetResponse** - The response object.

#### Response Example
```json
{
  "result": {}
}
```
```

--------------------------------

### GET /accounts/{account_id}/ai-search/instances/{id}/stats

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/aisearch/api.md

Gets statistics for an AI Search instance.

```APIDOC
## GET /accounts/{account_id}/ai-search/instances/{id}/stats

### Description
Gets statistics for an AI Search instance.

### Method
GET

### Endpoint
/accounts/{account_id}/ai-search/instances/{id}/stats

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.
- **id** (string) - Required - The unique identifier of the instance.

### Response
#### Success Response (200)
- **document_count** (number) - Number of documents.
- **index_size** (number) - Size of the index.

#### Response Example
{
  "document_count": 100,
  "index_size": 2048
}
```

--------------------------------

### POST /{accounts_or_zones}/{account_or_zone_id}/logs/explorer/datasets

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/logs/api.md

Creates a new dataset for log exploration. Returns the created dataset.

```APIDOC
## POST /{accounts_or_zones}/{account_or_zone_id}/logs/explorer/datasets

### Description
Creates a new dataset for log exploration. Returns the created dataset.

### Method
POST

### Endpoint
/{accounts_or_zones}/{account_or_zone_id}/logs/explorer/datasets

### Parameters
#### Path Parameters
- **accounts_or_zones** (string) - Required - The account or zone identifier.
- **account_or_zone_id** (string) - Required - The account or zone ID.

#### Request Body
- **body** (object) - Required - The dataset configuration.

### Response
#### Success Response (200)
- **result** (object) - The created dataset.

#### Response Example
{
  "result": {}
}
```

--------------------------------

### GET /accounts/{account_id}/dex/traceroute-tests/{test_id}/percentiles

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/zero-trust/api.md

Gets percentile data for a specific traceroute test.

```APIDOC
## GET /accounts/{account_id}/dex/traceroute-tests/{test_id}/percentiles

### Description
Retrieves percentile data for a specific traceroute test.

### Method
GET

### Endpoint
/accounts/{account_id}/dex/traceroute-tests/{test_id}/percentiles

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.
- **test_id** (string) - Required - The test identifier.

### Response
#### Success Response (200)
- **result** (object) - Percentile data.

#### Response Example
{
  "result": {}
}
```

--------------------------------

### Before: Importing Accounts from root

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/MIGRATION.md

Shows the previous (invalid) way to import resource classes like Accounts from the root of the package in CommonJS.

```javascript
// Before
const { Accounts } = require('cloudflare');
```

--------------------------------

### GET /accounts/{account_id}/brand-protection/matches/download

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/brand-protection/api.md

Downloads brand protection match results. Returns a MatchDownloadResponse.

```APIDOC
## GET /accounts/{account_id}/brand-protection/matches/download

### Description
Downloads brand protection match results.

### Method
GET

### Endpoint
/accounts/{account_id}/brand-protection/matches/download

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.

#### Query Parameters
Additional query parameters may be supported as per the SDK.

### Response
#### Success Response (200)
- **MatchDownloadResponse** (object) - The download response containing match data.

#### Response Example
```json
{ "result": {} }
```

```

--------------------------------

### GET /accounts/{account_id}/dex/traceroute-tests/{test_id}/network-path

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/zero-trust/api.md

Gets the network path for a specific traceroute test.

```APIDOC
## GET /accounts/{account_id}/dex/traceroute-tests/{test_id}/network-path

### Description
Retrieves the network path for a specific traceroute test.

### Method
GET

### Endpoint
/accounts/{account_id}/dex/traceroute-tests/{test_id}/network-path

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.
- **test_id** (string) - Required - The test identifier.

### Response
#### Success Response (200)
- **result** (object) - Network path data.

#### Response Example
{
  "result": {}
}
```

--------------------------------

### GET /accounts/{account_id}/cloudforce-one/requests/types

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/cloudforce-one/api.md

Retrieves request types. This endpoint is used to get the types of requests.

```APIDOC
## GET /accounts/{account_id}/cloudforce-one/requests/types

### Description
Retrieves request types.

### Method
GET

### Endpoint
/accounts/{account_id}/cloudforce-one/requests/types

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.

### Response
#### Success Response (200)
- **types** (array) - The list of request types.

#### Response Example
{
  "types": [
    "type1",
    "type2"
  ]
}
```

--------------------------------

### GET /zones/{zone_id}/hostnames/settings/{setting_id}

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/hostnames/api.md

Lists TLS settings for a zone, optionally filtered by setting ID. Returns a paginated list of settings.

```APIDOC
## GET /zones/{zone_id}/hostnames/settings/{setting_id}

### Description
Lists TLS settings for a zone, optionally filtered by setting ID.

### Method
GET

### Endpoint
/zones/{zone_id}/hostnames/settings/{setting_id}

### Parameters
#### Path Parameters
- **zone_id** (string) - Required - The zone identifier.
- **setting_id** (string) - Required - The TLS setting identifier.

### Response
#### Success Response (200)
- **result** (Array<Setting>) - List of TLS settings.

#### Response Example
{
  "result": [
    {
      "id": "setting_id",
      "value": "example_value"
    }
  ]
}
```

--------------------------------

### GET /accounts/{account_id}/cloudforce-one/requests/quota

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/cloudforce-one/api.md

Retrieves request quota. This endpoint is used to get the quota for requests.

```APIDOC
## GET /accounts/{account_id}/cloudforce-one/requests/quota

### Description
Retrieves request quota.

### Method
GET

### Endpoint
/accounts/{account_id}/cloudforce-one/requests/quota

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.

### Response
#### Success Response (200)
- **quota** (object) - The request quota.

#### Response Example
{
  "quota": {
    "used": 10,
    "limit": 100
  }
}
```

--------------------------------

### Configure proxy in Bun with fetchOptions proxy

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/README.md

Use this snippet to configure a proxy in Bun by setting the proxy option in fetchOptions.

```ts
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  fetchOptions: {
    proxy: 'http://localhost:8888',
  },
});
```

--------------------------------

### GET /accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id}/logs

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/aisearch/api.md

Gets logs for a specific job.

```APIDOC
## GET /accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id}/logs

### Description
Gets logs for a specific job.

### Method
GET

### Endpoint
/accounts/{account_id}/ai-search/instances/{id}/jobs/{job_id}/logs

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.
- **id** (string) - Required - The unique identifier of the instance.
- **job_id** (string) - Required - The unique identifier of the job.

### Response
#### Success Response (200)
- **logs** (array) - List of log entries.

#### Response Example
{
  "logs": [
    {"timestamp": "2023-01-01T00:00:00Z", "message": "Job started"}
  ]
}
```

--------------------------------

### POST /accounts/{account_id}/ai/finetunes

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/ai/api.md

Creates a new fine-tuned model by submitting training configuration and data.

```APIDOC
## POST /accounts/{account_id}/ai/finetunes

### Description
Creates a new fine-tuned model by submitting training configuration and data.

### Method
POST

### Endpoint
/accounts/{account_id}/ai/finetunes

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.

#### Request Body
- **params** (object) - Required - Parameters for creating the fine-tune.

### Request Example
{
  "params": {}
}

### Response
#### Success Response (200)
- **FinetuneCreateResponse** (object) - The created fine-tune details.

#### Response Example
{
  "result": {}
}
```

--------------------------------

### GET /accounts/{account_id}/storage/kv/namespaces

Source: https://github.com/cloudflare/cloudflare-typescript/blob/main/src/resources/kv/api.md

Lists KV namespaces.

```APIDOC
## GET /accounts/{account_id}/storage/kv/namespaces

### Description
Lists KV namespaces.

### Method
GET

### Endpoint
/accounts/{account_id}/storage/kv/namespaces

### Parameters
#### Path Parameters
- **account_id** (string) - Required - The account identifier.

#### Query Parameters
- **direction** (string) - Optional - Direction to order namespaces.
- **order** (string) - Optional - Field to order results by.
- **page** (number) - Optional - Page number of paginated results.
- **per_page** (number) - Optional - Maximum number of results per page.

### Response
#### Success Response (200)
- **result** (array) - List of namespaces.
- **result_info** (object) - Pagination information.

#### Response Example
{
  "result": [
    {
      "id": "0f2ac74b498b48028cb68387c421e279",
      "title": "My Own Namespace",
      "supports_url_encoding": true
    }
  ],
  "result_info": {
    "page": 1,
    "per_page": 20,
    "count": 1,
    "total_count": 1
  }
}
```
Tokens:
Raw