Resource Sharing

resource_sharing

Methods

Create A New Share -> Envelope<{ id, account_id, account_name, 7 more... }>
post/accounts/{account_id}/shares

Create a new share

Delete A Share -> Envelope<{ id, account_id, account_name, 7 more... }>
delete/accounts/{account_id}/shares/{share_id}

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

Get Account Share By ID -> Envelope<{ id, account_id, account_name, 7 more... }>
get/accounts/{account_id}/shares/{share_id}

Fetches share by ID.

List Account Shares -> V4PagePaginationArray<{ id, account_id, account_name, 7 more... }>
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

Parameters
account_id: string
(maxLength: 32)

Account identifier.

direction:
Optional

Direction to sort objects.

"asc"
"desc"
kind:
Optional

Filter shares by kind.

"sent"
"received"
order:
Optional

Order shares by values in the given field.

"name"
"created"
page: number
Optional
(minimum: 0, multipleOf: 1)

Page number.

per_page: number
Optional
(maximum: 100, minimum: 0, multipleOf: 1)

Number of objects to return per page.

status:
Optional

Filter shares by status.

"active"
"deleting"
"deleted"
target_type:
Optional

Filter shares by target_type.

"account"
"organization"
Response fields
errors: Array<>
success: boolean

Whether the API call was successful.

result: Array<{ id, account_id, account_name, 7 more... }>
Optional
result_info: { count, page, per_page, 2 more... }
Optional
Request example
200Example
Update A Share -> Envelope<{ id, account_id, account_name, 7 more... }>
put/accounts/{account_id}/shares/{share_id}

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

resource_sharing.recipients

Methods

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.

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.

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.

resource_sharing.resources

Methods

Create A New Share Resource -> Envelope<{ id, created, meta, 6 more... }>
post/accounts/{account_id}/shares/{share_id}/resources

Create a new share resource

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.

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.

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.

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.