Storage: S3

Validate export storage

Changed on

Validate a specific S3 export storage connection.

post/api/storages/export/s3/validate

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/api/storages/export/s3/validate
  • Auth
    API key in header Authorization

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

idinteger

Storage ID. If set, storage with specified ID will be updated

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

Validation successful

Changes

  • e1ba2ecdbabbRevision changes
    • breaking

      request body became required

    • breaking

      the request property became required

    • breaking

      the request property's maxLength was decreased to 256

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

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

    • info

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

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property default value false was removed