API ReferenceExport StorageAzure Spi

Create Azure export storage with SPI authentication

Create an Azure export storage connection with Service Principal authentication to store annotations.

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

Request

This endpoint expects an object.
projectintegerRequired
A unique integer value identifying this project.
account_namestringOptional
Azure Blob account name
can_delete_objectsbooleanOptional
Deletion from storage enabled
client_idstringOptional
Azure Blob Service Principal Client ID
client_secretstringOptional
Azure Blob Service Principal Client Secret
containerstringOptional
Azure blob container
descriptionstringOptional
Cloud storage description
last_syncdatetimeOptional
Last sync finished time
last_sync_countintegerOptional>=0<=2147483647
Count of tasks synced last time
last_sync_jobstringOptional<=256 characters
Last sync job ID
metaanyOptional
prefixstringOptional
Azure blob prefix name
regex_filterstringOptional
Cloud storage regex for filtering objects
statusenumOptional
  • initialized - Initialized
  • queued - Queued
  • in_progress - In progress
  • failed - Failed
  • completed - Completed
  • completed_with_errors - Completed with errors
synchronizablebooleanOptionalDefaults to true
tenant_idstringOptional
Azure Tenant ID
titlestringOptional<=256 characters
Cloud storage title
tracebackstringOptional
Traceback report for the last failed sync
use_blob_urlsbooleanOptional
Interpret objects as BLOBs and generate URLs
user_delegation_keystringOptional

User Delegation Key (Backend)

Response

created_atdatetime
Creation time
idinteger
projectinteger
A unique integer value identifying this project.
typestringDefaults to azure_spi
account_namestring or null
Azure Blob account name
can_delete_objectsboolean or null
Deletion from storage enabled
client_idstring or null
Azure Blob Service Principal Client ID
client_secretstring or null
Azure Blob Service Principal Client Secret
containerstring or null
Azure blob container
descriptionstring or null
Cloud storage description
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
prefixstring or null
Azure blob prefix name
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
tenant_idstring or null
Azure Tenant ID
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
user_delegation_keystring or null

User Delegation Key (Backend)