Storage: GCS

Create export storage

Changed on

Create a new GCS export storage connection to store annotations.

post/api/storages/export/gcs

Request

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

Request body

bucketstring nullable

GCS bucket name

can_delete_objectsboolean nullable

Deletion from storage enabled

descriptionstring nullable

Cloud storage description

google_application_credentialsstring nullable

The content of GOOGLE_APPLICATION_CREDENTIALS json file

google_project_idstring nullable

Google project ID

prefixstring nullable

GCS bucket prefix

projectinteger required

A unique integer value identifying this project.

regex_filterstring nullable

Cloud storage regex for filtering objects

synchronizableboolean
titlestring nullable

Cloud storage title

use_blob_urlsboolean

Interpret objects as BLOBs and generate URLs

Response

bucketstring nullable

GCS bucket name

can_delete_objectsboolean nullable

Deletion from storage enabled

created_atstring date-time required

Creation time

descriptionstring nullable

Cloud storage description

google_application_credentialsstring nullable

The content of GOOGLE_APPLICATION_CREDENTIALS json file

google_project_idstring nullable

Google project ID

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

metaunknown
prefixstring nullable

GCS bucket prefix

projectinteger required

A unique integer value identifying this project.

regex_filterstring nullable

Cloud storage regex for filtering objects

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

  • 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 default value false was removed