API ReferenceExport StorageS3

Update export storage

PATCH

Update a specific S3 export storage connection. You will need to provide the export storage ID. You can find this using List export storages.

For more information about working with external storage, see Sync data from external storage.

Path parameters

idintegerRequired
A unique integer value identifying this s3 export storage.

Request

This endpoint expects an object.
can_delete_objects
booleanOptional
Deletion from storage enabled.
title
stringOptional
Storage title
description
stringOptional
Storage description
project
integerOptional
Project ID
bucket
stringOptional
S3 bucket name
prefix
stringOptional
S3 bucket prefix
aws_access_key_id
stringOptional

AWS_ACCESS_KEY_ID

aws_secret_access_key
stringOptional

AWS_SECRET_ACCESS_KEY

aws_session_token
stringOptional

AWS_SESSION_TOKEN

aws_sse_kms_key_id
stringOptional
AWS SSE KMS Key ID
region_name
stringOptional
AWS Region
s3_endpoint
stringOptional
S3 Endpoint

Response

This endpoint returns an object
can_delete_objects
booleanOptional
Deletion from storage enabled.
title
stringOptional
Storage title
description
stringOptional
Storage description
project
integerOptional
Project ID
bucket
stringOptional
S3 bucket name
prefix
stringOptional
S3 bucket prefix
aws_access_key_id
stringOptional

AWS_ACCESS_KEY_ID

aws_secret_access_key
stringOptional

AWS_SECRET_ACCESS_KEY

aws_session_token
stringOptional

AWS_SESSION_TOKEN

aws_sse_kms_key_id
stringOptional
AWS SSE KMS Key ID
region_name
stringOptional
AWS Region
s3_endpoint
stringOptional
S3 Endpoint