--- title: Create a new share --- [Skip to content](#%5Ftop) [API Reference](https://developers.cloudflare.com/api/typescript) [Resource Sharing](https://developers.cloudflare.com/api/typescript/resources/resource%5Fsharing) Copy Markdown Open in **Claude** Open in **ChatGPT** Open in **Cursor** --- **Copy Markdown** **View as Markdown** # Create a new share client.resourceSharing.create(ResourceSharingCreateParams { account\_id, name, recipients, resources } params, RequestOptionsoptions?): [ResourceSharingCreateResponse](https://developers.cloudflare.com/api/typescript/resources/resource%5Fsharing#%28resource%29%20resource%5Fsharing%20%3E%20%28model%29%20resource%5Fsharing%5Fcreate%5Fresponse%20%3E%20%28schema%29) { id, account\_id, account\_name, 12 more } 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` ##### ParametersExpand Collapse params: ResourceSharingCreateParams { account\_id, name, recipients, resources } account\_id: string Path param: Account identifier. maxLength32 name: string Body param: The name of the share. recipients: Array Body param Deprecatedaccount\_id?: 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 organization\_id?: string Organization identifier. maxLength32 recipient\_account\_id?: string The account that will receive the share. maxLength32 resources: Array Body param meta: unknown Resource Metadata. resource\_account\_id: string Account identifier. maxLength32 resource\_id: string Share Resource identifier. maxLength32 resource\_type: "custom-ruleset" | "gateway-policy" | "gateway-destination-ip" | 4 more Resource Type. One of the following: "custom-ruleset" "gateway-policy" "gateway-destination-ip" "gateway-block-page-settings" "gateway-extended-email-matching" "idp-federation-grant" "trust-grant" ##### ReturnsExpand Collapse ResourceSharingCreateResponse { id, account\_id, account\_name, 12 more } id: string Share identifier tag. maxLength32 account\_id: string Account identifier. maxLength32 account\_name: string The display name of an account. created: string When the share was created. formatdate-time modified: string When the share was modified. formatdate-time name: string The name of the share. organization\_id: string Organization identifier. maxLength32 status: "active" | "deleting" | "deleted" One of the following: "active" "deleting" "deleted" target\_type: "account" | "organization" One of the following: "account" "organization" associated\_recipient\_count?: number The number of recipients in the ‘associated’ state. This field is only included when requested via the ‘include\_recipient\_counts’ parameter. associating\_recipient\_count?: number The number of recipients in the ‘associating’ state. This field is only included when requested via the ‘include\_recipient\_counts’ parameter. disassociated\_recipient\_count?: number The number of recipients in the ‘disassociated’ state. This field is only included when requested via the ‘include\_recipient\_counts’ parameter. disassociating\_recipient\_count?: number The number of recipients in the ‘disassociating’ state. This field is only included when requested via the ‘include\_recipient\_counts’ parameter. kind?: "sent" | "received" One of the following: "sent" "received" resources?: Array 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 created: string When the share was created. formatdate-time meta: unknown Resource Metadata. modified: string When the share was modified. formatdate-time resource\_account\_id: string Account identifier. maxLength32 resource\_id: string Share Resource identifier. maxLength32 resource\_type: "custom-ruleset" | "gateway-policy" | "gateway-destination-ip" | 4 more Resource Type. One of the following: "custom-ruleset" "gateway-policy" "gateway-destination-ip" "gateway-block-page-settings" "gateway-extended-email-matching" "idp-federation-grant" "trust-grant" resource\_version: number Resource Version. status: "active" | "deleting" | "deleted" Resource Status. One of the following: "active" "deleting" "deleted" ### Create a new share TypeScript HTTPHTTP TypeScriptTypeScript PythonPython GoGo TerraformTerraform ``` import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiEmail: process.env['CLOUDFLARE_EMAIL'], // This is the default and can be omitted apiKey: process.env['CLOUDFLARE_API_KEY'], // This is the default and can be omitted }); const resourceSharing = await client.resourceSharing.create({ account_id: '023e105f4ecef8ad9ca31a8372d0c353', name: 'My Shared WAF Managed Rule', recipients: [{}], resources: [ { meta: {}, resource_account_id: '023e105f4ecef8ad9ca31a8372d0c353', resource_id: '023e105f4ecef8ad9ca31a8372d0c353', resource_type: 'custom-ruleset', }, ], }); console.log(resourceSharing.id); ``` 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" } ] } } ```