Skip to content
Cloudflare Docs

CURL

The CURL component is used to display a cURL command for making HTTP requests.

Import

import { CURL } from "~/components";

Usage

Terminal window
curl https://example.com \
  --request POST \
  --json '{
    "key": "value"
  }'
 
import { CURL } from "~/components";


<CURL
  url="https://example.com"
  method="POST"
  json={{
    key: "value",
  }}
  code={{
    mark: "value"
  }}
/>

<CURL> Props

url

required

type: string

The URL to make the request to.

method

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

default: "GET"

The HTTP method to use for the request.

headers

type: Record<string, string>

The headers to include in the request.

json

type: Record<string, any>

JSON data to include in the request.

code

type: object

An object of Expressive Code props, the following props are available: