Skip to main content

List S3 Instant Access endpoints​

Lists S3 instant access endpoints depending on the filters present in the body.

Query Parameters
  • limit int64

    Limits the size of the response on each page to the specified number of items.

  • start string

    Sets the page number used to browse the collection. Pages are indexed starting from 1 (i.e., ?start=1).

  • filter string

    Narrows down the results to only the items that satisfy the filter criteria. The following table lists the supported filter fields for this resource and the filter conditions that can be applied on those fields:

    FieldFilter ConditionDescription
    protection_group_id$eqThe Clumio-assigned ID of the protection group associated with the desired endpoints.
    protection_group_s3_asset_id$eqThe Clumio-assigned ID of the Protection Group S3 asset associated with the desired endpoints. The field must be used with protection_group_id.
    For more information about filtering, refer to the Filtering section of this guide.
Responses

Success

Schema
  • _embedded object

    Embedded responses related to the resource.

  • items object[]

    A collection of requested items.

  • _embedded object

    Embedded responses related to the resource.

  • read-protection-group-s3-asset

    Embeds the associated protection group S3 asset

  • _links object

    URLs to pages related to the resource.

  • _self object

    The HATEOAS link to this resource.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • read-protection-group-instant-access-endpoint

    URL to the detailed information of the instant access endpoint

  • read-protection-group-instant-access-endpoint-role-permission

    URL to the role permissions of the instant access endpoint

  • read-protection-group-instant-access-endpoint-uri

    URL for getting URI of the instant access endpoint

  • read-protection-group-s3-asset

    URL to the associated protection group S3 asset

  • aws_account_id string

    The AWS-assigned ID of the account associated with the S3 instant access endpoint.

  • backup_region string

    The AWS region of the S3 instant access endpoint and its source backup.

  • bucket_name string

    The name of source bucket.

  • created_timestamp string

    The time that this endpoint was created, in RFC-3339 format.

  • endpoint_status string

    The status of the S3 instant access endpoint. Possible values include "preparing", "active", "expiring", and "expired".

  • expiry_timestamp string

    The time that this endpoint expires, in RFC-3339 format.

  • id string

    The Clumio-assigned ID of the S3 instant access endpoint.

  • name string

    The user-assigned name of the S3 instant access endpoint.

  • objects_created_after string

    The time in RFC-3339 format that the restored objects are backed up from.

  • objects_created_before string

    The time in RFC-3339 format that the restored objects are backed up to.

  • organizational_unit_id string

    The Clumio-assigned ID of the organizational unit associated with the S3 instant access endpoint.

  • protection_group_id string

    The Clumio-assigned ID of the protection group this endpoint is created for.

  • protection_group_name string

    The user-assigned name of the protection group this endpoints is created for.

  • protection_group_s3_asset_id string

    The Clumio-assigned ID of the bucket protection group.

  • region string

    The AWS region of the source bucket.

  • restore_timestamp string

    The time at which the backup was restored from this endpoint in RFC-3339 format. Deprecated.

  • updated_timestamp string

    The time that this endpoint was last updated, in RFC-3339 format.

  • _links object

    URLs to pages related to the resource.

  • _first object

    The HATEOAS link to the first page of results.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • _next object

    The HATEOAS link to the next page of results.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • _self object

    The HATEOAS link to this resource.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • current_count int64

    The number of items listed on the current page.

  • limit int64

    The maximum number of items displayed per page in the response.

  • start string

    The page token used to get this response.

Loading...