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",
}}
/>required
type: string
API エンドポイントのパスです。
API ドキュメント ↗ の、各エンドポイント名の下にあります。
required
type: "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD"
使う HTTP メソッドです。
type: 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 に置き換わります。
type: Record<string, any> | Record<string, any>[]
送信する JSON ペイロードです。
必須プロパティが欠けていると、コンポーネントはエラーを投げます。
機能上、cURL の --json オプション ↗ は --data と同等ですが、いくつかのヘッダーを自動で扱います。
type: Record<string, any>
送信する FormData ペイロードです。
このフィールドは、現時点ではスキーマに対して検証しません。
type: object
Astro の Code props のオブジェクトです。使える props は Astro の Code コンポーネントドキュメント ↗ を参照してください。
type: string | boolean
default: true
true（デフォルト）の場合、すべての API トークンロールを表示します。
false の場合、API トークンロールは表示しません。
文字列の場合、その部分文字列で API トークンロールを絞り込みます（例: roles="domain" だと Account API Gateway を除き、Domain API Gateway だけ残します）。