Skip to main content

Read S3 instant access endpoint​

Return detailed information for a specified S3 instant access endpoint.

Path Parameters
  • endpoint_id string required

    ID of the endpoint to read

Responses

Success

Schema
  • _embedded object

    Embedded responses related to the resource.

  • read-protection-group-s3-asset

    Embeds the associated protection group S3 asset

  • _etag string

    The ETag value.

  • _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.

  • roles object[]

    The IAM roles allowed to access the endpoint.

  • alias string

    The alias of the IAM role given by the user in the UI.

  • arn string

    The ARN of the IAM role.

  • id string

    The ID of the IAM role. Used as an identifier in the API URL.

  • last_modified_timestamp string

    The time when the role was last modified, in RFC-3339 format.

  • stats object[]

    The stats associated with the endpoint.

  • count int64

    The unit counts of the metric.

  • name string

    The name of the metric.

  • unit string

    Unit of the metric.

  • updated_timestamp string

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

GET /restores/protection-groups/instant-access-endpoints/:endpoint_id

Authorization

Request

Click Edit to configure Base URL
https://us-west-2.api.clumio.com
Bearer Token
endpoint_id — path required
curl -L -X GET 'https://us-west-2.api.clumio.com/restores/protection-groups/instant-access-endpoints/:endpoint_id' \
-H 'Accept: application/api.clumio.restored-protection-group-instant-access-endpoints=v1+json' \
-H 'Authorization: Bearer <TOKEN>'