Update an S3 Instant Access endpoint
Updates an endpoint for S3 Instant Access.
Path Parameters
- endpoint_id string required
ID of the endpoint to update
- application/json
Request Body required
- expiry_timestamp string
The time that this endpoint expires, in RFC-3339 format. This will revert to default if no state passed.
- name string
The user-assigned name of the S3 instant access endpoint. This will be removed if left empty.
- 200
- default
Success
- application/api.clumio.restored-protection-group-instant-access-endpoints=v1+json
- Schema
- Example (from schema)
Schema
_embedded object
Embedded responses related to the resource.
read-protection-group-s3-assetEmbeds the associated protection group S3 asset
_links object
URLs to pages related to the resource.
_self object
The HATEOAS link to this resource.
href stringThe URI for the referenced operation.
templated booleanDetermines whether the "href" link is a URI template. If set to
true
, the "href" link is a URI template.type stringThe HTTP method to be used with the "href" link for the referenced operation.
read-protection-group-instant-access-endpointURL to the detailed information of the instant access endpoint
read-protection-group-instant-access-endpoint-role-permissionURL to the role permissions of the instant access endpoint
read-protection-group-instant-access-endpoint-uriURL for getting URI of the instant access endpoint
read-protection-group-s3-assetURL 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.
{
"_embedded": {},
"_links": {
"_self": {
"href": "string",
"templated": true,
"type": "string"
}
},
"aws_account_id": "string",
"backup_region": "string",
"bucket_name": "string",
"created_timestamp": "string",
"endpoint_status": "string",
"expiry_timestamp": "string",
"id": "string",
"name": "string",
"objects_created_after": "string",
"objects_created_before": "string",
"organizational_unit_id": "string",
"protection_group_id": "string",
"protection_group_name": "string",
"protection_group_s3_asset_id": "string",
"region": "string",
"restore_timestamp": "string",
"updated_timestamp": "string"
}
Error
- application/json
- Schema
- Example (from schema)
Schema
errors object[]
A list of errors encountered during runtime.
error_code uint32error_message stringThe reason for the error.
{
"errors": [
{
"error_code": 0,
"error_message": "string"
}
]
}