Cloudflare API | Resource Sharing › List Account Shares

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/shares \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "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
  }
}

Get Account Share By ID -> Envelope<{ id, account_id, account_name, 12 more... }>

get/accounts/{account_id}/shares/{share_id}

Fetches share by ID.

Create A New Share -> Envelope<{ id, account_id, account_name, 12 more... }>

post/accounts/{account_id}/shares

Create a new share

Update A Share -> Envelope<{ id, account_id, account_name, 12 more... }>

put/accounts/{account_id}/shares/{share_id}

Updating is not immediate, an updated share object with a new status will be returned.

Delete A Share -> Envelope<{ id, account_id, account_name, 12 more... }>

delete/accounts/{account_id}/shares/{share_id}

Deletion is not immediate, an updated share object with a new status will be returned.

Resource Sharing

Recipients

resource_sharing.recipients

Methods

List Share Recipients By Share ID -> V4PagePaginationArray<{ id, account_id, association_status, 3 more... }>

get/accounts/{account_id}/shares/{share_id}/recipients

List share recipients by share ID.

Get Share Recipient By ID -> Envelope<{ id, account_id, association_status, 3 more... }>

get/accounts/{account_id}/shares/{share_id}/recipients/{recipient_id}

Get share recipient by ID.

Create A New Share Recipient -> Envelope<{ id, account_id, association_status, 3 more... }>

post/accounts/{account_id}/shares/{share_id}/recipients

Create a new share recipient

Delete A Share Recipient -> Envelope<{ id, account_id, association_status, 3 more... }>

delete/accounts/{account_id}/shares/{share_id}/recipients/{recipient_id}

Deletion is not immediate, an updated share recipient object with a new status will be returned.

Resource Sharing

Resources

resource_sharing.resources

Methods

List Share Resources By Share ID -> V4PagePaginationArray<{ id, created, meta, 6 more... }>

get/accounts/{account_id}/shares/{share_id}/resources

List share resources by share ID.

Get Share Resource By ID -> Envelope<{ id, created, meta, 6 more... }>

get/accounts/{account_id}/shares/{share_id}/resources/{resource_id}

Get share resource by ID.

Create A New Share Resource -> Envelope<{ id, created, meta, 6 more... }>

post/accounts/{account_id}/shares/{share_id}/resources

Create a new share resource

Update A Share Resource -> Envelope<{ id, created, meta, 6 more... }>

put/accounts/{account_id}/shares/{share_id}/resources/{resource_id}

Update is not immediate, an updated share resource object with a new status will be returned.

Delete A Share Resource -> Envelope<{ id, created, meta, 6 more... }>

delete/accounts/{account_id}/shares/{share_id}/resources/{resource_id}

Deletion is not immediate, an updated share resource object with a new status will be returned.