Sign in
Storage: S3

Create export storage

Create a new S3 export storage connection to store annotations.

post/api/storages/export/s3

Request body

aws_access_key_idstring nullable

AWS_ACCESS_KEY_ID

aws_secret_access_keystring nullable

AWS_SECRET_ACCESS_KEY

aws_session_tokenstring nullable

AWS_SESSION_TOKEN

aws_sse_kms_key_idstring nullable

AWS SSE KMS Key ID

bucketstring nullable

S3 bucket name

can_delete_objectsboolean nullable

Deletion from storage enabled

descriptionstring nullable

Cloud storage description

prefixstring nullable

S3 bucket prefix

projectinteger required

A unique integer value identifying this project.

regex_filterstring nullable

Cloud storage regex for filtering objects

region_namestring nullable

AWS Region

s3_endpointstring nullable

S3 Endpoint

synchronizableboolean
titlestring nullable

Cloud storage title

use_blob_urlsboolean

Interpret objects as BLOBs and generate URLs

Response

aws_access_key_idstring nullable

AWS_ACCESS_KEY_ID

aws_secret_access_keystring nullable

AWS_SECRET_ACCESS_KEY

aws_session_tokenstring nullable

AWS_SESSION_TOKEN

aws_sse_kms_key_idstring nullable

AWS SSE KMS Key ID

bucketstring nullable

S3 bucket name

can_delete_objectsboolean nullable

Deletion from storage enabled

created_atstring date-time required

Creation time

descriptionstring nullable

Cloud storage description

idinteger required
last_syncstring date-time nullable

Last sync finished time

last_sync_countinteger nullable

Count of tasks synced last time

last_sync_jobstring nullable

Last sync job ID

{"stackTrail":"components:schemas:S3ExportStorage:properties:meta","oasType":"schema","type":"unknown","description":"Meta and debug information about storage processes","nullable":true}
prefixstring nullable

S3 bucket prefix

projectinteger required

A unique integer value identifying this project.

regex_filterstring nullable

Cloud storage regex for filtering objects

region_namestring nullable

AWS Region

s3_endpointstring nullable

S3 Endpoint

status'initialized' | 'queued' | 'in_progress' | 'failed' | 'completed' | 'completed_with_errors'
  • initialized - Initialized
  • queued - Queued
  • in_progress - In progress
  • failed - Failed
  • completed - Completed
  • completed_with_errors - Completed with errors
synchronizableboolean
titlestring nullable

Cloud storage title

tracebackstring nullable

Traceback report for the last failed sync

typestring required
use_blob_urlsboolean

Interpret objects as BLOBs and generate URLs

Changes

Changed in 1 of the 97 revisions of this API.317

  • e1ba2ecdbabb317See the full diff
    • ▲

      request body became required

      request-body-became-required

    • ▲

      the request property project became required

      request-property-became-required

    • ▲

      the title request property's maxLength was decreased to 256

      request-property-max-length-decreased

    • ○

      added the new optional request property regex_filter

      new-optional-request-property

    • ○

      added the new optional request property synchronizable

      new-optional-request-property

    • ○

      added the new optional request property use_blob_urls

      new-optional-request-property

    • ○

      added the media type application/x-www-form-urlencoded to the request body

      request-body-media-type-added

    • ○

      added the media type multipart/form-data to the request body

      request-body-media-type-added

    • ○

      the request property aws_access_key_id became nullable

      request-property-became-nullable

    • ○

      the request property aws_secret_access_key became nullable

      request-property-became-nullable

    • ○

      the request property aws_session_token became nullable

      request-property-became-nullable

    • ○

      the request property aws_sse_kms_key_id became nullable

      request-property-became-nullable

    • ○

      the request property bucket became nullable

      request-property-became-nullable

    • ○

      the request property can_delete_objects became nullable

      request-property-became-nullable

    • ○

      the request property description became nullable

      request-property-became-nullable

    • ○

      the request property prefix became nullable

      request-property-became-nullable

    • ○

      the request property region_name became nullable

      request-property-became-nullable

    • ○

      the request property s3_endpoint became nullable

      request-property-became-nullable

    • ○

      the request property title became nullable

      request-property-became-nullable

    • ○

      the can_delete_objects request property default value false was removed

      request-property-default-value-removed

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 97 revisions, 1 has no diff computed.