Create import storage | API Reference

Create a new Redis import storage connection.

Request

This endpoint expects an object.

descriptionstringOptional

Storage description

hoststringOptional

Server Host IP (optional)

passwordstringOptional

Server Password (optional)

pathstringOptional

Storage prefix (optional)

portstringOptional

Server Port (optional)

projectintegerOptional

Project ID

regex_filterstringOptional

Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.

titlestringOptional<=2048 characters

Storage title

use_blob_urlsbooleanOptionalDefaults to false

Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.

Response

created_atdatetime

Creation time

idinteger

projectinteger

A unique integer value identifying this project.

typestringDefaults to redis

dbinteger or null>=0<=32767

Server Database

descriptionstring or null

Cloud storage description

hoststring or null

Server Host IP (optional)

last_syncdatetime or null

Last sync finished time

last_sync_countinteger or null>=0<=2147483647

Count of tasks synced last time

last_sync_jobstring or null<=256 characters

Last sync job ID

metaany or null

passwordstring or null

Server Password (optional)

pathstring or null

Storage prefix (optional)

portstring or null

Server Port (optional)

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

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 POST http://localhost:8000/api/storages/redis/ \
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	"db": 1,
7	"description": "description",
8	"host": "host",
9	"last_sync": "2024-01-15T09:30:00Z",
10	"last_sync_count": 1,
11	"last_sync_job": "last_sync_job",
12	"meta": {
13	"key": "value"
14	},
15	"password": "password",
16	"path": "path",
17	"port": "port",
18	"regex_filter": "regex_filter",
19	"status": "initialized",
20	"synchronizable": true,
21	"title": "title",
22	"traceback": "traceback",
23	"use_blob_urls": true
24	}

Headers

Request

Response