Update export storage | API Reference

Update a specific GCS export storage connection.

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Path Parameters

idintegerRequired

Request

This endpoint expects an object.

bucketstringOptional

GCS bucket name

can_delete_objectsbooleanOptionalDefaults to false

Deletion from storage enabled.

descriptionstringOptional

Storage description

google_application_credentialsstringOptional

The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.

google_project_idstringOptional

Google project ID

prefixstringOptional

GCS bucket prefix

projectintegerOptional

Project ID

titlestringOptional<=2048 characters

Storage title

Response

created_atdatetime

Creation time

idinteger

projectinteger

A unique integer value identifying this project.

typestringDefaults to gcs

bucketstring or null

GCS bucket name

can_delete_objectsboolean or null

Deletion from storage enabled

descriptionstring or null

Cloud storage description

google_application_credentialsstring or null

The content of GOOGLE_APPLICATION_CREDENTIALS json file

google_project_idstring or null

Google project ID

last_syncdatetime or null

Last sync finished time

last_sync_countinteger or null0-2147483647

Count of tasks synced last time

last_sync_jobstring or null<=256 characters

Last sync job ID

metaany or null

prefixstring or null

GCS bucket prefix

regex_filterstring or null

Cloud storage regex for filtering objects

statusenum or null

initialized - Initialized
queued - Queued
in_progress - In progress
failed - Failed
completed - Completed
completed_with_errors - Completed with errors

* `initialized` - Initialized * `queued` - Queued * `in_progress` - In progress * `failed` - Failed * `completed` - Completed * `completed_with_errors` - Completed with errors

synchronizableboolean or nullDefaults to true

titlestring or null<=256 characters

Cloud storage title

tracebackstring or null

Traceback report for the last failed sync

use_blob_urlsboolean or null

Interpret objects as BLOBs and generate URLs

1	curl -X PATCH http://localhost:8000/api/storages/export/gcs/1 \
2	-H "Authorization: Token <api_key>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"created_at": "2024-01-15T09:30:00Z",
3	"id": 1,
4	"project": 1,
5	"type": "type",
6	"bucket": "bucket",
7	"can_delete_objects": true,
8	"description": "description",
9	"google_application_credentials": "google_application_credentials",
10	"google_project_id": "google_project_id",
11	"last_sync": "2024-01-15T09:30:00Z",
12	"last_sync_count": 1,
13	"last_sync_job": "last_sync_job",
14	"meta": {
15	"key": "value"
16	},
17	"prefix": "prefix",
18	"regex_filter": "regex_filter",
19	"status": "initialized",
20	"synchronizable": true,
21	"title": "title",
22	"traceback": "traceback",
23	"use_blob_urls": true
24	}