POST /accounts/{account_id}/shares

Creates a new resource share for sharing Cloudflare resources with other accounts or organizations.

Servers

Path parameters

Name Type Required Description
account_id String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
name String Yes

The name of the share.

recipients[] Array Yes
recipients[].recipient_account_id String No

The account that will receive the share.

recipients[].account_id String No

Deprecated alias for recipient_account_id. Use recipient_account_id instead. The body field collided with the URL path parameter of the same name, which prevented SDK generators from distinguishing the source account (in the URL) from the recipient account (in the body). Both names will continue to be accepted until 2027-05-26 (see x-sunset).

recipients[].organization_id String No

Organization identifier.

resources[] Array Yes
resources[].resource_type String Yes

Resource Type.

Valid values:

  • "custom-ruleset"
  • "gateway-destination-ip"
  • "gateway-extended-email-matching"
  • "gateway-policy"
  • "idp-federation-grant"
  • "gateway-block-page-settings"
resources[].resource_id String Yes

Share Resource identifier.

resources[].resource_account_id String Yes

Account identifier.

resources[].meta Object Yes

Resource Metadata.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.