--- description: Generate curl commands from OpenAPI schema. title: API request image: https://developers.cloudflare.com/style-guide/build-the-page/components/api-request/og.png?v=83055f2240c29d85 --- [Skip to content](#main-content) > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/style-guide/llms.txt > Use this file to discover all available pages before exploring further. # API request Last updated Aug 20, 2026|Copy as Markdown| [View as Markdown](https://developers.cloudflare.com/style-guide/build-the-page/components/api-request/index.md)| [Agent setup](https://developers.cloudflare.com/agent-setup/) The `APIRequest` component is used `678` times on `273` pages.

See all examples of pages that use APIRequest

## Import ```mdx import { APIRequest } from "~/components"; ``` ## Usage ```mdx import { APIRequest } from "~/components"; ``` ## `` Props ### `path` **required** **type:** `string` The path for the API endpoint. This can be found in our [API documentation ↗︎](https://api.cloudflare.com), under the name of the endpoint. ### `method` **required** **type:** `"GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD"` The HTTP method to use. ### `parameters` **type:** `Record` The parameters to substitute - either in the URL path or as query parameters. For example, `/zones/{zone_id}/page_shield/scripts` can be transformed into `/zones/123/page_shield/scripts?direction=asc` with the following: ```mdx parameters={{ zone_id: "123", direction: "asc" }} ``` If not provided, the component will default to an environment variable. For example, `{setting_id}` will be replaced with `$SETTING_ID`. ### `json` **type:** `Record | Record[]` The JSON payload to send. If required properties are missing, the component will throw an error. Functionally, [the `--json` option ↗︎](https://everything.curl.dev/http/post/json.html) is equivalent to the `--data` option in cURL, but handles a few additional headers automatically. ### `form` **type:** `Record` The FormData payload to send. This field is not currently validated against the schema. ### `code` **type:** `object` An object of Astro `Code` props. Refer to the [Astro `Code` component documentation ↗︎](https://docs.astro.build/en/reference/api-reference/#code-) for available props. ### `roles` **type:** `string | boolean` **default:** `true` If set to `true`, which is the default, all API token roles will show. If set to `false`, API token roles will not be displayed. If set to a string, the API token roles will be filtered using it as a substring (i.e, `roles="domain"` to filter out `Account API Gateway` and only leave `Domain API Gateway`). Was this helpful? YesNo ## On this page [![](https://developers.cloudflare.com/_astro/logo.te5VL_aD.svg)Docs](https://developers.cloudflare.com/) ```json {"@context":"https://schema.org","@type":"TechArticle","@id":"https://developers.cloudflare.com/style-guide/build-the-page/components/api-request/#page","headline":"API request","description":"Generate curl commands from OpenAPI schema.","url":"https://developers.cloudflare.com/style-guide/build-the-page/components/api-request/","inLanguage":"en","image":"https://developers.cloudflare.com/style-guide/build-the-page/components/api-request/og.png?v=83055f2240c29d85","dateModified":"2026-08-20","publisher":{"@type":"Organization","name":"Cloudflare","description":"One platform for your apps, agents, and workforce. Build, secure, and scale without managing infrastructure","url":"https://www.cloudflare.com/","sameAs":["https://github.com/cloudflare","https://www.linkedin.com/company/cloudflare","https://x.com/cloudflare"],"logo":{"@type":"ImageObject","url":"https://developers.cloudflare.com/logo.svg"},"address":{"@type":"PostalAddress","streetAddress":"101 Townsend St","addressLocality":"San Francisco","addressRegion":"CA","postalCode":"94107","addressCountry":"US"},"contactPoint":[{"@type":"ContactPoint","contactType":"Customer Support","url":"https://support.cloudflare.com/","availableLanguage":["English"]},{"@type":"ContactPoint","contactType":"Sales","url":"https://www.cloudflare.com/contact/","availableLanguage":["English"]}]},"isPartOf":{"@type":"WebSite","@id":"https://developers.cloudflare.com/#website","name":"Cloudflare Docs","url":"https://developers.cloudflare.com/"}} ```