Skip to content
Start here

Resources

List share resources by share ID
resource_sharing.resources.list(strshare_id, ResourceListParams**kwargs) -> SyncV4PagePaginationArray[ResourceListResponse]
GET/accounts/{account_id}/shares/{share_id}/resources
Get share resource by ID
resource_sharing.resources.get(strresource_id, ResourceGetParams**kwargs) -> ResourceGetResponse
GET/accounts/{account_id}/shares/{share_id}/resources/{resource_id}
Create a new share resource
resource_sharing.resources.create(strshare_id, ResourceCreateParams**kwargs) -> ResourceCreateResponse
POST/accounts/{account_id}/shares/{share_id}/resources
Update a share resource
resource_sharing.resources.update(strresource_id, ResourceUpdateParams**kwargs) -> ResourceUpdateResponse
PUT/accounts/{account_id}/shares/{share_id}/resources/{resource_id}
Delete a share resource
resource_sharing.resources.delete(strresource_id, ResourceDeleteParams**kwargs) -> ResourceDeleteResponse
DELETE/accounts/{account_id}/shares/{share_id}/resources/{resource_id}
ModelsExpand Collapse
class ResourceListResponse:
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"
class ResourceGetResponse:
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"
class ResourceCreateResponse:
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"
class ResourceUpdateResponse:
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"
class ResourceDeleteResponse:
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"