Skip to content
Cloudflare API
Start here
API Reference
Resource Sharing

Trigger a share update

client.resourceSharing.update(stringshareID, ResourceSharingUpdateParams { account_id, name, tags } params, RequestOptionsoptions?): ResourceSharingUpdateResponse { id, account_id, account_name, 13 more }
PUT/accounts/{account_id}/shares/{share_id}

Updates the share’s display name and tags. Omitting tags leaves the existing tags unchanged. Recipients and resources are managed via their subresource endpoints.

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
shareID: string

Share identifier tag.

maxLength32
minLength32
params: ResourceSharingUpdateParams { account_id, name, tags }
account_id: string

Path param: Account identifier.

maxLength32
minLength32
name: string

Body param: The name of the share.

tags?: Record<string, string>

Body param: Tags associated with the share.

ReturnsExpand Collapse
ResourceSharingUpdateResponse { id, account_id, account_name, 13 more }
id: string

Share identifier tag.

maxLength32
minLength32
account_id: string

Account identifier.

maxLength32
minLength32
account_name: string

The display name of an account.

created: string

When the object was created.

formatdate-time
modified: string

When the object was last modified.

formatdate-time
name: string

The name of the share.

organization_id: string

Organization identifier.

maxLength32
minLength32
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<Resource>

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
minLength32
created: string

When the object was created.

formatdate-time
meta: unknown

Resource Metadata.

modified: string

When the object was last modified.

formatdate-time
resource_account_id: string

Account identifier.

maxLength32
minLength32
resource_id: string

Identifier assigned by the service that owns the shared resource.

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"
tags?: Record<string, string>

Tags associated with the share. Included in create and update responses when tags are supplied, and in read responses when the include_tags_from parameter is set.

Trigger a share update

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.update('3fd85f74b32742f1bff64a85009dda07', {
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
  name: 'My Shared WAF Managed Rule',
});

console.log(resourceSharing.id);
{
  "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": "0a679032-bbb2-4b7e-9acc-dd5c5cb27a17",
        "resource_type": "custom-ruleset",
        "resource_version": 0,
        "status": "active"
      }
    ],
    "tags": {
      "foo": "string"
    }
  }
}
Returns Examples
{
  "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": "0a679032-bbb2-4b7e-9acc-dd5c5cb27a17",
        "resource_type": "custom-ruleset",
        "resource_version": 0,
        "status": "active"
      }
    ],
    "tags": {
      "foo": "string"
    }
  }
}