--- title: Trigger a share creation --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [Resource Sharing](https://developers.cloudflare.com/api/resources/resource_sharing) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Trigger a share creation POST/accounts/{account\_id}/shares Creates a new resource share for sharing Cloudflare resources with other accounts or organizations. ##### Security API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**`X-Auth-Email: user@example.com` The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**`X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194` ##### P ath ParametersExpand Collapse account\_id: string Account identifier. maxLength32 [Link to this property](<#(resource)%20resource_sharing%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) ##### Body ParametersJSONExpand Collapse name: string The name of the share. [Link to this property](<#(resource)%20resource_sharing%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20name%20%3E%20(schema)>)

recipients: array of object {account\_id, organization\_id, recipient\_account\_id }

Deprecatedaccount\_id: optional string This field has been renamed to recipient_account_id. Both names are accepted during the deprecation period. 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). maxLength32 Link to this property organization\_id: optional string Organization identifier. maxLength32 Link to this property recipient\_account\_id: optional string The account that will receive the share. maxLength32 Link to this property

[Link to this property](<#(resource)%20resource_sharing%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20recipients%20%3E%20(schema)>)

resources: array of object {meta, resource\_account\_id, resource\_id, resource\_type }

meta: unknown Resource Metadata. Link to this property resource\_account\_id: string Account identifier. maxLength32 Link to this property resource\_id: string Share Resource identifier. maxLength32 Link to this property

resource\_type: "custom-ruleset"or "gateway-policy"or "gateway-destination-ip"or 4 more Resource Type.

One of the following: "custom-ruleset" Link to this property "gateway-policy" Link to this property "gateway-destination-ip" Link to this property "gateway-block-page-settings" Link to this property "gateway-extended-email-matching" Link to this property "idp-federation-grant" Link to this property "trust-grant" Link to this property

Link to this property

[Link to this property](<#(resource)%20resource_sharing%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20resources%20%3E%20(schema)>) ##### ReturnsExpand Collapse

errors: array of ResponseInfo { code, message, documentation\_url, source }

code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property

source: optional object {pointer }

pointer: optional string Link to this property

Link to this property

[Link to this property](<#(resource)%20resource_sharing%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20errors>) success: boolean Whether the API call was successful. [Link to this property](<#(resource)%20resource_sharing%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20success>)

result: optional object {id, account\_id, account\_name, 12 more }

id: string Share identifier tag. maxLength32 Link to this property account\_id: string Account identifier. maxLength32 Link to this property account\_name: string The display name of an account. Link to this property created: string When the share was created. formatdate-time Link to this property modified: string When the share was modified. formatdate-time Link to this property name: string The name of the share. Link to this property organization\_id: string Organization identifier. maxLength32 Link to this property

status: "active"or "deleting"or "deleted"

One of the following: "active" Link to this property "deleting" Link to this property "deleted" Link to this property

Link to this property

target\_type: "account"or "organization"

One of the following: "account" Link to this property "organization" Link to this property

Link to this property associated\_recipient\_count: optional number The number of recipients in the ‘associated’ state. This field is only included when requested via the ‘include\_recipient\_counts’ parameter. Link to this property associating\_recipient\_count: optional number The number of recipients in the ‘associating’ state. This field is only included when requested via the ‘include\_recipient\_counts’ parameter. Link to this property disassociated\_recipient\_count: optional number The number of recipients in the ‘disassociated’ state. This field is only included when requested via the ‘include\_recipient\_counts’ parameter. Link to this property disassociating\_recipient\_count: optional number The number of recipients in the ‘disassociating’ state. This field is only included when requested via the ‘include\_recipient\_counts’ parameter. Link to this property

kind: optional "sent"or "received"

One of the following: "sent" Link to this property "received" Link to this property

Link to this property

resources: optional array of object {id, created, meta, 6 more } A list of resources that are part of the share. This field is only included when requested via the ‘include\_resources’ parameter.

id: string Share Resource identifier. maxLength32 Link to this property created: string When the share was created. formatdate-time Link to this property meta: unknown Resource Metadata. Link to this property modified: string When the share was modified. formatdate-time Link to this property resource\_account\_id: string Account identifier. maxLength32 Link to this property resource\_id: string Share Resource identifier. maxLength32 Link to this property

resource\_type: "custom-ruleset"or "gateway-policy"or "gateway-destination-ip"or 4 more Resource Type.

Link to this property resource\_version: number Resource Version. Link to this property

status: "active"or "deleting"or "deleted" Resource Status.

One of the following: "active" Link to this property "deleting" Link to this property "deleted" Link to this property

Link to this property

[Link to this property](<#(resource)%20resource_sharing%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20result>) ### Trigger a share creation HTTP HTTPTypeScriptPythonGoTerraform ``` curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/shares \ -H 'Content-Type: application/json' \ -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \ -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \ -d '{ "name": "My Shared WAF Managed Rule", "recipients": [ {} ], "resources": [ { "meta": {}, "resource_account_id": "023e105f4ecef8ad9ca31a8372d0c353", "resource_id": "023e105f4ecef8ad9ca31a8372d0c353", "resource_type": "custom-ruleset" } ] }' ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "id": "3fd85f74b32742f1bff64a85009dda07", "account_id": "023e105f4ecef8ad9ca31a8372d0c353", "account_name": "Account A", "created": "2023-09-21T18:56:32.624632Z", "modified": "2023-09-21T18:56:32.624632Z", "name": "My Shared WAF Managed Rule", "organization_id": "023e105f4ecef8ad9ca31a8372d0c353", "status": "active", "target_type": "account", "associated_recipient_count": 10, "associating_recipient_count": 1, "disassociated_recipient_count": 0, "disassociating_recipient_count": 0, "kind": "sent", "resources": [ { "id": "023e105f4ecef8ad9ca31a8372d0c353", "created": "2023-09-21T18:56:32.624632Z", "meta": {}, "modified": "2023-09-21T18:56:32.624632Z", "resource_account_id": "023e105f4ecef8ad9ca31a8372d0c353", "resource_id": "023e105f4ecef8ad9ca31a8372d0c353", "resource_type": "custom-ruleset", "resource_version": 0, "status": "active" } ] } } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "success": true, "result": { "id": "3fd85f74b32742f1bff64a85009dda07", "account_id": "023e105f4ecef8ad9ca31a8372d0c353", "account_name": "Account A", "created": "2023-09-21T18:56:32.624632Z", "modified": "2023-09-21T18:56:32.624632Z", "name": "My Shared WAF Managed Rule", "organization_id": "023e105f4ecef8ad9ca31a8372d0c353", "status": "active", "target_type": "account", "associated_recipient_count": 10, "associating_recipient_count": 1, "disassociated_recipient_count": 0, "disassociating_recipient_count": 0, "kind": "sent", "resources": [ { "id": "023e105f4ecef8ad9ca31a8372d0c353", "created": "2023-09-21T18:56:32.624632Z", "meta": {}, "modified": "2023-09-21T18:56:32.624632Z", "resource_account_id": "023e105f4ecef8ad9ca31a8372d0c353", "resource_id": "023e105f4ecef8ad9ca31a8372d0c353", "resource_type": "custom-ruleset", "resource_version": 0, "status": "active" } ] } } ```