Skip to content
Cloudflare Docs

API request

Import

import { APIRequest } from "~/components";

Usage

Required API token permissions

 At least one of the following token permissions is required:
  • Account API Gateway
  • Domain API Gateway
Update zone level schema validation settings
curl https://api.cloudflare.com/zones/$ZONE_ID/api_gateway/settings/schema_validation \
  --request PUT \
  --header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
  --json '{
    "validation_default_mitigation_action": "block"
  }'

Required API token permissions

 At least one of the following token permissions is required:
  • SSL and Certificates Write
Delete TLS setting for hostname
curl https://api.cloudflare.com/zones/$ZONE_ID/hostnames/settings/ciphers/$HOSTNAME \
  --request DELETE \
  --header "X-Auth-Email: $CLOUDFLARE_EMAIL" \
  --header "X-Auth-Key: $CLOUDFLARE_API_KEY"
 
import { APIRequest } from "~/components";


<APIRequest
  path="/zones/{zone_id}/api_gateway/settings/schema_validation"
  method="PUT"
  json={{
    validation_default_mitigation_action: "block"
  }}
/>


<APIRequest
  path="/zones/{zone_id}/hostnames/settings/{setting_id}/{hostname}"
  method="DELETE"
  parameters={{
    setting_id: "ciphers",
  }}
/>

<APIRequest> Props

path

required

type: string

The path for the API endpoint.

This can be found in our API documentation ↗, under the name of the endpoint.

method

required

type: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD"

The HTTP method to use.

parameters

type: Record<string, any>

The path parameters to substitute.

If not provided, the component will default to an environment variable. For example, {setting_id} will be replaced with $SETTING_ID.

json

type: Record<string, any>

The JSON payload to send.

Default values can be omitted, and the component will use default values for any missing fields.