[ Web Proxy ]
URL:
Viewing: https://developers.cloudflare.com/api/resources/resource_sharing [Back]  [Original]
Resource Sharing | Cloudflare API Skip to content
logo.DMYpXs3t.svg [logo.DMYpXs3t.svg] Cloudflare API
CtrlK
Start here
Start here
HTTP
API Reference
Copy Markdown

Resource Sharing

List account shares
GET/accounts/{account_id}/shares
Get account share by ID
GET/accounts/{account_id}/shares/{share_id}
Create a new share
POST/accounts/{account_id}/shares
Update a share
PUT/accounts/{account_id}/shares/{share_id}
Delete a share
DELETE/accounts/{account_id}/shares/{share_id}
ModelsExpand Collapse
ResourceSharingListResponse object { 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" or "deleting" or "deleted"
One of the following:
"active"
"deleting"
"deleted"
target_type: "account" or "organization"
One of the following:
"account"
"organization"
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.

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.

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.

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.

kind: optional "sent" or "received"
One of the following:
"sent"
"received"
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
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" or "gateway-policy" or "gateway-destination-ip" or 3 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"
resource_version: number

Resource Version.

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

Resource Status.

One of the following:
"active"
"deleting"
"deleted"
ResourceSharingGetResponse object { 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" or "deleting" or "deleted"
One of the following:
"active"
"deleting"
"deleted"
target_type: "account" or "organization"
One of the following:
"account"
"organization"
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.

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.

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.

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.

kind: optional "sent" or "received"
One of the following:
"sent"
"received"
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
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" or "gateway-policy" or "gateway-destination-ip" or 3 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"
resource_version: number

Resource Version.

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

Resource Status.

One of the following:
"active"
"deleting"
"deleted"
ResourceSharingCreateResponse object { 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" or "deleting" or "deleted"
One of the following:
"active"
"deleting"
"deleted"
target_type: "account" or "organization"
One of the following:
"account"
"organization"
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.

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.

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.

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.

kind: optional "sent" or "received"
One of the following:
"sent"
"received"
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
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" or "gateway-policy" or "gateway-destination-ip" or 3 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"
resource_version: number

Resource Version.

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

Resource Status.

One of the following:
"active"
"deleting"
"deleted"
ResourceSharingUpdateResponse object { 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" or "deleting" or "deleted"
One of the following:
"active"
"deleting"
"deleted"
target_type: "account" or "organization"
One of the following:
"account"
"organization"
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.

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.

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.

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.

kind: optional "sent" or "received"
One of the following:
"sent"
"received"
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
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" or "gateway-policy" or "gateway-destination-ip" or 3 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"
resource_version: number

Resource Version.

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

Resource Status.

One of the following:
"active"
"deleting"
"deleted"
ResourceSharingDeleteResponse object { 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" or "deleting" or "deleted"
One of the following:
"active"
"deleting"
"deleted"
target_type: "account" or "organization"
One of the following:
"account"
"organization"
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.

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.

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.

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.

kind: optional "sent" or "received"
One of the following:
"sent"
"received"
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
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" or "gateway-policy" or "gateway-destination-ip" or 3 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"
resource_version: number

Resource Version.

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

Resource Status.

One of the following:
"active"
"deleting"
"deleted"

Resource SharingRecipients

List share recipients by share ID
GET/accounts/{account_id}/shares/{share_id}/recipients
Get share recipient by ID
GET/accounts/{account_id}/shares/{share_id}/recipients/{recipient_id}
Create a new share recipient
POST/accounts/{account_id}/shares/{share_id}/recipients
Delete a share recipient
DELETE/accounts/{account_id}/shares/{share_id}/recipients/{recipient_id}
ModelsExpand Collapse
RecipientListResponse object { id, account_id, association_status, 3 more }

A recipient of a share. The association_status field tracks the lifecycle of the shared resources in the recipient account. All recipients are returned by the list endpoint regardless of status; filter client-side if only active recipients are needed.

id: string

Share Recipient identifier tag.

maxLength32
account_id: string

Account identifier.

maxLength32
association_status: "associating" or "associated" or "disassociating" or "disassociated"

The current state of the recipient relative to the share. The desired_association_status (not exposed in the response) tracks the target state set by the API; the background reconciliation workflow drives current_association_status toward it.

  • associating The recipient was recently added; the workflow is pushing shared resources into the recipient account.
  • associated Shared resources have been successfully applied to the recipient account.
  • disassociating The recipient was removed (via DELETE or PUT replacement); the workflow is removing shared resources from the recipient account.
  • disassociated Shared resources have been removed from the recipient account. The recipient record remains in the database.
One of the following:
"associating"
"associated"
"disassociating"
"disassociated"
created: string

When the share was created.

formatdate-time
modified: string

When the share was modified.

formatdate-time
resources: optional array of object { error, resource_id, resource_version, terminal }
error: string

Share Recipient error message.

resource_id: string

Share Resource identifier.

maxLength32
resource_version: number

Resource Version.

terminal: boolean

Whether the error is terminal or will be continually retried.

RecipientGetResponse object { id, account_id, association_status, 3 more }

A recipient of a share. The association_status field tracks the lifecycle of the shared resources in the recipient account. All recipients are returned by the list endpoint regardless of status; filter client-side if only active recipients are needed.

id: string

Share Recipient identifier tag.

maxLength32
account_id: string

Account identifier.

maxLength32
association_status: "associating" or "associated" or "disassociating" or "disassociated"

The current state of the recipient relative to the share. The desired_association_status (not exposed in the response) tracks the target state set by the API; the background reconciliation workflow drives current_association_status toward it.

  • associating The recipient was recently added; the workflow is pushing shared resources into the recipient account.
  • associated Shared resources have been successfully applied to the recipient account.
  • disassociating The recipient was removed (via DELETE or PUT replacement); the workflow is removing shared resources from the recipient account.
  • disassociated Shared resources have been removed from the recipient account. The recipient record remains in the database.
One of the following:
"associating"
"associated"
"disassociating"
"disassociated"
created: string

When the share was created.

formatdate-time
modified: string

When the share was modified.

formatdate-time
resources: optional array of object { error, resource_id, resource_version, terminal }
error: string

Share Recipient error message.

resource_id: string

Share Resource identifier.

maxLength32
resource_version: number

Resource Version.

terminal: boolean

Whether the error is terminal or will be continually retried.

RecipientCreateResponse object { id, account_id, association_status, 3 more }

A recipient of a share. The association_status field tracks the lifecycle of the shared resources in the recipient account. All recipients are returned by the list endpoint regardless of status; filter client-side if only active recipients are needed.

id: string

Share Recipient identifier tag.

maxLength32
account_id: string

Account identifier.

maxLength32
association_status: "associating" or "associated" or "disassociating" or "disassociated"

The current state of the recipient relative to the share. The desired_association_status (not exposed in the response) tracks the target state set by the API; the background reconciliation workflow drives current_association_status toward it.

  • associating The recipient was recently added; the workflow is pushing shared resources into the recipient account.
  • associated Shared resources have been successfully applied to the recipient account.
  • disassociating The recipient was removed (via DELETE or PUT replacement); the workflow is removing shared resources from the recipient account.
  • disassociated Shared resources have been removed from the recipient account. The recipient record remains in the database.
One of the following:
"associating"
"associated"
"disassociating"
"disassociated"
created: string

When the share was created.

formatdate-time
modified: string

When the share was modified.

formatdate-time
resources: optional array of object { error, resource_id, resource_version, terminal }
error: string

Share Recipient error message.

resource_id: string

Share Resource identifier.

maxLength32
resource_version: number

Resource Version.

terminal: boolean

Whether the error is terminal or will be continually retried.

RecipientDeleteResponse object { id, account_id, association_status, 3 more }

A recipient of a share. The association_status field tracks the lifecycle of the shared resources in the recipient account. All recipients are returned by the list endpoint regardless of status; filter client-side if only active recipients are needed.

id: string

Share Recipient identifier tag.

maxLength32
account_id: string

Account identifier.

maxLength32
association_status: "associating" or "associated" or "disassociating" or "disassociated"

The current state of the recipient relative to the share. The desired_association_status (not exposed in the response) tracks the target state set by the API; the background reconciliation workflow drives current_association_status toward it.

  • associating The recipient was recently added; the workflow is pushing shared resources into the recipient account.
  • associated Shared resources have been successfully applied to the recipient account.
  • disassociating The recipient was removed (via DELETE or PUT replacement); the workflow is removing shared resources from the recipient account.
  • disassociated Shared resources have been removed from the recipient account. The recipient record remains in the database.
One of the following:
"associating"
"associated"
"disassociating"
"disassociated"
created: string

When the share was created.

formatdate-time
modified: string

When the share was modified.

formatdate-time
resources: optional array of object { error, resource_id, resource_version, terminal }
error: string

Share Recipient error message.

resource_id: string

Share Resource identifier.

maxLength32
resource_version: number

Resource Version.

terminal: boolean

Whether the error is terminal or will be continually retried.

Resource SharingResources

List share resources by share ID
GET/accounts/{account_id}/shares/{share_id}/resources
Get share resource by ID
GET/accounts/{account_id}/shares/{share_id}/resources/{share_resource_id}
Create a new share resource
POST/accounts/{account_id}/shares/{share_id}/resources
Update a share resource
PUT/accounts/{account_id}/shares/{share_id}/resources/{share_resource_id}
Delete a share resource
DELETE/accounts/{account_id}/shares/{share_id}/resources/{share_resource_id}
ModelsExpand Collapse
ResourceListResponse object { id, created, meta, 6 more }
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" or "gateway-policy" or "gateway-destination-ip" or 3 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"
resource_version: number

Resource Version.

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

Resource Status.

One of the following:
"active"
"deleting"
"deleted"
ResourceGetResponse object { id, created, meta, 6 more }
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" or "gateway-policy" or "gateway-destination-ip" or 3 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"
resource_version: number

Resource Version.

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

Resource Status.

One of the following:
"active"
"deleting"
"deleted"
ResourceCreateResponse object { id, created, meta, 6 more }
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" or "gateway-policy" or "gateway-destination-ip" or 3 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"
resource_version: number

Resource Version.

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

Resource Status.

One of the following:
"active"
"deleting"
"deleted"
ResourceUpdateResponse object { id, created, meta, 6 more }
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" or "gateway-policy" or "gateway-destination-ip" or 3 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"
resource_version: number

Resource Version.

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

Resource Status.

One of the following:
"active"
"deleting"
"deleted"
ResourceDeleteResponse object { id, created, meta, 6 more }
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" or "gateway-policy" or "gateway-destination-ip" or 3 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"
resource_version: number

Resource Version.

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

Resource Status.

One of the following:
"active"
"deleting"
"deleted"
Previous

Memberships
Next

Recipients

On this page

Web Proxy Viewer  |  New URL  |  Original Page