Storage: Local

Create import storage

Changed on

Create a new local file import storage connection.

post/api/storages/localfiles/

Request

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

Request body

descriptionstring nullable

Cloud storage description

pathstring nullable

Local path

projectinteger required

A unique integer value identifying this project.

recursive_scanboolean nullable

Perform recursive scan over the directory content

regex_filterstring nullable

Regex for filtering objects

synchronizableboolean
titlestring nullable

Cloud storage title

use_blob_urlsboolean

Interpret objects as BLOBs and generate URLs

Response

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

metaunknown
pathstring nullable

Local path

projectinteger required

A unique integer value identifying this project.

recursive_scanboolean nullable

Perform recursive scan over the directory content

regex_filterstring nullable

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