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/client/v4/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/client/v4/zones/$ZONE_ID/hostnames/settings/ciphers/$HOSTNAME \
  --request DELETE \
  --header "X-Auth-Email: $CLOUDFLARE_EMAIL" \
  --header "X-Auth-Key: $CLOUDFLARE_API_KEY"

Required API token permissions

At least one of the following token permissions is required:

• Images Write

Create authenticated direct upload URL V2

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/images/v2/direct_upload \
  --request POST \
  --header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
  --form "requireSignedURLs=true" \
  --form "metadata={"key":"value"}"

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
  path="/accounts/{account_id}/images/v2/direct_upload"
  method="POST"
  form={{
    requireSignedURLs: true,
    metadata: '{"key":"value"}'
  }}
/>

<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.

If required properties are missing, the component will throw an error.

form

type: Record<string, any>

The FormData payload to send.

This field is not currently validated against the schema.