import { APIRequest } from "~/components";import { APIRequest } from "~/components";
<APIRequest
path="/zones/{zone_id}/api_gateway/settings/schema_validation"
method="PUT"
json={{
validation_default_mitigation_action: "block",
}}
code={{
mark: [5, "block"],
}}
roles="Domain"
/>
<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
path="/zones/{zone_id}/cloud_connector/rules"
method="PUT"
json={[
{
expression: 'http.request.uri.path wildcard "/images/*"',
provider: "cloudflare_r2",
description: "Connect to R2 bucket containing images",
parameters: {
host: "mybucketcustomdomain.example.com",
},
},
]}
/>
<APIRequest
path="/zones/{zone_id}/page_shield/scripts"
method="GET"
parameters={{
direction: "asc",
}}
/>必需
类型: string
API 端点的路径。
这可以在我们的 API 文档 ↗ 中端点的名称下找到。
必需
类型: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD"
要使用的 HTTP 方法。
类型: Record<string, any>
要替换的参数——无论是在 URL 路径中还是作为查询参数。
例如,可以使用以下内容将 /zones/{zone_id}/page_shield/scripts 转换为 /zones/123/page_shield/scripts?direction=asc:
parameters={{
zone_id: "123",
direction: "asc"
}}如果未提供,组件将默认使用环境变量。例如,{setting_id} 将被替换为 $SETTING_ID。
类型: Record<string, any> | Record<string, any>[]
要发送的 JSON 负载。
如果缺少必需的属性,组件将抛出错误。
在功能上, --json 选项 ↗ 等同于 cURL 中的 --data 选项,但会自动处理一些额外的标头。
类型: Record<string, any>
要发送的 FormData 负载。
此字段当前不针对 schema 进行验证。
类型: object
Expressive Code 属性的对象,以下属性可用:
类型: string | boolean
默认值: true
如果设置为 true(默认值),将显示所有 API 令牌角色。
如果设置为 false,将不显示 API 令牌角色。
如果设置为字符串,API 令牌角色将被过滤,将该字符串作为子字符串(例如,roles="domain" 以过滤掉 Account API Gateway 并仅保留 Domain API Gateway)。