Skip to content
Cloudflare API
Start here
API Reference
Resource Sharing

List account shares

resource_sharing.list(ResourceSharingListParams**kwargs) -> SyncV4PagePaginationArray[ResourceSharingListResponse]
GET/accounts/{account_id}/shares

Lists all account shares.

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
account_id: str

Account identifier.

maxLength32
direction: Optional[Literal["asc", "desc"]]

Direction to sort objects.

One of the following:
"asc"
"desc"
include_recipient_counts: Optional[bool]

Include recipient counts in the response.

include_resources: Optional[bool]

Include resources in the response.

kind: Optional[Literal["sent", "received"]]

Filter shares by kind.

One of the following:
"sent"
"received"
order: Optional[Literal["name", "created"]]

Order shares by values in the given field.

One of the following:
"name"
"created"
page: Optional[int]

Page number.

minimum0
multipleOf1
per_page: Optional[int]

Number of objects to return per page.

maximum100
minimum0
multipleOf1
resource_types: Optional[List[Literal["custom-ruleset", "gateway-policy", "gateway-destination-ip", 2 more]]]

Filter share resources by resource_types.

One of the following:
"custom-ruleset"
"gateway-policy"
"gateway-destination-ip"
"gateway-block-page-settings"
"gateway-extended-email-matching"
status: Optional[Literal["active", "deleting", "deleted"]]

Filter shares by status.

One of the following:
"active"
"deleting"
"deleted"
target_type: Optional[Literal["account", "organization"]]

Filter shares by target_type.

One of the following:
"account"
"organization"
ReturnsExpand Collapse
class ResourceSharingListResponse: …
id: str

Share identifier tag.

maxLength32
account_id: str

Account identifier.

maxLength32
account_name: str

The display name of an account.

created: datetime

When the share was created.

formatdate-time
modified: datetime

When the share was modified.

formatdate-time
name: str

The name of the share.

organization_id: str

Organization identifier.

maxLength32
status: Literal["active", "deleting", "deleted"]
One of the following:
"active"
"deleting"
"deleted"
target_type: Literal["account", "organization"]
One of the following:
"account"
"organization"
associated_recipient_count: Optional[int]

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[int]

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[int]

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[int]

The number of recipients in the 'disassociating' state. This field is only included when requested via the 'include_recipient_counts' parameter.

kind: Optional[Literal["sent", "received"]]
One of the following:
"sent"
"received"
resources: Optional[List[Resource]]

A list of resources that are part of the share. This field is only included when requested via the 'include_resources' parameter.

id: str

Share Resource identifier.

maxLength32
created: datetime

When the share was created.

formatdate-time
meta: object

Resource Metadata.

modified: datetime

When the share was modified.

formatdate-time
resource_account_id: str

Account identifier.

maxLength32
resource_id: str

Share Resource identifier.

maxLength32
resource_type: Literal["custom-ruleset", "gateway-policy", "gateway-destination-ip", 2 more]

Resource Type.

One of the following:
"custom-ruleset"
"gateway-policy"
"gateway-destination-ip"
"gateway-block-page-settings"
"gateway-extended-email-matching"
resource_version: int

Resource Version.

status: Literal["active", "deleting", "deleted"]

Resource Status.

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

List account shares

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_email=os.environ.get("CLOUDFLARE_EMAIL"),  # This is the default and can be omitted
    api_key=os.environ.get("CLOUDFLARE_API_KEY"),  # This is the default and can be omitted
)
page = client.resource_sharing.list(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
page = page.result[0]
print(page.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": "023e105f4ecef8ad9ca31a8372d0c353",
          "resource_type": "custom-ruleset",
          "resource_version": 0,
          "status": "active"
        }
      ]
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 50
  }
}
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": "023e105f4ecef8ad9ca31a8372d0c353",
          "resource_type": "custom-ruleset",
          "resource_version": 0,
          "status": "active"
        }
      ]
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 50
  }
}