Skip to content
Cloudflare API
Start here
API Reference
Resource Sharing

Recipients

List share recipients by share ID
resource_sharing.recipients.list(strshare_id, RecipientListParams**kwargs) -> SyncV4PagePaginationArray[RecipientListResponse]
GET/accounts/{account_id}/shares/{share_id}/recipients
Get share recipient by ID
resource_sharing.recipients.get(strrecipient_id, RecipientGetParams**kwargs) -> RecipientGetResponse
GET/accounts/{account_id}/shares/{share_id}/recipients/{recipient_id}
Create a new share recipient
resource_sharing.recipients.create(strshare_id, RecipientCreateParams**kwargs) -> RecipientCreateResponse
POST/accounts/{account_id}/shares/{share_id}/recipients
Delete a share recipient
resource_sharing.recipients.delete(strrecipient_id, RecipientDeleteParams**kwargs) -> RecipientDeleteResponse
DELETE/accounts/{account_id}/shares/{share_id}/recipients/{recipient_id}
ModelsExpand Collapse
class RecipientListResponse: …
id: str

Share Recipient identifier tag.

maxLength32
account_id: str

Account identifier.

maxLength32
association_status: Literal["associating", "associated", "disassociating", "disassociated"]

Share Recipient association status.

One of the following:
"associating"
"associated"
"disassociating"
"disassociated"
created: datetime

When the share was created.

formatdate-time
modified: datetime

When the share was modified.

formatdate-time
resources: Optional[List[Resource]]
error: str

Share Recipient error message.

resource_id: str

Share Resource identifier.

maxLength32
resource_version: int

Resource Version.

terminal: bool

Whether the error is terminal or will be continually retried.

class RecipientGetResponse: …
id: str

Share Recipient identifier tag.

maxLength32
account_id: str

Account identifier.

maxLength32
association_status: Literal["associating", "associated", "disassociating", "disassociated"]

Share Recipient association status.

One of the following:
"associating"
"associated"
"disassociating"
"disassociated"
created: datetime

When the share was created.

formatdate-time
modified: datetime

When the share was modified.

formatdate-time
resources: Optional[List[Resource]]
error: str

Share Recipient error message.

resource_id: str

Share Resource identifier.

maxLength32
resource_version: int

Resource Version.

terminal: bool

Whether the error is terminal or will be continually retried.

class RecipientCreateResponse: …
id: str

Share Recipient identifier tag.

maxLength32
account_id: str

Account identifier.

maxLength32
association_status: Literal["associating", "associated", "disassociating", "disassociated"]

Share Recipient association status.

One of the following:
"associating"
"associated"
"disassociating"
"disassociated"
created: datetime

When the share was created.

formatdate-time
modified: datetime

When the share was modified.

formatdate-time
resources: Optional[List[Resource]]
error: str

Share Recipient error message.

resource_id: str

Share Resource identifier.

maxLength32
resource_version: int

Resource Version.

terminal: bool

Whether the error is terminal or will be continually retried.

class RecipientDeleteResponse: …
id: str

Share Recipient identifier tag.

maxLength32
account_id: str

Account identifier.

maxLength32
association_status: Literal["associating", "associated", "disassociating", "disassociated"]

Share Recipient association status.

One of the following:
"associating"
"associated"
"disassociating"
"disassociated"
created: datetime

When the share was created.

formatdate-time
modified: datetime

When the share was modified.

formatdate-time
resources: Optional[List[Resource]]
error: str

Share Recipient error message.

resource_id: str

Share Resource identifier.

maxLength32
resource_version: int

Resource Version.

terminal: bool

Whether the error is terminal or will be continually retried.