{"components":{"schemas":{"AnalysisAmazonRekognitionSettingsSchema":{"properties":{"access_key":{"type":"string"},"bucket":{"type":"string"},"endpoint":{"type":"string"},"is_system":{"type":"boolean"},"path":{"type":"string"},"region":{"type":"string"},"secret_key":{"type":"string"}},"required":["access_key","bucket","endpoint","path","region","secret_key"],"type":"object"},"AnalysisGoogleAISettingsSchema":{"properties":{"bucket_name":{"type":"string"},"is_system":{"type":"boolean"},"json_key":{"type":"string"}},"required":["bucket_name","json_key"],"type":"object"},"AnalysisIconikSettingsSchema":{"properties":{"is_system":{"type":"boolean"}},"type":"object"},"AnalysisProfileAmazonRekognitionSettingsSchema":{"properties":{"is_system":{"type":"boolean"},"min_confidence":{"format":"int32","maximum":100,"minimum":0,"type":"integer"}},"type":"object"},"AnalysisProfileBaseSchema":{"properties":{},"type":"object"},"AnalysisProfileGoogleVideoIntelligenceSettingsSchema":{"properties":{"frame_confidence_threshold":{"maximum":0.9,"minimum":0.1,"type":"number"},"is_system":{"type":"boolean"},"video_confidence_threshold":{"maximum":0.9,"minimum":0.1,"type":"number"}},"type":"object"},"AnalysisProfileGoogleVisionSettingsSchema":{"properties":{"is_system":{"type":"boolean"},"min_confidence":{"maximum":1,"minimum":0,"type":"number"}},"type":"object"},"AnalysisProfileIconikFaceRecognitionSettingsSchema":{"properties":{"confirmed_face_match_threshold":{"maximum":1,"minimum":0,"type":"number"},"detection_threshold":{"maximum":1,"minimum":0,"type":"number"},"directory_path":{"type":"string"},"is_system":{"type":"boolean"},"storage_id":{"format":"uuid","type":"string"},"unconfirmed_face_match_threshold":{"maximum":1,"minimum":0,"type":"number"}},"required":["directory_path","storage_id"],"type":"object"},"AnalysisProfileRevAISettingsSchema":{"properties":{"is_system":{"type":"boolean"},"min_confidence":{"maximum":1,"minimum":0,"type":"number"}},"type":"object"},"AnalysisProfileSchema":{"properties":{"analysis_service_account_id":{"format":"uuid","type":"string"},"enabled":{"type":"boolean"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_default":{"readOnly":true,"type":"boolean"},"media_type":{"enum":["image","video","transcription","face_image","face_video"],"type":"string"},"name":{"type":"string"},"service_type":{"enum":["GOOGLE_VISION","GOOGLE_VIDEO_INTELLIGENCE","AMAZON_REKOGNITION","REV_AI","ICONIK","ICONIK_FACE_RECOGNITION"],"type":"string"},"settings":{"type":"object"}},"required":["analysis_service_account_id","media_type","name"],"type":"object"},"AnalysisProfileServiceIdSchema":{"properties":{"analysis_service_account_id":{"format":"uuid","type":"string"}},"required":["analysis_service_account_id"],"type":"object"},"AnalysisProfileSettingsSchema":{"properties":{"is_system":{"type":"boolean"}},"type":"object"},"AnalysisProfilesSchema":{"properties":{"objects":{"items":{"$ref":"#/components/schemas/AnalysisProfileSchema"},"readOnly":true,"type":"array"}},"type":"object"},"AnalysisRevAISettingsSchema":{"properties":{"access_token":{"type":"string"},"custom_vocabulary":{"items":{"type":"string"},"nullable":true,"type":"array"},"is_system":{"type":"boolean"},"metadata_view_id":{"description":"View in which to save topic extraction time-based metadata","nullable":true,"type":"string"},"summary_metadata_field":{"description":"If a transcription summary is requested, save it to this metadata field","nullable":true,"type":"string"},"topics_metadata_field":{"description":"If topics extraction is requested, save result to this metadata field","nullable":true,"type":"string"}},"required":["access_token"],"type":"object"},"AnalysisServiceAccountBaseSchema":{"properties":{},"type":"object"},"AnalysisServiceAccountReadSchema":{"properties":{"id":{"format":"uuid","readOnly":true,"type":"string"},"method":{"enum":["GOOGLE_AI","AMAZON","REV_AI","ICONIK"],"type":"string"},"name":{"type":"string"},"settings":{"type":"object"}},"required":["method","name","settings"],"type":"object"},"AnalysisServiceAccountSchema":{"properties":{"id":{"format":"uuid","readOnly":true,"type":"string"},"method":{"enum":["GOOGLE_AI","AMAZON","REV_AI","ICONIK"],"type":"string"},"name":{"type":"string"},"settings":{"type":"object"}},"required":["method","name","settings"],"type":"object"},"AnalysisServiceAccountsSchema":{"properties":{"objects":{"items":{"$ref":"#/components/schemas/AnalysisServiceAccountReadSchema"},"readOnly":true,"type":"array"}},"type":"object"},"AnalysisTranscriptionSettingsSchema":{"properties":{"analysis_service_account_id":{"format":"uuid","type":"string"},"analysis_service_account_settings":{"type":"object"},"enabled":{"type":"boolean"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_default":{"readOnly":true,"type":"boolean"},"media_type":{"enum":["image","video","transcription","face_image","face_video"],"type":"string"},"name":{"type":"string"},"service_type":{"enum":["GOOGLE_VISION","GOOGLE_VIDEO_INTELLIGENCE","AMAZON_REKOGNITION","REV_AI","ICONIK","ICONIK_FACE_RECOGNITION"],"type":"string"},"settings":{"type":"object"}},"required":["analysis_service_account_id","media_type","name"],"type":"object"},"ArchiveAssetFormatSchema":{"properties":{"delete_original":{"default":false,"type":"boolean"},"destination_directory_path":{"type":"string"},"destination_filename":{"type":"string"},"destination_storage_id":{"format":"uuid","nullable":true,"type":"string"},"preferred_original_storage_id":{"format":"uuid","nullable":true,"type":"string"}},"type":"object"},"ArchiveAssetRequest":{"properties":{"all_versions":{"default":false,"type":"boolean"},"delete_only_from_source":{"default":false,"type":"boolean"},"delete_only_from_source_context":{"$ref":"#/components/schemas/SourceContext"},"delete_original":{"default":false,"type":"boolean"},"destination_directory_path":{"default":null,"nullable":true,"type":"string"},"formats":{"description":"List of format names to transfer. If not specified, all formats will be transferred.","items":{"type":"string"},"type":"array"},"id":{"description":"ID of the object to transfer.","format":"uuid","type":"string"},"preferred_original_storage_id":{"default":null,"format":"uuid","nullable":true,"type":"string"},"version_ids":{"description":"List of version IDs to transfer.","items":{"format":"uuid","type":"string"},"type":"array"}},"required":["id"],"type":"object"},"ArchiveAssetRequestSchema":{"properties":{"all_versions":{"default":false,"type":"boolean"},"delete_only_from_source":{"default":false,"type":"boolean"},"delete_only_from_source_context":{"$ref":"#/components/schemas/SourceContext"},"delete_original":{"default":false,"type":"boolean"},"destination_directory_path":{"default":null,"nullable":true,"type":"string"},"formats":{"description":"List of format names to transfer. If not specified, all formats will be transferred.","items":{"type":"string"},"type":"array"},"id":{"description":"ID of the object to transfer.","format":"uuid","type":"string"},"preferred_original_storage_id":{"default":null,"format":"uuid","nullable":true,"type":"string"},"version_ids":{"description":"List of version IDs to transfer.","items":{"format":"uuid","type":"string"},"type":"array"}},"required":["id"],"type":"object"},"ArchiveCollectionRequest":{"properties":{"all_versions":{"default":false,"type":"boolean"},"delete_only_from_source":{"default":false,"type":"boolean"},"delete_only_from_source_context":{"$ref":"#/components/schemas/SourceContext"},"delete_original":{"default":false,"type":"boolean"},"destination_directory_path":{"default":null,"nullable":true,"type":"string"},"formats":{"description":"List of format names to transfer. If not specified, all formats will be transferred.","items":{"type":"string"},"type":"array"},"id":{"description":"ID of the object to transfer.","format":"uuid","type":"string"},"keep_collection_structure":{"default":false,"description":"Whether to keep the collection structure when archiving collections.","type":"boolean"},"keep_parent_collection_structure":{"default":false,"description":"Whether to keep the parent collection structure when archiving collections.","type":"boolean"},"preferred_original_storage_id":{"default":null,"format":"uuid","nullable":true,"type":"string"}},"required":["id"],"type":"object"},"ArchiveCollectionRequestSchema":{"properties":{"all_versions":{"default":false,"type":"boolean"},"delete_only_from_source":{"default":false,"type":"boolean"},"delete_only_from_source_context":{"$ref":"#/components/schemas/SourceContext"},"delete_original":{"default":false,"type":"boolean"},"destination_directory_path":{"default":null,"nullable":true,"type":"string"},"formats":{"description":"List of format names to transfer. If not specified, all formats will be transferred.","items":{"type":"string"},"type":"array"},"id":{"description":"ID of the object to transfer.","format":"uuid","type":"string"},"keep_collection_structure":{"default":false,"description":"Whether to keep the collection structure when archiving collections.","type":"boolean"},"keep_parent_collection_structure":{"default":false,"description":"Whether to keep the parent collection structure when archiving collections.","type":"boolean"},"preferred_original_storage_id":{"default":null,"format":"uuid","nullable":true,"type":"string"}},"required":["id"],"type":"object"},"ArchiveSavedSearchRequest":{"properties":{"all_versions":{"default":false,"type":"boolean"},"delete_only_from_source":{"default":false,"type":"boolean"},"delete_only_from_source_context":{"$ref":"#/components/schemas/SourceContext"},"delete_original":{"default":false,"type":"boolean"},"destination_directory_path":{"default":null,"nullable":true,"type":"string"},"formats":{"description":"List of format names to transfer. If not specified, all formats will be transferred.","items":{"type":"string"},"type":"array"},"id":{"description":"ID of the object to transfer.","format":"uuid","type":"string"},"preferred_original_storage_id":{"default":null,"format":"uuid","nullable":true,"type":"string"}},"required":["id"],"type":"object"},"ArchiveSavedSearchRequestSchema":{"properties":{"all_versions":{"default":false,"type":"boolean"},"delete_only_from_source":{"default":false,"type":"boolean"},"delete_only_from_source_context":{"$ref":"#/components/schemas/SourceContext"},"delete_original":{"default":false,"type":"boolean"},"destination_directory_path":{"default":null,"nullable":true,"type":"string"},"formats":{"description":"List of format names to transfer. If not specified, all formats will be transferred.","items":{"type":"string"},"type":"array"},"id":{"description":"ID of the object to transfer.","format":"uuid","type":"string"},"preferred_original_storage_id":{"default":null,"format":"uuid","nullable":true,"type":"string"}},"required":["id"],"type":"object"},"AssetBatchExportItemSchema":{"properties":{"asset_id":{"format":"uuid","type":"string"},"file_name":{"nullable":true,"type":"string"},"format_id":{"format":"uuid","nullable":true,"type":"string"}},"required":["asset_id"],"type":"object"},"AssetBatchExportSchema":{"properties":{"assets":{"items":{"$ref":"#/components/schemas/AssetBatchExportItemSchema"},"type":"array"},"export_metadata":{"nullable":true,"type":"boolean"},"export_to_asset_folder":{"nullable":true,"type":"boolean"},"metadata_format":{"enum":["CSV","JSON","XML"],"nullable":true,"type":"string"},"metadata_view":{"format":"uuid","nullable":true,"type":"string"},"overwrite":{"nullable":true,"type":"boolean"},"preferred_original_storage_id":{"format":"uuid","nullable":true,"type":"string"},"transcode_profile_ids":{"items":{"format":"uuid","type":"string"},"nullable":true,"type":"array"}},"required":["assets"],"type":"object"},"AssetExportSchema":{"properties":{"export_metadata":{"nullable":true,"type":"boolean"},"export_to_asset_folder":{"nullable":true,"type":"boolean"},"file_name":{"nullable":true,"type":"string"},"format_id":{"format":"uuid","nullable":true,"type":"string"},"metadata_format":{"enum":["CSV","JSON","XML"],"nullable":true,"type":"string"},"metadata_view":{"format":"uuid","nullable":true,"type":"string"},"overwrite":{"nullable":true,"type":"boolean"},"preferred_original_storage_id":{"format":"uuid","nullable":true,"type":"string"},"transcode_profile_ids":{"items":{"format":"uuid","type":"string"},"nullable":true,"type":"array"}},"type":"object"},"AssetLinkProxySchema":{"properties":{"asset_id":{"format":"uuid","type":"string"},"filename":{"type":"string"},"name":{"type":"string"},"url":{"format":"url","type":"string"},"version_id":{"format":"uuid","type":"string"}},"required":["asset_id","url","version_id"],"type":"object"},"AssetSubclipKeyframesSchema":{"properties":{"asset_id":{"format":"uuid","type":"string"},"filename":{"type":"string"},"name":{"type":"string"},"original_asset_id":{"format":"uuid","type":"string"},"original_segment_id":{"format":"uuid","type":"string"},"original_version_id":{"format":"uuid","type":"string"},"time_end_milliseconds":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"time_start_milliseconds":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"version_id":{"format":"uuid","type":"string"}},"required":["asset_id","original_asset_id","original_version_id","time_end_milliseconds","time_start_milliseconds","version_id"],"type":"object"},"AssetVersionKeyframesSchema":{"properties":{"asset_id":{"format":"uuid","type":"string"},"keyframes":{"items":{"$ref":"#/components/schemas/Keyframe"},"readOnly":true,"type":"array"},"version_id":{"type":"string"}},"required":["asset_id","version_id"],"type":"object"},"AssetVersionsKeyframesSchema":{"properties":{"objects":{"items":{"$ref":"#/components/schemas/AssetVersionKeyframesSchema"},"type":"array"}},"type":"object"},"AzureSettingsSchema":{"properties":{"access_group_id":{"format":"uuid","nullable":true,"type":"string"},"acl_template_id":{"format":"uuid","nullable":true,"type":"string"},"add_uuid_to_filenames":{"type":"boolean"},"aggregate_identical_files":{"type":"boolean"},"aggregate_ignore":{"items":{"type":"string"},"type":"array"},"aggregate_only_on_same_storage":{"type":"boolean"},"connection_string":{"type":"string"},"container":{"type":"string"},"delete":{"type":"boolean"},"enable_collection_directory_mapping":{"type":"boolean"},"filename_is_external_id":{"type":"boolean"},"folder_name_tags_metadata_field_name":{"type":"string"},"folder_name_tags_metadata_view_id":{"format":"uuid","nullable":true,"type":"string"},"is_system":{"type":"boolean"},"metadata_conversion_url":{"type":"string"},"metadata_conversion_url_headers":{"nullable":true,"type":"string"},"metadata_view_id":{"format":"uuid","nullable":true,"type":"string"},"path":{"type":"string"},"preload_edge_jobs":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"read":{"type":"boolean"},"root_collection_id":{"format":"uuid","type":"string"},"scan":{"type":"boolean"},"scan_directories":{"items":{"type":"string"},"type":"array"},"scan_ignore":{"items":{"type":"string"},"type":"array"},"sidecar_metadata_required":{"type":"boolean"},"title_includes_extension":{"type":"boolean"},"transcode_ignore":{"items":{"type":"string"},"type":"array"},"write":{"type":"boolean"}},"required":["connection_string","container","path"],"type":"object"},"B2SettingsSchema":{"properties":{"access_group_id":{"format":"uuid","nullable":true,"type":"string"},"account_id":{"type":"string"},"acl_template_id":{"format":"uuid","nullable":true,"type":"string"},"add_uuid_to_filenames":{"type":"boolean"},"aggregate_identical_files":{"type":"boolean"},"aggregate_ignore":{"items":{"type":"string"},"type":"array"},"aggregate_only_on_same_storage":{"type":"boolean"},"authorization_token":{"type":"string"},"bucket_id":{"type":"string"},"bucket_name":{"type":"string"},"delete":{"type":"boolean"},"enable_collection_directory_mapping":{"type":"boolean"},"filename_is_external_id":{"type":"boolean"},"folder_name_tags_metadata_field_name":{"type":"string"},"folder_name_tags_metadata_view_id":{"format":"uuid","nullable":true,"type":"string"},"is_system":{"type":"boolean"},"metadata_conversion_url":{"type":"string"},"metadata_conversion_url_headers":{"nullable":true,"type":"string"},"metadata_view_id":{"format":"uuid","nullable":true,"type":"string"},"path":{"type":"string"},"preload_edge_jobs":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"read":{"type":"boolean"},"root_collection_id":{"format":"uuid","type":"string"},"scan":{"type":"boolean"},"scan_directories":{"items":{"type":"string"},"type":"array"},"scan_ignore":{"items":{"type":"string"},"type":"array"},"sidecar_metadata_required":{"type":"boolean"},"title_includes_extension":{"type":"boolean"},"transcode_ignore":{"items":{"type":"string"},"type":"array"},"write":{"type":"boolean"}},"required":["account_id","authorization_token","bucket_id","bucket_name","path"],"type":"object"},"BaseExportSchema":{"properties":{"export_metadata":{"nullable":true,"type":"boolean"},"export_to_asset_folder":{"nullable":true,"type":"boolean"},"metadata_format":{"enum":["CSV","JSON","XML"],"nullable":true,"type":"string"},"metadata_view":{"format":"uuid","nullable":true,"type":"string"},"overwrite":{"nullable":true,"type":"boolean"},"preferred_original_storage_id":{"format":"uuid","nullable":true,"type":"string"}},"type":"object"},"BaseQueryParamsSchema":{"properties":{"page":{"default":1,"description":"Which page number to fetch","format":"int32","maximum":10000,"minimum":1,"nullable":true,"type":"integer"},"per_page":{"default":10,"description":"The number of items for each page","format":"int32","maximum":1000,"minimum":1,"nullable":true,"type":"integer"},"sort":{"description":"A comma separated list of fieldnames with order (asc/desc)","type":"string"}},"type":"object"},"BulkActionSchema":{"properties":{"object_ids":{"items":{"format":"uuid","type":"string"},"maxItems":500,"minItems":1,"type":"array"},"object_type":{"enum":["assets","collections","playlists","saved_searches"],"type":"string"}},"required":["object_ids","object_type"],"type":"object"},"BulkArchiveAssetRequestSchema":{"properties":{"destination_storage_id":{"default":null,"description":"ID of the storage to archive the assets to.","format":"uuid","nullable":true,"type":"string"},"objects":{"description":"List of assets to archive. Each asset should contain the asset ID.","items":{"$ref":"#/components/schemas/ArchiveAssetRequest"},"type":"array"},"parent_job_id":{"default":null,"description":"Parent job ID","format":"uuid","nullable":true,"type":"string"}},"type":"object"},"BulkArchiveAssetSchema":{"properties":{"all_versions":{"description":"If true, all versions of the asset will be transferred","type":"boolean"},"asset_ids":{"items":{"format":"uuid","type":"string"},"maxItems":500,"minItems":1,"type":"array"},"delete_only_from_source_folder":{"default":false,"type":"boolean"},"delete_original":{"default":false,"type":"boolean"},"destination_directory_path":{"type":"string"},"destination_storage_id":{"format":"uuid","nullable":true,"type":"string"},"formats":{"description":"List of format names to transfer. If not specified, all formats will be transferred.","items":{"type":"string"},"type":"array"},"preferred_original_storage_id":{"format":"uuid","nullable":true,"type":"string"}},"required":["asset_ids"],"type":"object"},"BulkArchiveCollectionRequestSchema":{"properties":{"destination_storage_id":{"default":null,"description":"ID of the storage to archive the collections to.","format":"uuid","nullable":true,"type":"string"},"objects":{"description":"List of collections to archive. Each collection should contain the collection ID.","items":{"$ref":"#/components/schemas/ArchiveCollectionRequest"},"type":"array"}},"type":"object"},"BulkArchiveSavedSearchRequestSchema":{"properties":{"destination_storage_id":{"default":null,"description":"ID of the storage to archive the saved searches to.","format":"uuid","nullable":true,"type":"string"},"objects":{"description":"List of saved searches to archive. Each saved search should contain the saved search ID.","items":{"$ref":"#/components/schemas/ArchiveSavedSearchRequest"},"type":"array"}},"type":"object"},"BulkAssetIdsWithFiles":{"properties":{"asset_ids":{"items":{"format":"uuid","type":"string"},"type":"array"}},"type":"object"},"BulkCheckAssetHasFilesSchema":{"properties":{"objects":{"items":{"$ref":"#/components/schemas/CheckAssetHasFiles"},"type":"array"}},"required":["objects"],"type":"object"},"BulkExportAssetRequestSchema":{"properties":{"objects":{"description":"List of assets to export. Each asset should contain the asset ID.","items":{"$ref":"#/components/schemas/ExportAssetRequest"},"type":"array"},"parent_job_id":{"default":null,"description":"Parent job ID","format":"uuid","nullable":true,"type":"string"}},"type":"object"},"BulkExportCollectionRequestSchema":{"properties":{"objects":{"description":"List of collections to export. Each collection should contain the collection ID.","items":{"$ref":"#/components/schemas/ExportCollectionRequest"},"type":"array"}},"type":"object"},"BulkExportSavedSearchRequestSchema":{"properties":{"objects":{"description":"List of saved searches to export. Each saved search should contain the saved search ID.","items":{"$ref":"#/components/schemas/ExportSavedSearchRequest"},"type":"array"}},"type":"object"},"BulkFilesetArchiveSchema":{"properties":{"allow_duplicate_transfers":{"default":false,"type":"boolean"},"delete_only_from_source_folder":{"default":false,"type":"boolean"},"delete_original":{"default":false,"type":"boolean"},"destination_directory_path":{"nullable":true,"type":"string"},"destination_storage_id":{"default":null,"nullable":true,"type":"string"},"keep_collection_structure":{"default":false,"type":"boolean"},"keep_parent_collection_structure":{"default":false,"type":"boolean"},"object_ids":{"items":{"format":"uuid","type":"string"},"maxItems":500,"minItems":1,"type":"array"},"object_type":{"enum":["assets","collections","playlists","saved_searches"],"type":"string"},"preferred_original_storage_id":{"format":"uuid","nullable":true,"type":"string"}},"required":["object_ids","object_type"],"type":"object"},"BulkFilesetExportSchema":{"properties":{"allow_duplicate_transfers":{"default":false,"type":"boolean"},"delete_only_from_source_folder":{"default":false,"type":"boolean"},"delete_original":{"default":false,"type":"boolean"},"export_metadata":{"nullable":true,"type":"boolean"},"export_to_asset_folder":{"nullable":true,"type":"boolean"},"keep_collection_structure":{"default":false,"type":"boolean"},"metadata_format":{"enum":["CSV","JSON","XML"],"nullable":true,"type":"string"},"metadata_view":{"format":"uuid","nullable":true,"type":"string"},"object_ids":{"items":{"format":"uuid","type":"string"},"maxItems":500,"minItems":1,"type":"array"},"object_type":{"enum":["assets","collections"],"type":"string"},"overwrite":{"nullable":true,"type":"boolean"},"preferred_original_storage_id":{"format":"uuid","nullable":true,"type":"string"}},"required":["object_ids","object_type"],"type":"object"},"BulkFilesetRestoreSchema":{"properties":{"allow_duplicate_transfers":{"default":false,"type":"boolean"},"delete_only_from_source_folder":{"default":false,"type":"boolean"},"delete_original":{"default":false,"type":"boolean"},"destination_directory_path":{"nullable":true,"type":"string"},"destination_storage_id":{"format":"uuid","nullable":true,"type":"string"},"keep_collection_structure":{"default":false,"type":"boolean"},"keep_parent_collection_structure":{"default":false,"type":"boolean"},"object_ids":{"items":{"format":"uuid","type":"string"},"maxItems":500,"minItems":1,"type":"array"},"object_type":{"enum":["assets","collections","playlists","saved_searches"],"type":"string"},"preferred_original_storage_id":{"format":"uuid","nullable":true,"type":"string"}},"required":["object_ids","object_type"],"type":"object"},"BulkFilesetSchema":{"properties":{"ids":{"items":{"format":"uuid","type":"string"},"maxItems":500,"minItems":1,"type":"array"}},"required":["ids"],"type":"object"},"BulkRestoreAssetRequestSchema":{"properties":{"destination_storage_id":{"default":null,"description":"ID of the storage to restore the assets to.","format":"uuid","nullable":true,"type":"string"},"objects":{"description":"List of assets to restore. Each asset should contain the asset ID and the storage ID.","items":{"$ref":"#/components/schemas/RestoreAssetToStorageRequest"},"type":"array"},"parent_job_id":{"default":null,"description":"Parent job ID","format":"uuid","nullable":true,"type":"string"}},"type":"object"},"BulkRestoreCollectionRequestSchema":{"properties":{"destination_storage_id":{"default":null,"description":"ID of the storage to restore the saved searches to.","format":"uuid","nullable":true,"type":"string"},"objects":{"description":"List of collections to restore. Each collection should contain the collection ID.","items":{"$ref":"#/components/schemas/RestoreCollectionToStorageRequest"},"type":"array"}},"type":"object"},"BulkRestoreSavedSearchRequestSchema":{"properties":{"destination_storage_id":{"default":null,"description":"ID of the storage to restore the saved searches to.","format":"uuid","nullable":true,"type":"string"},"objects":{"description":"List of saved searches to restore. Each saved search should contain the saved search ID.","items":{"$ref":"#/components/schemas/RestoreSavedSearchToStorageRequest"},"type":"array"}},"type":"object"},"BulkTranscodeSchema":{"properties":{"format_name":{"default":"ORIGINAL","type":"string"},"object_ids":{"items":{"format":"uuid","type":"string"},"maxItems":500,"minItems":1,"type":"array"},"object_type":{"enum":["assets","collections","playlists","saved_searches"],"type":"string"},"prefer_any_cloud":{"type":"boolean"},"preferred_storage_id":{"format":"uuid","type":"string"},"preferred_storage_method":{"enum":["FILE","HTTP","FTP","SFTP","S3","B2","GCS","PORTAL","CUSTOM","AZURE"],"type":"string"},"priority":{"format":"int32","maximum":10,"minimum":1,"type":"integer"}},"required":["object_ids","object_type"],"type":"object"},"BulkTransferAssetRequestSchema":{"properties":{"objects":{"description":"List of assets to transfer. Each asset should contain the asset ID and the storage ID.","items":{"$ref":"#/components/schemas/TransferAssetToStorageRequest"},"type":"array"},"parent_job_id":{"default":null,"description":"Parent job ID","format":"uuid","nullable":true,"type":"string"}},"type":"object"},"BulkTransferAssetToStorageSchema":{"properties":{"all_versions":{"description":"If true, all versions of the asset will be transferred","type":"boolean"},"asset_ids":{"items":{"format":"uuid","type":"string"},"maxItems":500,"minItems":1,"type":"array"},"destination_directory_path":{"type":"string"},"formats":{"description":"List of format names to transfer. If not specified, all formats will be transferred.","items":{"type":"string"},"type":"array"}},"required":["asset_ids"],"type":"object"},"BulkTransferCollectionRequestSchema":{"properties":{"objects":{"description":"List of collections to transfer. Each collection should contain the collection ID.","items":{"$ref":"#/components/schemas/TransferCollectionToStorageRequest"},"type":"array"}},"type":"object"},"BulkTransferSavedSearchRequestSchema":{"properties":{"objects":{"description":"List of saved searches to transfer. Each saved search should contain the saved search ID.","items":{"$ref":"#/components/schemas/TransferSavedSearchToStorageRequest"},"type":"array"}},"type":"object"},"BulkTransferSchema":{"properties":{"allow_duplicate_transfers":{"default":false,"type":"boolean"},"delete_only_from_source_folder":{"default":false,"type":"boolean"},"delete_original":{"default":false,"type":"boolean"},"keep_collection_structure":{"default":false,"type":"boolean"},"object_ids":{"items":{"format":"uuid","type":"string"},"maxItems":500,"minItems":1,"type":"array"},"object_type":{"enum":["assets","collections","playlists","saved_searches"],"type":"string"},"preferred_original_storage_id":{"format":"uuid","nullable":true,"type":"string"}},"required":["object_ids","object_type"],"type":"object"},"BulkTransferToStorageSchema":{"properties":{"allow_duplicate_transfers":{"default":false,"type":"boolean"},"delete_only_from_source_folder":{"default":false,"type":"boolean"},"delete_original":{"default":false,"type":"boolean"},"file_path":{"nullable":true,"type":"string"},"format_name":{"default":"ORIGINAL","type":"string"},"keep_collection_structure":{"default":false,"type":"boolean"},"keep_parent_collection_structure":{"default":false,"type":"boolean"},"object_ids":{"items":{"format":"uuid","type":"string"},"maxItems":500,"minItems":1,"type":"array"},"object_type":{"enum":["assets","collections","playlists","saved_searches"],"type":"string"},"overwrite":{"default":false,"type":"boolean"},"preferred_original_storage_id":{"format":"uuid","nullable":true,"type":"string"}},"required":["object_ids","object_type"],"type":"object"},"CheckAssetHasFiles":{"properties":{"asset_id":{"format":"uuid","type":"string"},"version_id":{"format":"uuid","type":"string"}},"required":["asset_id","version_id"],"type":"object"},"CheckAssetHasFilesSchema":{"properties":{"asset_id":{"format":"uuid","type":"string"},"version_id":{"format":"uuid","type":"string"}},"required":["asset_id","version_id"],"type":"object"},"CollectionCopyKeyframesRequestSchema":{"properties":{"custom_keyframe":{"format":"uuid","nullable":true,"type":"string"},"custom_poster":{"format":"uuid","nullable":true,"type":"string"},"id":{"format":"uuid","type":"string"}},"required":["id"],"type":"object"},"CollectionCopyKeyframesResponseSchema":{"properties":{"custom_keyframe":{"format":"uuid","nullable":true,"type":"string"},"custom_poster":{"format":"uuid","nullable":true,"type":"string"}},"type":"object"},"CollectionExportSchema":{"properties":{"delete_original":{"nullable":true,"type":"boolean"},"export_metadata":{"nullable":true,"type":"boolean"},"export_to_asset_folder":{"nullable":true,"type":"boolean"},"keep_collection_structure":{"nullable":true,"type":"boolean"},"metadata_format":{"enum":["CSV","JSON","XML"],"nullable":true,"type":"string"},"metadata_view":{"format":"uuid","nullable":true,"type":"string"},"overwrite":{"nullable":true,"type":"boolean"},"preferred_original_storage_id":{"format":"uuid","nullable":true,"type":"string"}},"type":"object"},"CollectionKeyframeCreateSchema":{"properties":{"collection_id":{"format":"uuid","type":"string"},"content_type":{"type":"string","writeOnly":true},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"filename":{"type":"string"},"format":{"nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_custom_keyframe":{"type":"boolean"},"is_public":{"readOnly":true,"type":"boolean"},"name":{"type":"string"},"resolution":{"$ref":"#/components/schemas/ResolutionType"},"rotation":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"nullable":true,"type":"integer"},"status":{"enum":["OPEN","GROWING","AWAITED","CLOSED","FAILED","ARCHIVED","MISSING","REDISCOVERED","DELETED"],"type":"string"},"storage_id":{"format":"uuid","type":"string"},"time_code":{"$ref":"#/components/schemas/TimeCodeType"},"type":{"enum":["KEYFRAME_MAP","KEYFRAME","POSTER"],"type":"string"},"upload_credentials":{"readOnly":true,"type":"object"},"upload_method":{"readOnly":true,"type":"string"},"upload_url":{"readOnly":true,"type":"string"},"url":{"readOnly":true,"type":"string"}},"required":["type"],"type":"object"},"CollectionKeyframeSchema":{"properties":{"collection_id":{"format":"uuid","type":"string"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"filename":{"type":"string"},"format":{"nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_custom_keyframe":{"type":"boolean"},"is_public":{"readOnly":true,"type":"boolean"},"name":{"type":"string"},"resolution":{"$ref":"#/components/schemas/ResolutionType"},"rotation":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"nullable":true,"type":"integer"},"status":{"enum":["OPEN","GROWING","AWAITED","CLOSED","FAILED","ARCHIVED","MISSING","REDISCOVERED","DELETED"],"type":"string"},"storage_id":{"format":"uuid","type":"string"},"time_code":{"$ref":"#/components/schemas/TimeCodeType"},"type":{"enum":["KEYFRAME_MAP","KEYFRAME","POSTER"],"type":"string"},"url":{"readOnly":true,"type":"string"}},"required":["type"],"type":"object"},"CollectionKeyframeUpdateSchema":{"properties":{"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"filename":{"type":"string"},"format":{"nullable":true,"type":"string"},"is_custom_keyframe":{"type":"boolean"},"is_public":{"readOnly":true,"type":"boolean"},"name":{"type":"string"},"resolution":{"$ref":"#/components/schemas/ResolutionType"},"rotation":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"nullable":true,"type":"integer"},"status":{"enum":["OPEN","GROWING","AWAITED","CLOSED","FAILED","ARCHIVED","MISSING","REDISCOVERED","DELETED"],"type":"string"},"time_code":{"$ref":"#/components/schemas/TimeCodeType"},"type":{"enum":["KEYFRAME_MAP","KEYFRAME","POSTER"],"type":"string"},"url":{"readOnly":true,"type":"string"}},"required":["type"],"type":"object"},"CollectionKeyframesSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/CollectionKeyframeSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"CompleteExportToLocalStorageSchema":{"properties":{"add_file_set":{"type":"boolean"},"asset_id":{"format":"uuid","type":"string"},"asset_paths":{"items":{"type":"string"},"type":"array"},"collection_storage_id":{"format":"uuid","type":"string"},"component_ids":{"items":{"format":"uuid","type":"string"},"type":"array"},"delete_only_from_source_folder":{"type":"boolean"},"delete_remote_file_set_after_download":{"type":"boolean"},"delete_source_file_set_after_download":{"type":"boolean"},"destination_base_directory":{"type":"string"},"destination_directory_path":{"type":"string"},"destination_file_set_name":{"type":"string"},"destination_filename":{"type":"string"},"export_metadata_format":{"type":"string"},"export_metadata_view":{"format":"uuid","type":"string"},"export_original":{"type":"boolean"},"export_posters":{"type":"boolean"},"export_proxy":{"type":"boolean"},"export_transcription_format":{"type":"string"},"file_set_id":{"format":"uuid","type":"string"},"format_id":{"format":"uuid","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"include_original_extension":{"type":"boolean"},"job_id":{"format":"uuid","type":"string"},"job_steps":{"type":"object"},"local_storage_id":{"format":"uuid","type":"string"},"original_storage_id":{"format":"uuid","type":"string"},"original_url":{"format":"url","type":"string"},"overwrite":{"type":"boolean"},"parent_job_id":{"format":"uuid","type":"string"},"temporary_file_set_source":{"type":"boolean"},"transfer_type":{"readOnly":true,"type":"string"}},"required":["destination_directory_path","destination_file_set_name"],"type":"object"},"ComponentSchema":{"properties":{"id":{"format":"uuid","readOnly":true,"type":"string"},"metadata":{"additionalProperties":{"type":"string"},"description":"Sequence cannot have more than 10000. Excess values will be stripped","type":"object"},"name":{"type":"string"},"type":{"enum":["VIDEO","AUDIO","IMAGE","TEXT","OTHER","NON_MEDIA","EXIF","IPTC","XMP","GENERAL","MANIFEST"],"type":"string"}},"required":["name","type"],"type":"object"},"ComponentsSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/ComponentSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"CustomSettingsSchema":{"properties":{"custom":{"type":"string"},"delete":{"type":"boolean"},"is_system":{"type":"boolean"},"read":{"type":"boolean"},"write":{"type":"boolean"}},"type":"object"},"DeleteQueueFileSetsQueryParamsSchema":{"properties":{"page":{"default":1,"description":"Which page number to fetch","format":"int32","maximum":10000,"minimum":1,"nullable":true,"type":"integer"},"per_page":{"default":10,"description":"The number of items for each page","format":"int32","maximum":1000,"minimum":1,"nullable":true,"type":"integer"},"sort":{"description":"A comma separated list of fieldnames with order (asc/desc)","type":"string"}},"type":"object"},"DeleteQueueFormatsQueryParamsSchema":{"properties":{"page":{"default":1,"description":"Which page number to fetch","format":"int32","maximum":10000,"minimum":1,"nullable":true,"type":"integer"},"per_page":{"default":10,"description":"The number of items for each page","format":"int32","maximum":1000,"minimum":1,"nullable":true,"type":"integer"},"sort":{"description":"A comma separated list of fieldnames with order (asc/desc)","type":"string"}},"type":"object"},"DeleteQueueSchema":{"properties":{"ids":{"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["ids"],"type":"object"},"EditProxyResponseSchema":{"properties":{"audio_bitrate":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"audio_codec":{"type":"string"},"bitrate":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"codec":{"type":"string"},"directory_path":{"type":"string"},"file_set_id":{"format":"uuid","type":"string"},"format_id":{"format":"uuid","type":"string"},"height":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"id":{"format":"uuid","type":"string"},"name":{"type":"string"},"transcoder_id":{"format":"uuid","type":"string"},"type":{"type":"string"},"width":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"}},"type":"object"},"EditProxySchema":{"properties":{"allow_mxf":{"nullable":true,"type":"boolean"},"directory_path":{"nullable":true,"type":"string"},"file_suffix":{"nullable":true,"type":"string"},"force_storage_id":{"type":"boolean"},"height":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"ignore_transcoder_settings":{"type":"boolean"},"keep_extension":{"nullable":true,"type":"boolean"},"name":{"type":"string"},"storage_id":{"format":"uuid","type":"string"},"version_id":{"format":"uuid","type":"string"},"width":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"}},"required":["directory_path","height","name","storage_id","version_id","width"],"type":"object"},"EditProxySettingsSchema":{"properties":{"audio_bitrate":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"audio_codec":{"nullable":true,"type":"string"},"bitrate":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"codec":{"type":"string"},"data":{"type":"string"},"delete_after_upload":{"type":"boolean"},"destination_path":{"nullable":true,"type":"string"},"exclude_patterns":{"items":{"type":"string"},"type":"array"},"height":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"include_patterns":{"items":{"type":"string"},"type":"array"},"local":{"type":"boolean"},"local_destination_path":{"nullable":true,"type":"string"},"min_height":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"min_width":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"priority":{"format":"int32","maximum":10,"minimum":1,"nullable":true,"type":"integer"},"storage_id":{"format":"uuid","nullable":true,"type":"string"},"width":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"}},"required":["height","width"],"type":"object"},"EditReadyTranscoderSchema":{"properties":{"apply_color_conversion":{"type":"boolean"},"bitrate":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"create_edit_proxy":{"type":"boolean"},"delete_after_upload":{"type":"boolean"},"edit_proxy_height":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"edit_proxy_local_storage_path":{"type":"string"},"edit_proxy_upload_storage_id":{"type":"string"},"edit_proxy_upload_storage_path":{"type":"string"},"edit_proxy_width":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"editready_preset":{"type":"string"},"exclude_patterns":{"items":{"type":"string"},"type":"array"},"include_patterns":{"items":{"type":"string"},"type":"array"},"local":{"type":"boolean"},"min_height":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"min_width":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"overwrite_edit_proxy":{"type":"boolean"},"videocodec":{"enum":["Apple_ProRes_422_HQ","Apple_ProRes_422","Apple_ProRes_4444","Apple_ProRes_422_LT","Apple_ProRes_422_Proxy"],"type":"string"},"width":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"}},"required":["width"],"type":"object"},"ElementalMediaConvertSchema":{"properties":{"access_key":{"type":"string"},"edit_proxy_directory_path":{"nullable":true,"type":"string"},"edit_proxy_storage_id":{"format":"uuid","nullable":true,"type":"string"},"endpoint_url":{"type":"string"},"exclude_patterns":{"items":{"type":"string"},"type":"array"},"file_group_custom_name":{"type":"string"},"iam_role":{"type":"string"},"include_patterns":{"items":{"type":"string"},"type":"array"},"job_template_name":{"type":"string"},"keyframe_storage_id":{"format":"uuid","nullable":true,"type":"string"},"local":{"type":"boolean"},"priority":{"format":"int32","maximum":10,"minimum":1,"nullable":true,"type":"integer"},"proxy_storage_id":{"format":"uuid","nullable":true,"type":"string"},"queue_name":{"type":"string"},"region_name":{"type":"string"},"s3_endpoint_url":{"type":"string"},"s3_region_name":{"type":"string"},"secret_key":{"type":"string"},"temp_upload_path":{"type":"string"}},"required":["access_key","endpoint_url","file_group_custom_name","iam_role","job_template_name","region_name","s3_endpoint_url","secret_key"],"type":"object"},"ElementalServerSchema":{"properties":{"api_key":{"type":"string"},"base_url":{"type":"string"},"exclude_patterns":{"items":{"type":"string"},"type":"array"},"include_patterns":{"items":{"type":"string"},"type":"array"},"keyframe_map_output_group_order":{"format":"int32","minimum":1,"type":"integer"},"keyframe_output_group_order":{"format":"int32","minimum":1,"type":"integer"},"local":{"type":"boolean"},"mount_point":{"type":"string"},"priority":{"format":"int32","maximum":10,"minimum":1,"nullable":true,"type":"integer"},"profile":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"proxy_output_group_order":{"format":"int32","minimum":1,"type":"integer"},"username":{"type":"string"}},"required":["api_key","base_url","mount_point","profile","username"],"type":"object"},"EncodingComSettingsSchema":{"properties":{"exclude_patterns":{"items":{"type":"string"},"type":"array"},"include_patterns":{"items":{"type":"string"},"type":"array"},"local":{"type":"boolean"},"priority":{"format":"int32","maximum":10,"minimum":1,"nullable":true,"type":"integer"},"user_id":{"type":"string"},"user_key":{"type":"string"}},"required":["user_id","user_key"],"type":"object"},"ExportAssetRequest":{"properties":{"destination_filename":{"default":null,"description":"Name of the file to export.","nullable":true,"type":"string"},"export_metadata":{"default":null,"description":"Whether to export metadata.","nullable":true,"type":"boolean"},"export_to_asset_folder":{"default":false,"description":"Whether to export to asset folder.","type":"boolean"},"formats":{"description":"List containing a single format name to transfer. If not specified, ORIGINAL will be transferred.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"id":{"description":"ID of the object to export.","format":"uuid","type":"string"},"overwrite":{"default":false,"description":"Whether to overwrite existing files.","type":"boolean"},"preferred_original_storage_id":{"default":null,"format":"uuid","nullable":true,"type":"string"}},"required":["id"],"type":"object"},"ExportAssetRequestSchema":{"properties":{"destination_filename":{"default":null,"description":"Name of the file to export.","nullable":true,"type":"string"},"export_metadata":{"default":null,"description":"Whether to export metadata.","nullable":true,"type":"boolean"},"export_to_asset_folder":{"default":false,"description":"Whether to export to asset folder.","type":"boolean"},"formats":{"description":"List containing a single format name to transfer. If not specified, ORIGINAL will be transferred.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"id":{"description":"ID of the object to export.","format":"uuid","type":"string"},"overwrite":{"default":false,"description":"Whether to overwrite existing files.","type":"boolean"},"preferred_original_storage_id":{"default":null,"format":"uuid","nullable":true,"type":"string"}},"required":["id"],"type":"object"},"ExportCollectionRequest":{"properties":{"export_metadata":{"default":null,"description":"Whether to export metadata.","nullable":true,"type":"boolean"},"export_to_asset_folder":{"default":false,"description":"Whether to export to asset folder.","type":"boolean"},"formats":{"description":"List containing a single format name to transfer. If not specified, ORIGINAL will be transferred.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"id":{"description":"ID of the object to export.","format":"uuid","type":"string"},"keep_collection_structure":{"default":false,"description":"Whether to keep the collection structure when exporting collections.","type":"boolean"},"keep_parent_collection_structure":{"default":false,"description":"Whether to keep the parent collection structure when transferring collections.","type":"boolean"},"overwrite":{"default":false,"description":"Whether to overwrite existing files.","type":"boolean"},"preferred_original_storage_id":{"default":null,"format":"uuid","nullable":true,"type":"string"}},"required":["id"],"type":"object"},"ExportCollectionRequestSchema":{"properties":{"export_metadata":{"default":null,"description":"Whether to export metadata.","nullable":true,"type":"boolean"},"export_to_asset_folder":{"default":false,"description":"Whether to export to asset folder.","type":"boolean"},"formats":{"description":"List containing a single format name to transfer. If not specified, ORIGINAL will be transferred.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"id":{"description":"ID of the object to export.","format":"uuid","type":"string"},"keep_collection_structure":{"default":false,"description":"Whether to keep the collection structure when exporting collections.","type":"boolean"},"keep_parent_collection_structure":{"default":false,"description":"Whether to keep the parent collection structure when transferring collections.","type":"boolean"},"overwrite":{"default":false,"description":"Whether to overwrite existing files.","type":"boolean"},"preferred_original_storage_id":{"default":null,"format":"uuid","nullable":true,"type":"string"}},"required":["id"],"type":"object"},"ExportLocationSchema":{"properties":{"description":{"type":"string"},"export_metadata":{"type":"boolean"},"export_original":{"type":"boolean"},"export_posters":{"type":"boolean"},"export_proxy":{"type":"boolean"},"export_to_asset_folder":{"type":"boolean"},"export_transcriptions":{"type":"boolean"},"id":{"format":"uuid","readOnly":true,"type":"string"},"include_original_extension":{"type":"boolean"},"metadata_format":{"enum":["CSV","JSON","XML"],"type":"string"},"metadata_view":{"format":"uuid","type":"string"},"name":{"type":"string"},"path":{"type":"string"},"storage_id":{"format":"uuid","type":"string"},"system_domain_id":{"format":"uuid","readOnly":true,"type":"string"},"transcode_profile_ids":{"items":{"format":"uuid","type":"string"},"type":"array"},"transcription_format":{"enum":["WEBVTT","SRT"],"type":"string"}},"required":["name","path","storage_id"],"type":"object"},"ExportLocationsSchema":{"properties":{"facets":{"type":"object"},"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/ExportLocationSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"ExportSavedSearchRequest":{"properties":{"export_metadata":{"default":null,"description":"Whether to export metadata.","nullable":true,"type":"boolean"},"export_to_asset_folder":{"default":false,"description":"Whether to export to asset folder.","type":"boolean"},"formats":{"description":"List containing a single format name to transfer. If not specified, ORIGINAL will be transferred.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"id":{"description":"ID of the object to export.","format":"uuid","type":"string"},"overwrite":{"default":false,"description":"Whether to overwrite existing files.","type":"boolean"},"preferred_original_storage_id":{"default":null,"format":"uuid","nullable":true,"type":"string"}},"required":["id"],"type":"object"},"ExportSavedSearchRequestSchema":{"properties":{"export_metadata":{"default":null,"description":"Whether to export metadata.","nullable":true,"type":"boolean"},"export_to_asset_folder":{"default":false,"description":"Whether to export to asset folder.","type":"boolean"},"formats":{"description":"List containing a single format name to transfer. If not specified, ORIGINAL will be transferred.","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"id":{"description":"ID of the object to export.","format":"uuid","type":"string"},"overwrite":{"default":false,"description":"Whether to overwrite existing files.","type":"boolean"},"preferred_original_storage_id":{"default":null,"format":"uuid","nullable":true,"type":"string"}},"required":["id"],"type":"object"},"ExternalReferences":{"properties":{"action":{"type":"string"},"display_name":{"type":"string"},"icon":{"type":"string"},"uri":{"type":"string"}},"required":["uri"],"type":"object"},"FFmpegSettingsSchema":{"properties":{"audio_bitrate":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"bitrate":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"data":{"type":"string"},"edit_proxy_folder":{"nullable":true,"type":"string"},"enable_multi_channel_audio":{"type":"boolean"},"exclude_patterns":{"items":{"type":"string"},"type":"array"},"hdr_brightness":{"maximum":1,"minimum":-1,"nullable":true,"type":"number"},"hdr_contrast":{"maximum":2,"minimum":0,"nullable":true,"type":"number"},"hdr_gamma":{"maximum":10,"minimum":0,"nullable":true,"type":"number"},"hdr_saturation":{"maximum":3,"minimum":0,"nullable":true,"type":"number"},"hdr_tonemap_desat":{"maximum":100,"minimum":0,"nullable":true,"type":"number"},"hdr_tonemap_peak":{"maximum":1000,"minimum":0,"nullable":true,"type":"number"},"include_patterns":{"items":{"type":"string"},"type":"array"},"local":{"type":"boolean"},"merge_multichannel_audio_tracks":{"type":"boolean"},"overlay_coordinates":{"nullable":true,"type":"string"},"overlay_url":{"nullable":true,"type":"string"},"priority":{"format":"int32","maximum":10,"minimum":1,"nullable":true,"type":"integer"},"scaling_method":{"enum":["fast_bilinear","bilinear","bicubic","experimental","neighbor","area","bicublin","gauss","sinc","lanczos","spline","accurate_rnd","full_chroma_int","full_chroma_inp","bitexact"],"type":"string"},"width":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"}},"type":"object"},"FileBaseSchema":{"properties":{"asset_id":{"format":"uuid","type":"string"},"checksum":{"nullable":true,"type":"string"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"directory_path":{"type":"string"},"file_date_created":{"format":"date-time","type":"string"},"file_date_modified":{"format":"date-time","type":"string"},"file_set_id":{"format":"uuid","type":"string"},"format_id":{"format":"uuid","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"description":"If not specified, name will be autogenerated based on `id` and `original_name`","type":"string"},"original_name":{"type":"string"},"parent_id":{"format":"uuid","nullable":true,"type":"string"},"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"status":{"enum":["OPEN","GROWING","AWAITED","CLOSED","FAILED","ARCHIVED","MISSING","REDISCOVERED","DELETED"],"type":"string"},"storage_id":{"format":"uuid","type":"string"},"template":{"type":"string"},"template_engine":{"enum":["SIMPLE","JINJA2"],"nullable":true,"type":"string"},"type":{"enum":["FILE","DIRECTORY","SYMLINK","SEQUENCE"],"type":"string"},"user_id":{"format":"uuid","nullable":true,"type":"string"},"version_id":{"format":"uuid","type":"string"}},"required":["directory_path","original_name","type"],"type":"object"},"FileCreateSchema":{"properties":{"asset_id":{"format":"uuid","type":"string"},"checksum":{"nullable":true,"type":"string"},"content_type":{"type":"string","writeOnly":true},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"directory_path":{"type":"string"},"file_date_created":{"format":"date-time","type":"string"},"file_date_modified":{"format":"date-time","type":"string"},"file_set_id":{"format":"uuid","type":"string"},"format_id":{"format":"uuid","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"multipart_upload_url":{"readOnly":true,"type":"string"},"name":{"description":"If not specified, name will be autogenerated based on `id` and `original_name`","type":"string"},"original_name":{"type":"string"},"parent_id":{"format":"uuid","nullable":true,"type":"string"},"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"status":{"enum":["OPEN","GROWING","AWAITED","CLOSED","FAILED","ARCHIVED","MISSING","REDISCOVERED","DELETED"],"type":"string"},"storage_id":{"format":"uuid","type":"string"},"storage_method":{"readOnly":true,"type":"string"},"template":{"type":"string"},"template_engine":{"enum":["SIMPLE","JINJA2"],"nullable":true,"type":"string"},"type":{"enum":["FILE","DIRECTORY","SYMLINK","SEQUENCE"],"type":"string"},"upload_credentials":{"readOnly":true,"type":"object"},"upload_filename":{"readOnly":true,"type":"string"},"upload_method":{"readOnly":true,"type":"string"},"upload_url":{"readOnly":true,"type":"string"},"user_id":{"format":"uuid","nullable":true,"type":"string"},"version_id":{"format":"uuid","type":"string"}},"required":["directory_path","original_name","type"],"type":"object"},"FileDeletionFromLocalStorageSchema":{"properties":{"asset_id":{"format":"uuid","readOnly":true,"type":"string"},"directory_path":{"type":"string"},"file_id":{"format":"uuid","type":"string"},"file_type":{"type":"string"},"filename":{"type":"string"},"format_id":{"format":"uuid","readOnly":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"job_id":{"format":"uuid","type":"string"},"keep_source":{"type":"boolean"},"storage_id":{"format":"uuid","type":"string"},"template":{"type":"string"},"template_engine":{"type":"string"},"version_id":{"format":"uuid","readOnly":true,"type":"string"}},"required":["file_id","filename","job_id","storage_id"],"type":"object"},"FileDeletionsSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/FileDeletionFromLocalStorageSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"FileDownloadURLSchema":{"properties":{"url":{"readOnly":true,"type":"string"}},"type":"object"},"FileElasticSchema":{"properties":{"asset_id":{"format":"uuid","type":"string"},"checksum":{"nullable":true,"type":"string"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"directory_path":{"type":"string"},"file_date_created":{"format":"date-time","type":"string"},"file_date_modified":{"format":"date-time","type":"string"},"file_set_id":{"format":"uuid","type":"string"},"file_set_status":{"nullable":true,"readOnly":true,"type":"string"},"format_id":{"format":"uuid","type":"string"},"format_status":{"nullable":true,"readOnly":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"description":"If not specified, name will be autogenerated based on `id` and `original_name`","type":"string"},"original_name":{"type":"string"},"parent_id":{"format":"uuid","nullable":true,"type":"string"},"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"status":{"enum":["OPEN","GROWING","AWAITED","CLOSED","FAILED","ARCHIVED","MISSING","REDISCOVERED","DELETED"],"type":"string"},"storage_id":{"format":"uuid","type":"string"},"template":{"type":"string"},"template_engine":{"enum":["SIMPLE","JINJA2"],"nullable":true,"type":"string"},"type":{"enum":["FILE","DIRECTORY","SYMLINK","SEQUENCE"],"type":"string"},"user_id":{"format":"uuid","nullable":true,"type":"string"},"version_id":{"format":"uuid","type":"string"}},"required":["directory_path","original_name","type"],"type":"object"},"FileExistenceCheckSchema":{"properties":{"directory_path":{"type":"string"},"file_name":{"type":"string"},"file_type":{"enum":["FILE","DIRECTORY","SYMLINK","SEQUENCE"],"type":"string"},"template":{"type":"string"},"template_engine":{"type":"string"}},"required":["directory_path","file_name"],"type":"object"},"FileSchema":{"properties":{"asset_id":{"format":"uuid","type":"string"},"checksum":{"nullable":true,"type":"string"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"directory_path":{"type":"string"},"file_date_created":{"format":"date-time","type":"string"},"file_date_modified":{"format":"date-time","type":"string"},"file_set_id":{"format":"uuid","type":"string"},"file_set_status":{"nullable":true,"readOnly":true,"type":"string"},"format_id":{"format":"uuid","type":"string"},"format_status":{"nullable":true,"readOnly":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"multipart_upload_url":{"readOnly":true,"type":"string"},"name":{"description":"If not specified, name will be autogenerated based on `id` and `original_name`","type":"string"},"original_name":{"type":"string"},"parent_id":{"format":"uuid","nullable":true,"type":"string"},"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"status":{"enum":["OPEN","GROWING","AWAITED","CLOSED","FAILED","ARCHIVED","MISSING","REDISCOVERED","DELETED"],"type":"string"},"storage_id":{"format":"uuid","type":"string"},"storage_method":{"readOnly":true,"type":"string"},"system_domain_id":{"format":"uuid","readOnly":true,"type":"string"},"template":{"type":"string"},"template_engine":{"enum":["SIMPLE","JINJA2"],"nullable":true,"type":"string"},"type":{"enum":["FILE","DIRECTORY","SYMLINK","SEQUENCE"],"type":"string"},"upload_credentials":{"readOnly":true,"type":"object"},"upload_filename":{"readOnly":true,"type":"string"},"upload_method":{"readOnly":true,"type":"string"},"upload_url":{"description":"On a file creation for Backblaze B2 storage in case when request to Backblaze failed, upload_url field will be empty. You can try getting upload_url again by requesting created file with `generate_signed_post_url` set to true. ","readOnly":true,"type":"string"},"url":{"readOnly":true,"type":"string"},"user_id":{"format":"uuid","nullable":true,"type":"string"},"version_id":{"format":"uuid","type":"string"}},"required":["directory_path","file_set_id","original_name","type"],"type":"object"},"FileSetElasticSchema":{"properties":{"archive_file_set_id":{"format":"uuid","type":"string"},"asset_id":{"format":"uuid","readOnly":true,"type":"string"},"base_dir":{"type":"string"},"component_ids":{"items":{"format":"uuid","type":"string"},"type":"array"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_deleted":{"format":"date-time","type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"deleted_by_user":{"format":"uuid","readOnly":true,"type":"string"},"file_count":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"format_id":{"format":"uuid","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_archive":{"type":"boolean"},"name":{"type":"string"},"original_storage_id":{"format":"uuid","type":"string"},"status":{"enum":["ACTIVE","ARCHIVED","DELETED"],"type":"string"},"storage_id":{"format":"uuid","type":"string"},"type":{"enum":["REGULAR","MANY_FILES"],"type":"string"},"version_id":{"format":"uuid","type":"string"}},"required":["base_dir","component_ids","format_id","name"],"type":"object"},"FileSetSchema":{"properties":{"archive_file_set_id":{"format":"uuid","type":"string"},"asset_id":{"format":"uuid","readOnly":true,"type":"string"},"base_dir":{"type":"string"},"component_ids":{"items":{"format":"uuid","type":"string"},"type":"array"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_deleted":{"format":"date-time","type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"deleted_by_user":{"format":"uuid","readOnly":true,"type":"string"},"file_count":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"format_id":{"format":"uuid","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_archive":{"type":"boolean"},"name":{"type":"string"},"original_storage_id":{"format":"uuid","type":"string"},"status":{"enum":["ACTIVE","ARCHIVED","DELETED"],"type":"string"},"storage_id":{"format":"uuid","type":"string"},"type":{"enum":["REGULAR","MANY_FILES"],"type":"string"},"version_id":{"format":"uuid","type":"string"}},"required":["base_dir","component_ids","format_id","name"],"type":"object"},"FileSetSourceSchema":{"properties":{"archive_file_set_id":{"format":"uuid","type":"string"},"asset_id":{"format":"uuid","readOnly":true,"type":"string"},"base_dir":{"type":"string"},"component_ids":{"items":{"format":"uuid","type":"string"},"type":"array"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_deleted":{"format":"date-time","type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"deleted_by_user":{"format":"uuid","readOnly":true,"type":"string"},"file_count":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"format_id":{"format":"uuid","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_archive":{"type":"boolean"},"name":{"type":"string"},"original_storage_id":{"format":"uuid","type":"string"},"status":{"enum":["ACTIVE","ARCHIVED","DELETED"],"type":"string"},"storage_id":{"format":"uuid","type":"string"},"storage_method":{"type":"string"},"type":{"enum":["REGULAR","MANY_FILES"],"type":"string"},"version_id":{"format":"uuid","type":"string"}},"required":["base_dir","component_ids","format_id","name","storage_id","storage_method"],"type":"object"},"FileSetSourcesSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/FileSetSourceSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"FileSetsElasticSchema":{"properties":{"facets":{"type":"object"},"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/FileSetElasticSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"FileSetsSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/FileSetSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"FileSettingsSchema":{"properties":{"access_group_id":{"format":"uuid","nullable":true,"type":"string"},"acl_template_id":{"format":"uuid","nullable":true,"type":"string"},"aggregate_identical_files":{"type":"boolean"},"aggregate_ignore":{"items":{"type":"string"},"type":"array"},"aggregate_only_on_same_storage":{"type":"boolean"},"allow_access_outside_scan_directories":{"type":"boolean"},"asset_versions_suffix":{"type":"string"},"auto_version_ignore":{"items":{"type":"string"},"type":"array"},"auto_version_ingest_throttle_value":{"format":"int32","minimum":0,"type":"integer"},"delete":{"type":"boolean"},"directory_assets_original_patterns":{"items":{"type":"string"},"type":"array"},"directory_assets_transcode_patterns":{"items":{"type":"string"},"type":"array"},"enable_auto_versioning":{"type":"boolean"},"enable_collection_directory_mapping":{"type":"boolean"},"enable_directory_assets":{"type":"boolean"},"filename_is_external_id":{"type":"boolean"},"folder_name_tags_metadata_field_name":{"type":"string"},"folder_name_tags_metadata_view_id":{"format":"uuid","nullable":true,"type":"string"},"gateway_user_id":{"format":"uuid","readOnly":true,"type":"string"},"growing_files_threshold":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"is_system":{"type":"boolean"},"local_keyframe_creation":{"type":"boolean"},"local_proxy_creation":{"type":"boolean"},"metadata_conversion_url":{"type":"string"},"metadata_conversion_url_headers":{"nullable":true,"type":"string"},"metadata_view_id":{"format":"uuid","nullable":true,"type":"string"},"mount_point":{"type":"string"},"prio_dirs":{"items":{"$ref":"#/components/schemas/PrioDir"},"nullable":true,"type":"array"},"public_identity":{"type":"string"},"read":{"type":"boolean"},"remote_path":{"type":"string"},"remote_storage_id":{"format":"uuid","type":"string"},"scan":{"type":"boolean"},"scan_directories":{"items":{"type":"string"},"type":"array"},"scan_ignore":{"items":{"type":"string"},"type":"array"},"scan_include":{"items":{"type":"string"},"type":"array"},"scan_interval_seconds":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"sidecar_metadata_required":{"type":"boolean"},"skip_upload_on_any_remote_copy_found":{"type":"boolean"},"storage_addr":{"type":"string"},"title_includes_extension":{"type":"boolean"},"transcode_ignore":{"items":{"type":"string"},"type":"array"},"transcode_include":{"items":{"type":"string"},"type":"array"},"upload_files":{"type":"boolean"},"upload_ignore":{"items":{"type":"string"},"type":"array"},"write":{"type":"boolean"}},"required":["mount_point"],"type":"object"},"FileShareUploadEditSchema":{"properties":{"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"status":{"enum":["OPEN","GROWING","AWAITED","CLOSED","FAILED","ARCHIVED","MISSING","REDISCOVERED","DELETED"],"type":"string"}},"type":"object"},"FilesElasticSchema":{"properties":{"facets":{"type":"object"},"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/FileElasticSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"FilesSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/FileSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"FilesetTransferBaseSchema":{"properties":{"asset_id":{"format":"uuid","type":"string"},"asset_paths":{"items":{"type":"string"},"type":"array"},"collection_storage_id":{"format":"uuid","type":"string"},"component_ids":{"items":{"format":"uuid","type":"string"},"type":"array"},"delete_only_from_source_folder":{"type":"boolean"},"destination_filename":{"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"job_id":{"format":"uuid","type":"string"},"job_steps":{"type":"object"},"original_storage_id":{"format":"uuid","type":"string"},"original_url":{"format":"url","type":"string"},"parent_job_id":{"format":"uuid","type":"string"},"transfer_type":{"readOnly":true,"type":"string"}},"type":"object"},"FlicsTranscoderSchema":{"properties":{"audio_template_id":{"type":"string"},"create_edit_proxy":{"type":"boolean"},"delete_after_upload":{"type":"boolean"},"edit_proxy_local_storage_path":{"type":"string"},"edit_proxy_upload_storage_id":{"type":"string"},"edit_proxy_upload_storage_path":{"type":"string"},"exclude_patterns":{"items":{"type":"string"},"type":"array"},"host":{"type":"string"},"image_template_id":{"type":"string"},"include_patterns":{"items":{"type":"string"},"type":"array"},"local":{"type":"boolean"},"max_concurrency":{"format":"int32","minimum":1,"nullable":true,"type":"integer"},"secret_key":{"type":"string"},"storage_id_path_mapping":{},"storage_ids_mapping":{},"template_id":{"type":"string"}},"type":"object"},"FormatArchiveSchema":{"properties":{"delete_original":{"type":"boolean"},"destination_directory_path":{"type":"string"},"destination_file_set_name":{"readOnly":true,"type":"string"},"destination_storage_id":{"format":"uuid","type":"string"},"destination_storage_method":{"type":"string"},"format_id":{"format":"uuid","type":"string"},"original_file_set_id":{"format":"uuid","type":"string"}},"type":"object"},"FormatDeleteArchiveSchema":{"properties":{"file_set_id":{"format":"uuid","type":"string"}},"type":"object"},"FormatElasticSchema":{"properties":{"archive_status":{"enum":["NOT_ARCHIVED","ARCHIVING","FAILED_TO_ARCHIVE","ARCHIVED"],"type":"string"},"asset_id":{"format":"uuid","readOnly":true,"type":"string"},"components":{"items":{"$ref":"#/components/schemas/ComponentSchema"},"type":"array"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_deleted":{"format":"date-time","type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"deleted_by_user":{"format":"uuid","readOnly":true,"type":"string"},"external_references":{"items":{"$ref":"#/components/schemas/ExternalReferences"},"type":"array"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_online":{"type":"boolean"},"metadata":{"description":"Sequence cannot have more than 10000. Excess values will be stripped","items":{"additionalProperties":{"type":"string"},"type":"object"},"type":"array"},"name":{"type":"string"},"status":{"enum":["ACTIVE","DELETED"],"type":"string"},"storage_methods":{"items":{"type":"string"},"type":"array"},"user_id":{"format":"uuid","type":"string"},"version_id":{"format":"uuid","type":"string"},"warnings":{"items":{"type":"string"},"readOnly":true,"type":"array"}},"required":["name"],"type":"object"},"FormatRestoreSchema":{"properties":{"destination_directory_path":{"nullable":true,"type":"string"},"destination_storage_id":{"format":"uuid","type":"string"},"storage_id":{"description":"Deprecated field. Use destination_storage_id instead","format":"uuid","type":"string"}},"type":"object"},"FormatSchema":{"properties":{"archive_status":{"enum":["NOT_ARCHIVED","ARCHIVING","FAILED_TO_ARCHIVE","ARCHIVED"],"type":"string"},"asset_id":{"format":"uuid","readOnly":true,"type":"string"},"components":{"items":{"$ref":"#/components/schemas/ComponentSchema"},"type":"array"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_deleted":{"format":"date-time","type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"deleted_by_user":{"format":"uuid","readOnly":true,"type":"string"},"external_references":{"items":{"$ref":"#/components/schemas/ExternalReferences"},"type":"array"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_online":{"type":"boolean"},"metadata":{"description":"Sequence cannot have more than 10000. Excess values will be stripped","items":{"additionalProperties":{"type":"string"},"type":"object"},"type":"array"},"name":{"type":"string"},"status":{"enum":["ACTIVE","DELETED"],"type":"string"},"storage_methods":{"items":{"type":"string"},"type":"array"},"user_id":{"format":"uuid","type":"string"},"version_id":{"format":"uuid","type":"string"},"warnings":{"items":{"type":"string"},"readOnly":true,"type":"array"}},"required":["name"],"type":"object"},"FormatsElasticSchema":{"properties":{"facets":{"type":"object"},"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/FormatElasticSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"FormatsSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/FormatSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"FtpSettingsSchema":{"properties":{"address":{"type":"string"},"delete":{"type":"boolean"},"is_system":{"type":"boolean"},"password":{"type":"string"},"read":{"type":"boolean"},"scan":{"type":"boolean"},"user":{"type":"string"},"write":{"type":"boolean"}},"required":["address","password","user"],"type":"object"},"GatewayReportSchema":{"properties":{"await_checksum_files_number":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"date_reported":{"format":"date-time","readOnly":true,"type":"string"},"empty_files_number":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"error_log_lines":{"items":{"maxLength":2000,"type":"string"},"maxItems":10,"type":"array"},"exported_files_number":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"faulty_files_number":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"host_info":{"maxLength":1000,"type":"string"},"host_name":{"maxLength":1000,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"ingested_files_number":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"ingested_files_uploads_number":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"ingesting_files_number":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"last_scan_time":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"log_lines":{"items":{"maxLength":2000,"type":"string"},"maxItems":50,"type":"array"},"logs_url":{"readOnly":true,"type":"string"},"missing_files_number":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"scanned_files_number":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"skipped_files_number":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"start_last_date":{"format":"date-time","readOnly":true,"type":"string"},"start_status":{"enum":["SUCCESS","FAILED"],"type":"string"},"start_status_message":{"maxLength":1000,"type":"string"},"status":{"enum":["OFFLINE","LIVE","UNKNOWN","WARNING"],"type":"string"},"storage_id":{"format":"uuid","readOnly":true,"type":"string"},"total_files_number":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"total_folders_number":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"version":{"maxLength":100,"type":"string"},"waiting_preview_transcode_jobs_number":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"waiting_transcode_jobs_number":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"}},"type":"object"},"GatewayStatusSchema":{"properties":{"status":{"type":"string"}},"type":"object"},"GoogleCloudStorageSettingsSchema":{"properties":{"access_group_id":{"format":"uuid","nullable":true,"type":"string"},"acl_template_id":{"format":"uuid","nullable":true,"type":"string"},"add_uuid_to_filenames":{"type":"boolean"},"aggregate_identical_files":{"type":"boolean"},"aggregate_ignore":{"items":{"type":"string"},"type":"array"},"aggregate_only_on_same_storage":{"type":"boolean"},"bucket":{"type":"string"},"delete":{"type":"boolean"},"enable_collection_directory_mapping":{"type":"boolean"},"filename_is_external_id":{"type":"boolean"},"folder_name_tags_metadata_field_name":{"type":"string"},"folder_name_tags_metadata_view_id":{"format":"uuid","nullable":true,"type":"string"},"is_system":{"type":"boolean"},"json_key":{"type":"string"},"metadata_conversion_url":{"type":"string"},"metadata_conversion_url_headers":{"nullable":true,"type":"string"},"metadata_view_id":{"format":"uuid","nullable":true,"type":"string"},"path":{"type":"string"},"preload_edge_jobs":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"project":{"type":"string"},"read":{"type":"boolean"},"root_collection_id":{"format":"uuid","type":"string"},"scan":{"type":"boolean"},"scan_directories":{"items":{"type":"string"},"type":"array"},"scan_ignore":{"items":{"type":"string"},"type":"array"},"sidecar_metadata_required":{"type":"boolean"},"title_includes_extension":{"type":"boolean"},"transcode_ignore":{"items":{"type":"string"},"type":"array"},"write":{"type":"boolean"}},"required":["bucket","json_key","path","project"],"type":"object"},"HttpSettingsSchema":{"properties":{"address":{"type":"string"},"auto":{"type":"boolean"},"delete":{"type":"boolean"},"is_system":{"type":"boolean"},"read":{"type":"boolean"},"scan":{"type":"boolean"}},"required":["address"],"type":"object"},"ISGConfigClusterSettingsSchema":{"properties":{"checksum_max_workers":{"format":"int32","minimum":1,"type":"integer"},"file_download_parallel_downloads_num":{"format":"int32","maximum":100,"minimum":1,"type":"integer"},"file_upload_parallel_uploads_num":{"format":"int32","maximum":100,"minimum":1,"type":"integer"},"max_transcoding_jobs":{"format":"int32","minimum":1,"type":"integer"},"scanner_concurrency_value":{"format":"int32","maximum":16,"minimum":1,"type":"integer"}},"type":"object"},"ISGConfigSettingsSchema":{"properties":{"checksum_max_workers":{"format":"int32","minimum":1,"type":"integer"},"file_download_parallel_downloads_num":{"format":"int32","maximum":100,"minimum":1,"type":"integer"},"file_upload_parallel_uploads_num":{"format":"int32","maximum":100,"minimum":1,"type":"integer"},"max_transcoding_jobs":{"format":"int32","minimum":1,"type":"integer"},"scanner_concurrency_value":{"format":"int32","maximum":16,"minimum":1,"type":"integer"}},"type":"object"},"ISGHandlerURLSchema":{"properties":{"url":{"type":"string"}},"type":"object"},"IconikEdgeTranscoderSchema":{"properties":{"enable_multi_channel_audio":{"type":"boolean"},"exclude_patterns":{"items":{"type":"string"},"type":"array"},"include_patterns":{"items":{"type":"string"},"type":"array"},"local":{"type":"boolean"},"max_transcoding_jobs":{"format":"int32","minimum":1,"type":"integer"},"merge_multichannel_audio_tracks":{"type":"boolean"},"priority":{"format":"int32","maximum":10,"minimum":1,"nullable":true,"type":"integer"}},"type":"object"},"IconikStorageGatewayBaseSchema":{"properties":{"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"description":{"type":"string"},"enabled":{"description":"Application toggle. If turned off ISG will enter idle state waiting to get enabled again.","type":"boolean"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"settings":{"allOf":[{"$ref":"#/components/schemas/ISGConfigSettingsSchema"}],"description":"Application configuration settings as key-value pairs","nullable":true}},"required":["enabled","name"],"type":"object"},"IconikStorageGatewayClusterReadSchema":{"properties":{"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"db_connection_uri":{"description":"Database connection URI","type":"string"},"description":{"type":"string"},"enabled":{"description":"Application toggle. If turned off ISG will enter idle state waiting to get enabled again.","type":"boolean"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"nodes":{"items":{"$ref":"#/components/schemas/IconikStorageGatewayRead"},"readOnly":true,"type":"array"},"settings":{"allOf":[{"$ref":"#/components/schemas/ISGConfigClusterSettingsSchema"}],"description":"Application configuration settings as key-value pairs"},"status":{"enum":["OFFLINE","LIVE","UNKNOWN","WARNING"],"readOnly":true,"type":"string"},"storage_ids":{"items":{"format":"uuid","type":"string"},"type":"array"},"total_files_number":{"description":"Total number of files","readOnly":true,"type":"integer"},"transcode_queue_total":{"description":"Total number of scheduled transcode jobs","readOnly":true,"type":"integer"},"uploads_queue_total":{"description":"Total number of scheduled auto-uploads","readOnly":true,"type":"integer"},"visibility_timeout":{"default":3600,"description":"The number of seconds jobs should remain invisible to other nodes","maximum":86400,"minimum":3600,"type":"integer"}},"required":["db_connection_uri","enabled","name","storage_ids"],"type":"object"},"IconikStorageGatewayClusterSchema":{"properties":{"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"db_connection_uri":{"description":"Database connection URI","type":"string"},"description":{"type":"string"},"enabled":{"description":"Application toggle. If turned off ISG will enter idle state waiting to get enabled again.","type":"boolean"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"settings":{"allOf":[{"$ref":"#/components/schemas/ISGConfigClusterSettingsSchema"}],"description":"Application configuration settings as key-value pairs"},"status":{"enum":["OFFLINE","LIVE","UNKNOWN","WARNING"],"readOnly":true,"type":"string"},"storage_ids":{"items":{"format":"uuid","type":"string"},"type":"array"},"total_files_number":{"description":"Total number of files","readOnly":true,"type":"integer"},"transcode_queue_total":{"description":"Total number of scheduled transcode jobs","readOnly":true,"type":"integer"},"uploads_queue_total":{"description":"Total number of scheduled auto-uploads","readOnly":true,"type":"integer"},"visibility_timeout":{"default":3600,"description":"The number of seconds jobs should remain invisible to other nodes","maximum":86400,"minimum":3600,"type":"integer"}},"required":["db_connection_uri","enabled","name","storage_ids"],"type":"object"},"IconikStorageGatewayClustersSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/IconikStorageGatewayClusterReadSchema"},"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"IconikStorageGatewayEventSchema":{"properties":{"data":{"type":"object"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"type":{"enum":["RESTART","DOWNLOAD","DOWNLOAD_ABORT","DOWNLOAD_CHANGE_PRIORITY","UPLOAD","UPLOAD_ABORT","UPLOAD_CHANGE_PRIORITY","INGEST_UPLOAD","DELETE","TRANSCODE","ASSET_MERGED","TRANSCODE_ABORT","TRANSCODE_CHANGE_PRIORITY","REQUEST_COLLECTION_MAP","ABORT_COLLECTION_MAP","COLLECTION_DELETED","RESET_INGEST_VALIDATION","SCHEDULE_CHECKSUM_CALCULATION","ABORT_JOBS_BULK","MARK_MISSING_OUTSIDE_SCAN_DIRS"],"type":"string"}},"required":["type"],"type":"object"},"IconikStorageGatewayEventsPurgeSchema":{"properties":{"event_ids":{"items":{"format":"uuid","type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["event_ids"],"type":"object"},"IconikStorageGatewayEventsSchema":{"properties":{"objects":{"items":{"$ref":"#/components/schemas/IconikStorageGatewayEventSchema"},"readOnly":true,"type":"array"}},"type":"object"},"IconikStorageGatewayRead":{"properties":{"cluster_id":{"format":"uuid","type":"string"},"cluster_storage_ids":{"description":"Cluster storage IDs","items":{"format":"uuid","type":"string"},"readOnly":true,"type":"array"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"dedicated_storage_ids":{"description":"Dedicated storage IDs","items":{"format":"uuid","type":"string"},"readOnly":true,"type":"array"},"description":{"type":"string"},"enabled":{"description":"Application toggle. If turned off ISG will enter idle state waiting to get enabled again.","type":"boolean"},"id":{"format":"uuid","readOnly":true,"type":"string"},"merged_settings":{"allOf":[{"$ref":"#/components/schemas/ISGConfigClusterSettingsSchema"}],"description":"Application configuration settings merged with cluster settings","readOnly":true},"name":{"type":"string"},"public_identity":{"type":"string"},"roles":{"description":"Set of roles this gateway can perform when part of cluster","items":{"enum":["CHECKSUM","TRANSFER","TRANSCODE","MAIN"],"type":"string"},"type":"array"},"settings":{"allOf":[{"$ref":"#/components/schemas/ISGConfigSettingsSchema"}],"description":"Application configuration settings as key-value pairs","nullable":true},"status":{"enum":["OFFLINE","LIVE","UNKNOWN","WARNING"],"readOnly":true,"type":"string"},"storage_addr":{"description":"Server address for direct transfers between storage gateways","type":"string"},"storages":{"additionalProperties":{"$ref":"#/components/schemas/IconikStorageGatewayStorageMap"},"description":"Storage mount points mapped by storage ID","type":"object"},"telemetry":{"allOf":[{"$ref":"#/components/schemas/IconikStorageGatewayTelemetry"}],"readOnly":true}},"required":["enabled","name"],"type":"object"},"IconikStorageGatewayReadSchema":{"properties":{"cluster_id":{"format":"uuid","type":"string"},"cluster_storage_ids":{"description":"Cluster storage IDs","items":{"format":"uuid","type":"string"},"readOnly":true,"type":"array"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"dedicated_storage_ids":{"description":"Dedicated storage IDs","items":{"format":"uuid","type":"string"},"readOnly":true,"type":"array"},"description":{"type":"string"},"enabled":{"description":"Application toggle. If turned off ISG will enter idle state waiting to get enabled again.","type":"boolean"},"id":{"format":"uuid","readOnly":true,"type":"string"},"merged_settings":{"allOf":[{"$ref":"#/components/schemas/ISGConfigClusterSettingsSchema"}],"description":"Application configuration settings merged with cluster settings","readOnly":true},"name":{"type":"string"},"public_identity":{"type":"string"},"roles":{"description":"Set of roles this gateway can perform when part of cluster","items":{"enum":["CHECKSUM","TRANSFER","TRANSCODE","MAIN"],"type":"string"},"type":"array"},"settings":{"allOf":[{"$ref":"#/components/schemas/ISGConfigSettingsSchema"}],"description":"Application configuration settings as key-value pairs","nullable":true},"status":{"enum":["OFFLINE","LIVE","UNKNOWN","WARNING"],"readOnly":true,"type":"string"},"storage_addr":{"description":"Server address for direct transfers between storage gateways","type":"string"},"storages":{"additionalProperties":{"$ref":"#/components/schemas/IconikStorageGatewayStorageMap"},"description":"Storage mount points mapped by storage ID","type":"object"},"telemetry":{"allOf":[{"$ref":"#/components/schemas/IconikStorageGatewayTelemetry"}],"readOnly":true}},"required":["enabled","name"],"type":"object"},"IconikStorageGatewaySchema":{"properties":{"cluster_id":{"format":"uuid","type":"string"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"description":{"type":"string"},"enabled":{"description":"Application toggle. If turned off ISG will enter idle state waiting to get enabled again.","type":"boolean"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"public_identity":{"type":"string"},"roles":{"description":"Set of roles this gateway can perform when part of cluster","items":{"enum":["CHECKSUM","TRANSFER","TRANSCODE","MAIN"],"type":"string"},"type":"array"},"settings":{"allOf":[{"$ref":"#/components/schemas/ISGConfigSettingsSchema"}],"description":"Application configuration settings as key-value pairs","nullable":true},"storage_addr":{"description":"Server address for direct transfers between storage gateways","type":"string"},"storages":{"additionalProperties":{"$ref":"#/components/schemas/IconikStorageGatewayStorageMap"},"description":"Storage mount points mapped by storage ID","type":"object"}},"required":["enabled","name"],"type":"object"},"IconikStorageGatewayStorageMap":{"properties":{"mount_point":{"type":"string"}},"required":["mount_point"],"type":"object"},"IconikStorageGatewayStorageMapSchema":{"properties":{"mount_point":{"type":"string"}},"required":["mount_point"],"type":"object"},"IconikStorageGatewayTelemetry":{"properties":{"availability_status":{"enum":["ACTIVE","PASSIVE"],"type":"string"},"error_log_lines":{"items":{"maxLength":2000,"type":"string"},"maxItems":10,"type":"array"},"host_info":{"maxLength":1000,"type":"string"},"host_ip":{"maxLength":1000,"type":"string"},"host_name":{"maxLength":1000,"type":"string"},"log_lines":{"items":{"maxLength":2000,"type":"string"},"maxItems":50,"type":"array"},"start_last_date":{"format":"date-time","type":"string"},"start_status":{"enum":["SUCCESS","FAILED"],"type":"string"},"start_status_message":{"maxLength":1000,"type":"string"},"status":{"enum":["OFFLINE","LIVE","UNKNOWN","WARNING"],"type":"string"},"storage_gateway_id":{"format":"uuid","readOnly":true,"type":"string"},"version":{"maxLength":100,"type":"string"},"worker_id":{"format":"uuid","type":"string"}},"required":["worker_id"],"type":"object"},"IconikStorageGatewayTelemetrySchema":{"properties":{"availability_status":{"enum":["ACTIVE","PASSIVE"],"type":"string"},"error_log_lines":{"items":{"maxLength":2000,"type":"string"},"maxItems":10,"type":"array"},"host_info":{"maxLength":1000,"type":"string"},"host_ip":{"maxLength":1000,"type":"string"},"host_name":{"maxLength":1000,"type":"string"},"log_lines":{"items":{"maxLength":2000,"type":"string"},"maxItems":50,"type":"array"},"start_last_date":{"format":"date-time","type":"string"},"start_status":{"enum":["SUCCESS","FAILED"],"type":"string"},"start_status_message":{"maxLength":1000,"type":"string"},"status":{"enum":["OFFLINE","LIVE","UNKNOWN","WARNING"],"type":"string"},"storage_gateway_id":{"format":"uuid","readOnly":true,"type":"string"},"version":{"maxLength":100,"type":"string"},"worker_id":{"format":"uuid","type":"string"}},"required":["worker_id"],"type":"object"},"IconikStorageGatewaysSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/IconikStorageGatewayReadSchema"},"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"IconikStorageGatewaysTelemetrySchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/IconikStorageGatewayTelemetrySchema"},"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"ImageMagickSettingsSchema":{"properties":{"data":{"type":"string"},"exclude_patterns":{"items":{"type":"string"},"type":"array"},"height":{"format":"int32","maximum":16000,"minimum":1,"type":"integer"},"include_patterns":{"items":{"type":"string"},"type":"array"},"local":{"type":"boolean"},"overlay_coordinates":{"nullable":true,"type":"string"},"overlay_url":{"nullable":true,"type":"string"},"priority":{"format":"int32","maximum":10,"minimum":1,"nullable":true,"type":"integer"},"width":{"format":"int32","maximum":16000,"minimum":1,"type":"integer"}},"type":"object"},"JobsPrioritySchema":{"properties":{"job_ids":{"items":{"format":"uuid","type":"string"},"maxItems":500,"minItems":1,"type":"array"},"priority":{"format":"int32","maximum":10,"minimum":1,"type":"integer"}},"required":["job_ids","priority"],"type":"object"},"JobsStateSchema":{"properties":{"action":{"enum":["RESTART","ABORT"],"type":"string"},"job_ids":{"items":{"format":"uuid","type":"string"},"maxItems":500,"minItems":1,"type":"array"}},"required":["action","job_ids"],"type":"object"},"Keyframe":{"properties":{"asset_id":{"format":"uuid","nullable":true,"type":"string"},"collection_id":{"format":"uuid","nullable":true,"type":"string"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"filename":{"type":"string"},"format":{"nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_custom_keyframe":{"type":"boolean"},"is_public":{"readOnly":true,"type":"boolean"},"name":{"type":"string"},"resolution":{"$ref":"#/components/schemas/ResolutionType"},"rotation":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"nullable":true,"type":"integer"},"status":{"enum":["OPEN","GROWING","AWAITED","CLOSED","FAILED","ARCHIVED","MISSING","REDISCOVERED","DELETED"],"type":"string"},"storage_id":{"format":"uuid","type":"string"},"storage_method":{"readOnly":true,"type":"string"},"time_code":{"$ref":"#/components/schemas/TimeCodeType"},"type":{"enum":["KEYFRAME_MAP","KEYFRAME","POSTER"],"type":"string"},"upload_credentials":{"readOnly":true,"type":"object"},"upload_method":{"readOnly":true,"type":"string"},"upload_url":{"readOnly":true,"type":"string"},"url":{"readOnly":true,"type":"string"},"version_id":{"format":"uuid","nullable":true,"type":"string"}},"required":["type"],"type":"object"},"KeyframeBaseSchema":{"properties":{"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"filename":{"type":"string"},"format":{"nullable":true,"type":"string"},"is_custom_keyframe":{"type":"boolean"},"is_public":{"readOnly":true,"type":"boolean"},"name":{"type":"string"},"resolution":{"$ref":"#/components/schemas/ResolutionType"},"rotation":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"nullable":true,"type":"integer"},"status":{"enum":["OPEN","GROWING","AWAITED","CLOSED","FAILED","ARCHIVED","MISSING","REDISCOVERED","DELETED"],"type":"string"},"time_code":{"$ref":"#/components/schemas/TimeCodeType"},"type":{"enum":["KEYFRAME_MAP","KEYFRAME","POSTER"],"type":"string"},"url":{"readOnly":true,"type":"string"}},"required":["type"],"type":"object"},"KeyframeCreateSchema":{"properties":{"asset_id":{"format":"uuid","nullable":true,"type":"string"},"collection_id":{"format":"uuid","nullable":true,"type":"string"},"content_type":{"type":"string","writeOnly":true},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"filename":{"type":"string"},"format":{"nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_custom_keyframe":{"type":"boolean"},"is_public":{"readOnly":true,"type":"boolean"},"name":{"type":"string"},"resolution":{"$ref":"#/components/schemas/ResolutionType"},"rotation":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"nullable":true,"type":"integer"},"status":{"enum":["OPEN","GROWING","AWAITED","CLOSED","FAILED","ARCHIVED","MISSING","REDISCOVERED","DELETED"],"type":"string"},"storage_id":{"format":"uuid","type":"string"},"storage_method":{"readOnly":true,"type":"string"},"time_code":{"$ref":"#/components/schemas/TimeCodeType"},"type":{"enum":["KEYFRAME_MAP","KEYFRAME","POSTER"],"type":"string"},"upload_credentials":{"readOnly":true,"type":"object"},"upload_method":{"readOnly":true,"type":"string"},"upload_url":{"readOnly":true,"type":"string"},"url":{"readOnly":true,"type":"string"},"version_id":{"format":"uuid","nullable":true,"type":"string"}},"required":["type"],"type":"object"},"KeyframeSchema":{"properties":{"asset_id":{"format":"uuid","nullable":true,"type":"string"},"collection_id":{"format":"uuid","nullable":true,"type":"string"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"filename":{"type":"string"},"format":{"nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_custom_keyframe":{"type":"boolean"},"is_public":{"readOnly":true,"type":"boolean"},"name":{"type":"string"},"resolution":{"$ref":"#/components/schemas/ResolutionType"},"rotation":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"nullable":true,"type":"integer"},"status":{"enum":["OPEN","GROWING","AWAITED","CLOSED","FAILED","ARCHIVED","MISSING","REDISCOVERED","DELETED"],"type":"string"},"storage_id":{"format":"uuid","type":"string"},"storage_method":{"readOnly":true,"type":"string"},"time_code":{"$ref":"#/components/schemas/TimeCodeType"},"type":{"enum":["KEYFRAME_MAP","KEYFRAME","POSTER"],"type":"string"},"upload_credentials":{"readOnly":true,"type":"object"},"upload_method":{"readOnly":true,"type":"string"},"upload_url":{"readOnly":true,"type":"string"},"url":{"readOnly":true,"type":"string"},"version_id":{"format":"uuid","nullable":true,"type":"string"}},"required":["type"],"type":"object"},"KeyframeUpdateSchema":{"properties":{"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"filename":{"type":"string"},"format":{"nullable":true,"type":"string"},"is_custom_keyframe":{"type":"boolean"},"is_public":{"readOnly":true,"type":"boolean"},"name":{"type":"string"},"resolution":{"$ref":"#/components/schemas/ResolutionType"},"rotation":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"nullable":true,"type":"integer"},"status":{"enum":["OPEN","GROWING","AWAITED","CLOSED","FAILED","ARCHIVED","MISSING","REDISCOVERED","DELETED"],"type":"string"},"storage_id":{"format":"uuid","type":"string"},"time_code":{"$ref":"#/components/schemas/TimeCodeType"},"type":{"enum":["KEYFRAME_MAP","KEYFRAME","POSTER"],"type":"string"},"url":{"readOnly":true,"type":"string"}},"required":["type"],"type":"object"},"KeyframesSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/KeyframeSchema"},"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"LibreOfficeSettingsSchema":{"properties":{"exclude_patterns":{"items":{"type":"string"},"type":"array"},"include_patterns":{"items":{"type":"string"},"type":"array"},"local":{"type":"boolean"},"priority":{"format":"int32","maximum":10,"minimum":1,"nullable":true,"type":"integer"}},"type":"object"},"ListObjectsSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"MoveAssetResourceSchema":{"properties":{"destination_asset_id":{"format":"uuid","type":"string"},"destination_version_id":{"format":"uuid","type":"string"},"exclude_format_ids":{"items":{"type":"string"},"nullable":true,"type":"array"},"source_version_id":{"format":"uuid","type":"string"}},"required":["destination_asset_id","destination_version_id","source_version_id"],"type":"object"},"MultiPartS3UrlPartSchema":{"properties":{"checksum":{"description":"base64-encoded md5 digest","nullable":true,"type":"string"},"part_number":{"maximum":10000,"minimum":1,"type":"integer"},"url":{"readOnly":true,"type":"string"}},"type":"object"},"MultiPartS3UrlPartsSchema":{"properties":{"parts":{"items":{"$ref":"#/components/schemas/MultiPartS3UrlPartSchema"},"minItems":1,"type":"array"},"upload_id":{"type":"string"}},"required":["parts","upload_id"],"type":"object"},"MultiPartURLsSchema":{"properties":{"abort_url":{"readOnly":true,"type":"string"},"complete_url":{"readOnly":true,"type":"string"},"list_parts_url":{"items":{"type":"string"},"readOnly":true,"type":"array"}},"type":"object"},"MultiPartUploadComposeURLSchema":{"properties":{"compose_url":{"readOnly":true,"type":"string"},"delete_url":{"readOnly":true,"type":"string"},"key":{"readOnly":true,"type":"string"},"url":{"readOnly":true,"type":"string"}},"type":"object"},"MultiPartUploadURLSchema":{"properties":{"delete_url":{"readOnly":true,"type":"string"},"download_url":{"readOnly":true,"type":"string"},"key":{"readOnly":true,"type":"string"},"number":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"},"url":{"readOnly":true,"type":"string"}},"type":"object"},"MultiPartUploadURLsSchema":{"properties":{"objects":{"items":{"$ref":"#/components/schemas/MultiPartUploadURLSchema"},"readOnly":true,"type":"array"}},"type":"object"},"MultipartB2CancelUpload":{"properties":{"upload_file_id":{"type":"string"}},"required":["upload_file_id"],"type":"object"},"MultipartB2FinishUpload":{"properties":{"sha1_list":{"items":{"type":"string"},"type":"array"},"upload_file_id":{"type":"string"}},"required":["sha1_list","upload_file_id"],"type":"object"},"MultipartB2StartUpload":{"properties":{"authorization_token":{"readOnly":true,"type":"string"},"error":{"readOnly":true,"type":"string"},"error_code":{"readOnly":true,"type":"string"},"status":{"readOnly":true,"type":"string"},"upload_file_id":{"nullable":true,"type":"string"},"upload_url":{"readOnly":true,"type":"string"}},"type":"object"},"MultipartUploadCleanupSchema":{"properties":{"abort_upload":{"type":"boolean"},"parts_group_number":{"default":null,"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"nullable":true,"type":"integer"},"parts_number":{"format":"int64","minimum":1,"type":"integer"},"temporary":{"default":false,"type":"boolean"},"upload_id":{"type":"string"}},"type":"object"},"MultipartUploadComposeSchema":{"properties":{"content_type":{"nullable":true,"type":"string"},"parts_group":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"nullable":true,"type":"integer"}},"type":"object"},"MultipartUploadProxyCleanupSchema":{"properties":{"abort_upload":{"type":"boolean"},"upload_id":{"type":"string"}},"type":"object"},"MultipartUploadSchema":{"properties":{"parts_group":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"nullable":true,"type":"integer"},"parts_range":{"items":{"type":"string"},"type":"array"}},"required":["parts_range"],"type":"object"},"PlaylistKeyframeCreateSchema":{"properties":{"content_type":{"type":"string","writeOnly":true},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"filename":{"type":"string"},"format":{"nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_custom_keyframe":{"type":"boolean"},"is_public":{"readOnly":true,"type":"boolean"},"name":{"type":"string"},"playlist_id":{"format":"uuid","type":"string"},"resolution":{"$ref":"#/components/schemas/ResolutionType"},"rotation":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"nullable":true,"type":"integer"},"status":{"enum":["OPEN","GROWING","AWAITED","CLOSED","FAILED","ARCHIVED","MISSING","REDISCOVERED","DELETED"],"type":"string"},"storage_id":{"format":"uuid","type":"string"},"time_code":{"$ref":"#/components/schemas/TimeCodeType"},"type":{"enum":["KEYFRAME_MAP","KEYFRAME","POSTER"],"type":"string"},"upload_credentials":{"readOnly":true,"type":"object"},"upload_method":{"readOnly":true,"type":"string"},"upload_url":{"readOnly":true,"type":"string"},"url":{"readOnly":true,"type":"string"}},"required":["type"],"type":"object"},"PlaylistKeyframeSchema":{"properties":{"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"filename":{"type":"string"},"format":{"nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_custom_keyframe":{"type":"boolean"},"is_public":{"readOnly":true,"type":"boolean"},"name":{"type":"string"},"playlist_id":{"format":"uuid","type":"string"},"resolution":{"$ref":"#/components/schemas/ResolutionType"},"rotation":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"nullable":true,"type":"integer"},"status":{"enum":["OPEN","GROWING","AWAITED","CLOSED","FAILED","ARCHIVED","MISSING","REDISCOVERED","DELETED"],"type":"string"},"storage_id":{"format":"uuid","type":"string"},"time_code":{"$ref":"#/components/schemas/TimeCodeType"},"type":{"enum":["KEYFRAME_MAP","KEYFRAME","POSTER"],"type":"string"},"url":{"readOnly":true,"type":"string"}},"required":["type"],"type":"object"},"PlaylistKeyframeUpdateSchema":{"properties":{"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"filename":{"type":"string"},"format":{"nullable":true,"type":"string"},"is_custom_keyframe":{"type":"boolean"},"is_public":{"readOnly":true,"type":"boolean"},"name":{"type":"string"},"resolution":{"$ref":"#/components/schemas/ResolutionType"},"rotation":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"nullable":true,"type":"integer"},"status":{"enum":["OPEN","GROWING","AWAITED","CLOSED","FAILED","ARCHIVED","MISSING","REDISCOVERED","DELETED"],"type":"string"},"time_code":{"$ref":"#/components/schemas/TimeCodeType"},"type":{"enum":["KEYFRAME_MAP","KEYFRAME","POSTER"],"type":"string"},"url":{"readOnly":true,"type":"string"}},"required":["type"],"type":"object"},"PlaylistKeyframesSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/PlaylistKeyframeSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"PortalSettingsSchema":{"properties":{"delete":{"type":"boolean"},"is_system":{"type":"boolean"},"read":{"type":"boolean"},"scan":{"type":"boolean"},"write":{"type":"boolean"}},"type":"object"},"PrioDir":{"properties":{"directory":{"type":"string"},"priority":{"type":"integer"}},"type":"object"},"PrioDirSchema":{"properties":{"directory":{"type":"string"},"priority":{"type":"integer"}},"type":"object"},"ProxiesSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/Proxy"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"Proxy":{"properties":{"asset_id":{"format":"uuid","type":"string"},"audio_bitrate":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"audio_channels":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"bit_rate":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"codec":{"type":"string"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"filename":{"type":"string"},"format":{"type":"string"},"frame_rate":{"nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_drop_frame":{"nullable":true,"type":"boolean"},"is_multichannel":{"nullable":true,"type":"boolean"},"is_public":{"readOnly":true,"type":"boolean"},"multipart_upload_url":{"readOnly":true,"type":"string"},"name":{"type":"string"},"resolution":{"$ref":"#/components/schemas/ResolutionType"},"rotation":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"nullable":true,"type":"integer"},"start_time_code":{"nullable":true,"type":"string"},"status":{"enum":["OPEN","GROWING","AWAITED","CLOSED","FAILED","ARCHIVED","MISSING","REDISCOVERED","DELETED"],"type":"string"},"storage_id":{"format":"uuid","type":"string"},"storage_method":{"readOnly":true,"type":"string"},"upload_credentials":{"readOnly":true,"type":"object"},"upload_method":{"readOnly":true,"type":"string"},"upload_url":{"readOnly":true,"type":"string"},"url":{"readOnly":true,"type":"string"},"version_id":{"format":"uuid","nullable":true,"type":"string"}},"type":"object"},"ProxyBaseSchema":{"properties":{"asset_id":{"format":"uuid","type":"string"},"audio_bitrate":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"audio_channels":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"bit_rate":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"codec":{"type":"string"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"filename":{"type":"string"},"format":{"type":"string"},"frame_rate":{"nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_drop_frame":{"nullable":true,"type":"boolean"},"is_multichannel":{"nullable":true,"type":"boolean"},"is_public":{"readOnly":true,"type":"boolean"},"name":{"type":"string"},"resolution":{"$ref":"#/components/schemas/ResolutionType"},"rotation":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"nullable":true,"type":"integer"},"start_time_code":{"nullable":true,"type":"string"},"status":{"enum":["OPEN","GROWING","AWAITED","CLOSED","FAILED","ARCHIVED","MISSING","REDISCOVERED","DELETED"],"type":"string"},"url":{"readOnly":true,"type":"string"},"version_id":{"format":"uuid","nullable":true,"type":"string"}},"type":"object"},"ProxyContainerSchema":{"properties":{"drm":{"type":"string"},"frame_count":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"frame_rate":{"type":"number"},"id":{"format":"uuid","readOnly":true,"type":"string"},"parent_container_id":{"format":"uuid","nullable":true,"type":"string"},"segment_duration":{"type":"number"},"user_id":{"format":"uuid","nullable":true,"type":"string"},"watermark":{"type":"string"}},"type":"object"},"ProxyCreateSchema":{"properties":{"asset_id":{"format":"uuid","type":"string"},"audio_bitrate":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"audio_channels":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"bit_rate":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"codec":{"type":"string"},"content_type":{"type":"string","writeOnly":true},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"filename":{"type":"string"},"format":{"type":"string"},"frame_rate":{"nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_drop_frame":{"nullable":true,"type":"boolean"},"is_multichannel":{"nullable":true,"type":"boolean"},"is_public":{"readOnly":true,"type":"boolean"},"multipart_upload_url":{"readOnly":true,"type":"string"},"name":{"type":"string"},"resolution":{"$ref":"#/components/schemas/ResolutionType"},"rotation":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"nullable":true,"type":"integer"},"start_time_code":{"nullable":true,"type":"string"},"status":{"enum":["OPEN","GROWING","AWAITED","CLOSED","FAILED","ARCHIVED","MISSING","REDISCOVERED","DELETED"],"type":"string"},"storage_id":{"format":"uuid","type":"string"},"storage_method":{"readOnly":true,"type":"string"},"upload_credentials":{"readOnly":true,"type":"object"},"upload_method":{"readOnly":true,"type":"string"},"upload_url":{"readOnly":true,"type":"string"},"url":{"readOnly":true,"type":"string"},"version_id":{"format":"uuid","nullable":true,"type":"string"}},"type":"object"},"ProxyDownloadURLSchema":{"properties":{"url":{"readOnly":true,"type":"string"}},"type":"object"},"ProxyFileSchema":{"properties":{"asset_id":{"format":"uuid","type":"string"},"checksum":{"nullable":true,"type":"string"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"directory_path":{"type":"string"},"file_date_created":{"format":"date-time","type":"string"},"file_date_modified":{"format":"date-time","type":"string"},"file_set_id":{"format":"uuid","type":"string"},"format_id":{"format":"uuid","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"description":"If not specified, name will be autogenerated based on `id` and `original_name`","type":"string"},"original_name":{"type":"string"},"parent_id":{"format":"uuid","nullable":true,"type":"string"},"proxy_sequence_type":{"type":"string"},"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"status":{"enum":["OPEN","GROWING","AWAITED","CLOSED","FAILED","ARCHIVED","MISSING","REDISCOVERED","DELETED"],"type":"string"},"storage_id":{"format":"uuid","type":"string"},"template":{"type":"string"},"template_engine":{"enum":["SIMPLE","JINJA2"],"nullable":true,"type":"string"},"type":{"enum":["FILE","DIRECTORY","SYMLINK","SEQUENCE"],"type":"string"},"user_id":{"format":"uuid","nullable":true,"type":"string"},"version_id":{"format":"uuid","type":"string"}},"required":["directory_path","original_name","proxy_sequence_type","type"],"type":"object"},"ProxySchema":{"properties":{"asset_id":{"format":"uuid","type":"string"},"audio_bitrate":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"audio_channels":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"bit_rate":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"codec":{"type":"string"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"filename":{"type":"string"},"format":{"type":"string"},"frame_rate":{"nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_drop_frame":{"nullable":true,"type":"boolean"},"is_multichannel":{"nullable":true,"type":"boolean"},"is_public":{"readOnly":true,"type":"boolean"},"multipart_upload_url":{"readOnly":true,"type":"string"},"name":{"type":"string"},"resolution":{"$ref":"#/components/schemas/ResolutionType"},"rotation":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"nullable":true,"type":"integer"},"start_time_code":{"nullable":true,"type":"string"},"status":{"enum":["OPEN","GROWING","AWAITED","CLOSED","FAILED","ARCHIVED","MISSING","REDISCOVERED","DELETED"],"type":"string"},"storage_id":{"format":"uuid","type":"string"},"storage_method":{"readOnly":true,"type":"string"},"upload_credentials":{"readOnly":true,"type":"object"},"upload_method":{"readOnly":true,"type":"string"},"upload_url":{"readOnly":true,"type":"string"},"url":{"readOnly":true,"type":"string"},"version_id":{"format":"uuid","nullable":true,"type":"string"}},"type":"object"},"ProxyUpdateSchema":{"properties":{"asset_id":{"format":"uuid","type":"string"},"audio_bitrate":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"audio_channels":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"bit_rate":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"codec":{"type":"string"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"filename":{"type":"string"},"format":{"type":"string"},"frame_rate":{"nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_drop_frame":{"nullable":true,"type":"boolean"},"is_multichannel":{"nullable":true,"type":"boolean"},"is_public":{"readOnly":true,"type":"boolean"},"name":{"type":"string"},"resolution":{"$ref":"#/components/schemas/ResolutionType"},"rotation":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"nullable":true,"type":"integer"},"start_time_code":{"nullable":true,"type":"string"},"status":{"enum":["OPEN","GROWING","AWAITED","CLOSED","FAILED","ARCHIVED","MISSING","REDISCOVERED","DELETED"],"type":"string"},"storage_id":{"format":"uuid","type":"string"},"url":{"readOnly":true,"type":"string"},"version_id":{"format":"uuid","type":"string"}},"type":"object"},"RedlineSchema":{"properties":{"default_lut3d_file":{"nullable":true,"type":"string"},"edit_proxy_local_storage_path":{"type":"string"},"edit_proxy_upload_storage_id":{"type":"string"},"edit_proxy_upload_storage_path":{"type":"string"},"exclude_patterns":{"items":{"type":"string"},"type":"array"},"format":{"enum":["QT transcode","Apple ProRes",""],"type":"string"},"include_patterns":{"items":{"type":"string"},"type":"array"},"keep_redline_proxy":{"type":"boolean"},"local":{"type":"boolean"},"opencl_device_indexes":{"items":{"type":"string"},"type":"array"},"prcodec":{"enum":["Apple_ProRes_422_HQ","Apple_ProRes_422","Apple_ProRes_422_LT","Apple_ProRes_422_Proxy","Apple_ProRes_4444","Apple_ProRes_4444_XQ"],"nullable":true,"type":"string"},"priority":{"format":"int32","maximum":10,"minimum":1,"nullable":true,"type":"integer"},"qt_codec":{"enum":["H264","H263","AVID_1080P_DNxHD_36_8-bit","AVID_1080P_DNxHD_115/120_8-bit","AVID_1080P_DNxHD_175/185_8-bit","AVID_1080P_DNxHD_175/185_10-bit","AVID_720P_DNxHD_60/75_8-bit","AVID_720P_DNxHD_90/110_8-bit","AVID_720P_DNxHD_90/110_10-bit","AVID_720P_DNxHD_120/145_8-bit","AVID_720P_DNxHD_185/220_8-bit","AVID_720P_DNxHD_185/220_10-bit","Apple_ProRes_422_HQ","Apple_ProRes_422","Apple_ProRes_4444","Apple_ProRes_422_LT","Apple_ProRes_422_Proxy",""],"type":"string"},"render_resolution":{"format":"int32","maximum":8,"minimum":1,"nullable":true,"type":"integer"},"use_metadata_cube_file_in_proxy":{"type":"boolean"},"use_rmd":{"format":"int32","maximum":2,"minimum":1,"nullable":true,"type":"integer"}},"type":"object"},"ReindexExportLocationSchema":{"properties":{"sync_to_another_dc":{"type":"boolean"}},"type":"object"},"ReindexFileSchema":{"properties":{"sync_to_another_dc":{"type":"boolean"}},"type":"object"},"ReindexFileSetSchema":{"properties":{"sync_to_another_dc":{"type":"boolean"}},"type":"object"},"ReindexFormatSchema":{"properties":{"sync_to_another_dc":{"type":"boolean"}},"type":"object"},"ReindexStorageGatewaySchema":{"properties":{"sync_to_another_dc":{"type":"boolean"}},"type":"object"},"ReindexStorageSchema":{"properties":{"sync_to_another_dc":{"type":"boolean"}},"type":"object"},"ReindexTranscoderSchema":{"properties":{"sync_to_another_dc":{"type":"boolean"}},"type":"object"},"ResolutionType":{"properties":{"height":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"width":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"}},"type":"object"},"ResolutionTypeSchema":{"properties":{"height":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"width":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"}},"type":"object"},"RestoreAssetToStorageRequest":{"properties":{"all_versions":{"default":false,"type":"boolean"},"destination_directory_path":{"default":null,"nullable":true,"type":"string"},"formats":{"description":"List of format names to transfer. If not specified, all formats will be transferred.","items":{"type":"string"},"type":"array"},"id":{"description":"ID of the object to transfer.","format":"uuid","type":"string"},"preferred_original_storage_id":{"default":null,"format":"uuid","nullable":true,"type":"string"},"restore_priority":{"default":null,"description":"The restore tier to use when retrieving from cold storage one of LOW, MID, HIGH.","nullable":true},"version_ids":{"description":"List of version IDs to transfer.","items":{"format":"uuid","type":"string"},"type":"array"}},"required":["id"],"type":"object"},"RestoreAssetToStorageRequestSchema":{"properties":{"all_versions":{"default":false,"type":"boolean"},"destination_directory_path":{"default":null,"nullable":true,"type":"string"},"formats":{"description":"List of format names to transfer. If not specified, all formats will be transferred.","items":{"type":"string"},"type":"array"},"id":{"description":"ID of the object to transfer.","format":"uuid","type":"string"},"preferred_original_storage_id":{"default":null,"format":"uuid","nullable":true,"type":"string"},"restore_priority":{"default":null,"description":"The restore tier to use when retrieving from cold storage one of LOW, MID, HIGH.","nullable":true},"version_ids":{"description":"List of version IDs to transfer.","items":{"format":"uuid","type":"string"},"type":"array"}},"required":["id"],"type":"object"},"RestoreCollectionToStorageRequest":{"properties":{"all_versions":{"default":false,"type":"boolean"},"destination_directory_path":{"default":null,"nullable":true,"type":"string"},"formats":{"description":"List of format names to transfer. If not specified, all formats will be transferred.","items":{"type":"string"},"type":"array"},"id":{"description":"ID of the object to transfer.","format":"uuid","type":"string"},"keep_collection_structure":{"default":false,"description":"Whether to keep the collection structure when transferring collections.","type":"boolean"},"keep_parent_collection_structure":{"default":false,"description":"Whether to keep the parent collection structure when transferring collections.","type":"boolean"},"preferred_original_storage_id":{"default":null,"format":"uuid","nullable":true,"type":"string"},"restore_priority":{"default":null,"description":"The restore tier to use when retrieving from cold storage one of LOW, MID, HIGH.","nullable":true},"version_ids":{"description":"List of version IDs to transfer.","items":{"format":"uuid","type":"string"},"type":"array"}},"required":["id"],"type":"object"},"RestoreCollectionToStorageRequestSchema":{"properties":{"all_versions":{"default":false,"type":"boolean"},"destination_directory_path":{"default":null,"nullable":true,"type":"string"},"formats":{"description":"List of format names to transfer. If not specified, all formats will be transferred.","items":{"type":"string"},"type":"array"},"id":{"description":"ID of the object to transfer.","format":"uuid","type":"string"},"keep_collection_structure":{"default":false,"description":"Whether to keep the collection structure when transferring collections.","type":"boolean"},"keep_parent_collection_structure":{"default":false,"description":"Whether to keep the parent collection structure when transferring collections.","type":"boolean"},"preferred_original_storage_id":{"default":null,"format":"uuid","nullable":true,"type":"string"},"restore_priority":{"default":null,"description":"The restore tier to use when retrieving from cold storage one of LOW, MID, HIGH.","nullable":true},"version_ids":{"description":"List of version IDs to transfer.","items":{"format":"uuid","type":"string"},"type":"array"}},"required":["id"],"type":"object"},"RestoreSavedSearchToStorageRequest":{"properties":{"all_versions":{"default":false,"type":"boolean"},"destination_directory_path":{"default":null,"nullable":true,"type":"string"},"formats":{"description":"List of format names to transfer. If not specified, all formats will be transferred.","items":{"type":"string"},"type":"array"},"id":{"description":"ID of the object to transfer.","format":"uuid","type":"string"},"preferred_original_storage_id":{"default":null,"format":"uuid","nullable":true,"type":"string"},"restore_priority":{"default":null,"description":"The restore tier to use when retrieving from cold storage one of LOW, MID, HIGH.","nullable":true},"version_ids":{"description":"List of version IDs to transfer.","items":{"format":"uuid","type":"string"},"type":"array"}},"required":["id"],"type":"object"},"RestoreSavedSearchToStorageRequestSchema":{"properties":{"all_versions":{"default":false,"type":"boolean"},"destination_directory_path":{"default":null,"nullable":true,"type":"string"},"formats":{"description":"List of format names to transfer. If not specified, all formats will be transferred.","items":{"type":"string"},"type":"array"},"id":{"description":"ID of the object to transfer.","format":"uuid","type":"string"},"preferred_original_storage_id":{"default":null,"format":"uuid","nullable":true,"type":"string"},"restore_priority":{"default":null,"description":"The restore tier to use when retrieving from cold storage one of LOW, MID, HIGH.","nullable":true},"version_ids":{"description":"List of version IDs to transfer.","items":{"format":"uuid","type":"string"},"type":"array"}},"required":["id"],"type":"object"},"S3SettingsSchema":{"properties":{"access_group_id":{"format":"uuid","nullable":true,"type":"string"},"access_key":{"type":"string"},"acl_template_id":{"format":"uuid","nullable":true,"type":"string"},"add_uuid_to_filenames":{"type":"boolean"},"aggregate_identical_files":{"type":"boolean"},"aggregate_ignore":{"items":{"type":"string"},"type":"array"},"aggregate_only_on_same_storage":{"type":"boolean"},"bucket":{"type":"string"},"delete":{"type":"boolean"},"enable_collection_directory_mapping":{"type":"boolean"},"endpoint":{"type":"string"},"filename_is_external_id":{"type":"boolean"},"folder_name_tags_metadata_field_name":{"type":"string"},"folder_name_tags_metadata_view_id":{"format":"uuid","nullable":true,"type":"string"},"glacier_restore_timeout":{"description":"Keep restored assets online for this many days to allow them to be copied before going back to Glacier","format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"is_system":{"type":"boolean"},"metadata_conversion_url":{"type":"string"},"metadata_conversion_url_headers":{"nullable":true,"type":"string"},"metadata_view_id":{"format":"uuid","nullable":true,"type":"string"},"notification_sqs_url":{"type":"string"},"path":{"type":"string"},"preload_edge_jobs":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"nullable":true,"type":"integer"},"presign_md5_checksum":{"type":"boolean"},"read":{"type":"boolean"},"region":{"type":"string"},"root_collection_id":{"format":"uuid","type":"string"},"scan":{"type":"boolean"},"scan_directories":{"items":{"type":"string"},"type":"array"},"scan_ignore":{"items":{"type":"string"},"type":"array"},"secret_key":{"type":"string"},"session_token":{"type":"string"},"sidecar_metadata_required":{"type":"boolean"},"title_includes_extension":{"type":"boolean"},"transcode_ignore":{"items":{"type":"string"},"type":"array"},"use_acceleration":{"type":"boolean"},"write":{"type":"boolean"}},"required":["bucket","endpoint","path","region"],"type":"object"},"SequenceUpdateSchema":{"properties":{"asset_id":{"format":"uuid","type":"string"},"checksum":{"nullable":true,"type":"string"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"directory_path":{"type":"string"},"file_date_created":{"format":"date-time","type":"string"},"file_date_modified":{"format":"date-time","type":"string"},"file_set_id":{"format":"uuid","type":"string"},"format_id":{"format":"uuid","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"description":"If not specified, name will be autogenerated based on `id` and `original_name`","type":"string"},"original_name":{"type":"string"},"parent_id":{"format":"uuid","nullable":true,"type":"string"},"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"status":{"enum":["OPEN","GROWING","AWAITED","CLOSED","FAILED","ARCHIVED","MISSING","REDISCOVERED","DELETED"],"type":"string"},"storage_id":{"format":"uuid","type":"string"},"template":{"type":"string"},"template_engine":{"enum":["SIMPLE","JINJA2"],"nullable":true,"type":"string"},"type":{"enum":["FILE","DIRECTORY","SYMLINK","SEQUENCE"],"type":"string"},"user_id":{"format":"uuid","nullable":true,"type":"string"},"version_id":{"format":"uuid","type":"string"}},"required":["directory_path","original_name","type"],"type":"object"},"SftpSettingsSchema":{"properties":{"address":{"type":"string"},"delete":{"type":"boolean"},"is_system":{"type":"boolean"},"password":{"type":"string"},"read":{"type":"boolean"},"scan":{"type":"boolean"},"user":{"type":"string"},"write":{"type":"boolean"}},"required":["address","password","user"],"type":"object"},"SourceContext":{"properties":{"external_id":{"default":null,"description":"external storage path / id","nullable":true,"type":"string"},"root_collection_path":{"default":null,"description":"root collection path","nullable":true,"type":"string"},"root_collection_storage_id":{"default":null,"description":"root collection storage ID","format":"uuid","nullable":true,"type":"string"},"storage_id":{"default":null,"format":"uuid","nullable":true,"type":"string"}},"type":"object"},"StorageAccessSchema":{"properties":{"method":{"enum":["FILE","HTTP","FTP","SFTP","S3","B2","GCS","PORTAL","CUSTOM","AZURE"],"type":"string"},"settings":{"type":"object"}},"required":["method","settings"],"type":"object"},"StorageAutoScanSchema":{"properties":{"hours_interval":{"default":24,"format":"int32","minimum":1,"type":"integer"}},"type":"object"},"StorageBaseSchema":{"properties":{},"type":"object"},"StorageFileSchema":{"properties":{"asset_id":{"format":"uuid","type":"string"},"checksum":{"nullable":true,"type":"string"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"destination_storage_id":{"format":"uuid","type":"string"},"directory_path":{"type":"string"},"file_date_created":{"format":"date-time","type":"string"},"file_date_modified":{"format":"date-time","type":"string"},"file_set_id":{"format":"uuid","type":"string"},"format_id":{"format":"uuid","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"description":"If not specified, name will be autogenerated based on `id` and `original_name`","type":"string"},"original_name":{"type":"string"},"parent_id":{"format":"uuid","nullable":true,"type":"string"},"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"status":{"enum":["OPEN","GROWING","AWAITED","CLOSED","FAILED","ARCHIVED","MISSING","REDISCOVERED","DELETED"],"type":"string"},"storage_id":{"description":"Deprecated field. Use destination_storage_id instead","format":"uuid","type":"string"},"template":{"type":"string"},"template_engine":{"enum":["SIMPLE","JINJA2"],"nullable":true,"type":"string"},"type":{"enum":["FILE","DIRECTORY","SYMLINK","SEQUENCE"],"type":"string"},"url":{"readOnly":true,"type":"string"},"user_id":{"format":"uuid","nullable":true,"type":"string"},"version_id":{"format":"uuid","type":"string"}},"required":["directory_path","original_name","type"],"type":"object"},"StorageFileUpdateSchema":{"properties":{"asset_id":{"format":"uuid","type":"string"},"checksum":{"nullable":true,"type":"string"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"directory_path":{"type":"string"},"file_date_created":{"format":"date-time","type":"string"},"file_date_modified":{"format":"date-time","type":"string"},"file_set_id":{"format":"uuid","type":"string"},"format_id":{"format":"uuid","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"original_name":{"type":"string"},"parent_id":{"format":"uuid","nullable":true,"type":"string"},"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"status":{"enum":["OPEN","GROWING","AWAITED","CLOSED","FAILED","ARCHIVED","MISSING","REDISCOVERED","DELETED"],"type":"string"},"storage_id":{"format":"uuid","type":"string"},"template":{"type":"string"},"template_engine":{"enum":["SIMPLE","JINJA2"],"nullable":true,"type":"string"},"type":{"enum":["FILE","DIRECTORY","SYMLINK","SEQUENCE"],"type":"string"},"user_id":{"format":"uuid","nullable":true,"type":"string"},"version_id":{"format":"uuid","type":"string"}},"required":["directory_path","name"],"type":"object"},"StorageFilesDeleteBulkSchema":{"properties":{"object_ids":{"description":"The number of object_ids in the list is limited to a minimum of 0 and a maximum of 500","items":{"format":"uuid","type":"string"},"maxItems":500,"minItems":0,"type":"array"},"object_type":{"type":"string"}},"required":["object_ids","object_type"],"type":"object"},"StorageFilesQueryParamsSchema":{"properties":{"include_parent_statuses":{"type":"boolean"},"page":{"default":1,"description":"Which page number to fetch","format":"int32","maximum":10000,"minimum":1,"nullable":true,"type":"integer"},"per_page":{"default":10,"description":"The number of items for each page","format":"int32","maximum":1000,"minimum":1,"nullable":true,"type":"integer"},"scroll":{"type":"boolean"},"scroll_id":{"format":"uuid","type":"string"},"sort":{"description":"A comma separated list of fieldnames with order (asc/desc)","type":"string"}},"type":"object"},"StoragePermissionsSchema":{"properties":{"method":{"enum":["FILE","HTTP","FTP","SFTP","S3","B2","GCS","PORTAL","CUSTOM","AZURE"],"type":"string"},"purpose":{"enum":["KEYFRAMES","FILES","PROXIES","EXPORTS","ARCHIVE","FACES"],"type":"string"},"settings":{"type":"object"}},"required":["method","purpose","settings"],"type":"object"},"StoragePrivateDataSchema":{"properties":{"bucket_location":{"readOnly":true,"type":"string"},"default":{"readOnly":true,"type":"boolean"},"description":{"nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"last_scanned":{"format":"date-time","nullable":true,"type":"string"},"method":{"enum":["FILE","HTTP","FTP","SFTP","S3","B2","GCS","PORTAL","CUSTOM","AZURE"],"type":"string"},"name":{"type":"string"},"purpose":{"enum":["KEYFRAMES","FILES","PROXIES","EXPORTS","ARCHIVE","FACES"],"type":"string"},"scanner_status":{"nullable":true,"type":"string"},"settings":{"type":"object"},"status":{"enum":["ACTIVE","INACTIVE","FAILING"],"type":"string"},"status_message":{"nullable":true,"type":"string"},"version":{"readOnly":true,"type":"string"}},"required":["method","name","purpose","settings"],"type":"object"},"StorageReadSchema":{"properties":{"default":{"readOnly":true,"type":"boolean"},"description":{"nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"isg_version":{"readOnly":true,"type":"string"},"last_scanned":{"format":"date-time","nullable":true,"type":"string"},"method":{"enum":["FILE","HTTP","FTP","SFTP","S3","B2","GCS","PORTAL","CUSTOM","AZURE"],"type":"string"},"name":{"type":"string"},"purpose":{"enum":["KEYFRAMES","FILES","PROXIES","EXPORTS","ARCHIVE","FACES"],"type":"string"},"scanner_status":{"nullable":true,"type":"string"},"settings":{"type":"object"},"status":{"enum":["ACTIVE","INACTIVE","FAILING"],"type":"string"},"status_message":{"nullable":true,"type":"string"},"storage_gateway_cluster_id":{"format":"uuid","readOnly":true,"type":"string"},"storage_gateway_ids":{"items":{"format":"uuid","type":"string"},"readOnly":true,"type":"array"},"version":{"readOnly":true,"type":"string"}},"required":["method","name","purpose","settings"],"type":"object"},"StorageScanSchema":{"properties":{"files":{"items":{"type":"string"},"nullable":true,"type":"array"},"ignore_already_active":{"description":"Will force scanning even if the scan is already active if any of `paths` or `files` are specified.","type":"boolean"},"paths":{"items":{"type":"string"},"nullable":true,"type":"array"}},"type":"object"},"StorageSchema":{"properties":{"default":{"readOnly":true,"type":"boolean"},"description":{"nullable":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"last_scanned":{"format":"date-time","nullable":true,"type":"string"},"method":{"enum":["FILE","HTTP","FTP","SFTP","S3","B2","GCS","PORTAL","CUSTOM","AZURE"],"type":"string"},"name":{"type":"string"},"purpose":{"enum":["KEYFRAMES","FILES","PROXIES","EXPORTS","ARCHIVE","FACES"],"type":"string"},"scanner_status":{"nullable":true,"type":"string"},"settings":{"type":"object"},"status":{"enum":["ACTIVE","INACTIVE","FAILING"],"type":"string"},"status_message":{"nullable":true,"type":"string"},"version":{"readOnly":true,"type":"string"}},"required":["method","name","purpose","settings"],"type":"object"},"StorageValidationSchema":{"properties":{"method":{"enum":["FILE","HTTP","FTP","SFTP","S3","B2","GCS","PORTAL","CUSTOM","AZURE"],"type":"string"},"settings":{"type":"object"}},"required":["method","settings"],"type":"object"},"StoragesQueryParamsSchema":{"properties":{"page":{"default":1,"description":"Which page number to fetch","format":"int32","maximum":10000,"minimum":1,"nullable":true,"type":"integer"},"per_page":{"default":10,"description":"The number of items for each page","format":"int32","maximum":1000,"minimum":1,"nullable":true,"type":"integer"},"sort":{"description":"A comma separated list of fieldnames with order (asc/desc)","type":"string"}},"type":"object"},"StoragesReadSchema":{"properties":{"facets":{"type":"object"},"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/StorageReadSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"Subtitle":{"properties":{"asset_id":{"format":"uuid","readOnly":true,"type":"string"},"closed_captions":{"type":"boolean"},"format_id":{"format":"uuid","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"language":{"type":"string"},"name":{"type":"string"},"version_id":{"format":"uuid","type":"string"}},"required":["asset_id","closed_captions","format_id","id","language"],"type":"object"},"SubtitleRequestSchema":{"properties":{"create_transcription":{"type":"boolean"},"delete_old_transcriptions":{"type":"boolean"},"priority":{"format":"int32","maximum":10,"minimum":1,"nullable":true,"type":"integer"}},"type":"object"},"SubtitleSchema":{"properties":{"asset_id":{"format":"uuid","readOnly":true,"type":"string"},"closed_captions":{"type":"boolean"},"content":{"type":"string"},"format_id":{"format":"uuid","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"language":{"type":"string"},"name":{"type":"string"},"version_id":{"format":"uuid","type":"string"}},"required":["asset_id","closed_captions","format_id","id","language"],"type":"object"},"SubtitlesSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/Subtitle"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"SwapStoragesSchema":{"properties":{"destination_storage_id":{"format":"uuid","type":"string"},"source_storage_id":{"format":"uuid","type":"string"},"system_domain_id":{"format":"uuid","type":"string"}},"required":["destination_storage_id","source_storage_id","system_domain_id"],"type":"object"},"TelestreamCloudSchema":{"properties":{"access_key":{"type":"string"},"api_host":{"type":"string"},"api_port":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"exclude_patterns":{"items":{"type":"string"},"type":"array"},"factory_id":{"type":"string"},"include_patterns":{"items":{"type":"string"},"type":"array"},"keyframes_profile_id":{"type":"string"},"local":{"type":"boolean"},"priority":{"format":"int32","maximum":10,"minimum":1,"nullable":true,"type":"integer"},"proxy_profile_id":{"type":"string"},"secret_key":{"type":"string"},"storage_id":{"type":"string"}},"required":["access_key","factory_id","keyframes_profile_id","proxy_profile_id","secret_key","storage_id"],"type":"object"},"TemporaryFileCreateSchema":{"properties":{"asset_id":{"format":"uuid","type":"string"},"checksum":{"nullable":true,"type":"string"},"content_type":{"type":"string","writeOnly":true},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"directory_path":{"type":"string"},"file_date_created":{"format":"date-time","type":"string"},"file_date_modified":{"format":"date-time","type":"string"},"file_set_id":{"format":"uuid","type":"string"},"format_id":{"format":"uuid","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"multipart_upload_url":{"readOnly":true,"type":"string"},"name":{"description":"If not specified, name will be autogenerated based on `id` and `original_name`","type":"string"},"original_name":{"type":"string"},"parent_id":{"format":"uuid","nullable":true,"type":"string"},"path_exist":{"readOnly":true,"type":"boolean"},"size":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"status":{"enum":["OPEN","GROWING","AWAITED","CLOSED","FAILED","ARCHIVED","MISSING","REDISCOVERED","DELETED"],"type":"string"},"storage_id":{"format":"uuid","type":"string"},"storage_method":{"readOnly":true,"type":"string"},"template":{"type":"string"},"template_engine":{"enum":["SIMPLE","JINJA2"],"nullable":true,"type":"string"},"type":{"enum":["FILE","DIRECTORY","SYMLINK","SEQUENCE"],"type":"string"},"upload_credentials":{"readOnly":true,"type":"object"},"upload_filename":{"readOnly":true,"type":"string"},"upload_method":{"readOnly":true,"type":"string"},"upload_url":{"readOnly":true,"type":"string"},"user_id":{"format":"uuid","nullable":true,"type":"string"},"version_id":{"format":"uuid","type":"string"}},"required":["directory_path","original_name","type"],"type":"object"},"TemporaryFileSetSchema":{"properties":{"archive_file_set_id":{"format":"uuid","type":"string"},"asset_id":{"format":"uuid","readOnly":true,"type":"string"},"base_dir":{"type":"string"},"component_ids":{"items":{"format":"uuid","type":"string"},"type":"array"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_deleted":{"format":"date-time","type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"deleted_by_user":{"format":"uuid","readOnly":true,"type":"string"},"file_count":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"format_id":{"format":"uuid","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"is_archive":{"type":"boolean"},"job_id":{"format":"uuid","type":"string"},"name":{"type":"string"},"original_storage_id":{"format":"uuid","type":"string"},"status":{"enum":["ACTIVE","ARCHIVED","DELETED"],"type":"string"},"storage_id":{"format":"uuid","type":"string"},"type":{"enum":["REGULAR","MANY_FILES"],"type":"string"},"version_id":{"format":"uuid","type":"string"}},"required":["base_dir","component_ids","format_id","job_id","name"],"type":"object"},"TimeBaseType":{"properties":{"denominator":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"numerator":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"}},"type":"object"},"TimeBaseTypeSchema":{"properties":{"denominator":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"numerator":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"}},"type":"object"},"TimeCodeType":{"properties":{"frames_number":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"is_drop_frame":{"type":"boolean"},"time_base":{"$ref":"#/components/schemas/TimeBaseType"}},"type":"object"},"TimeCodeTypeSchema":{"properties":{"frames_number":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"type":"integer"},"is_drop_frame":{"type":"boolean"},"time_base":{"$ref":"#/components/schemas/TimeBaseTypeSchema"}},"type":"object"},"TranscodeRequestSchema":{"properties":{"job_id":{"format":"uuid","nullable":true,"type":"string"},"priority":{"format":"int32","maximum":10,"minimum":1,"nullable":true,"type":"integer"},"set_as_custom_keyframe":{"nullable":true,"type":"boolean"},"update_proxy_mediainfo":{"type":"boolean"},"use_storage_transcode_ignore_pattern":{"nullable":true,"type":"boolean"}},"type":"object"},"TranscodeResponseSchema":{"properties":{"job_id":{"format":"uuid","readOnly":true,"type":"string"}},"type":"object"},"TranscoderBaseSchema":{"properties":{},"type":"object"},"TranscoderByStorageReadSchema":{"properties":{"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"settings":{"type":"object"},"storage_id":{"format":"uuid","type":"string"},"type":{"enum":["VANTAGE","FFMPEG","EDIT_PROXY","IMAGEMAGICK","ENCODING_COM","ZENCODER","TELESTREAM_CLOUD","ELEMENTAL_MEDIACONVERT","ELEMENTAL_SERVER","REDLINE","ICONIK_EDGE_TRANSCODER","WATCH_FOLDER_VIDEO","EDITREADY","FLICS","WILDMOKA","LIBREOFFICE"],"type":"string"}},"type":"object"},"TranscoderCreateSchema":{"properties":{"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"settings":{"type":"object"},"type":{"enum":["VANTAGE","FFMPEG","EDIT_PROXY","IMAGEMAGICK","ENCODING_COM","ZENCODER","TELESTREAM_CLOUD","ELEMENTAL_MEDIACONVERT","ELEMENTAL_SERVER","REDLINE","ICONIK_EDGE_TRANSCODER","WATCH_FOLDER_VIDEO","EDITREADY","FLICS","WILDMOKA","LIBREOFFICE"],"type":"string"}},"required":["name","settings","type"],"type":"object"},"TranscoderOptionSchema":{"properties":{"label":{"type":"string"},"value":{"type":"string"}},"type":"object"},"TranscoderOptionsSchema":{"properties":{"objects":{"items":{"$ref":"#/components/schemas/TranscoderOptionSchema"},"readOnly":true,"type":"array"}},"type":"object"},"TranscoderReadSchema":{"properties":{"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"settings":{"type":"object"},"type":{"enum":["VANTAGE","FFMPEG","EDIT_PROXY","IMAGEMAGICK","ENCODING_COM","ZENCODER","TELESTREAM_CLOUD","ELEMENTAL_MEDIACONVERT","ELEMENTAL_SERVER","REDLINE","ICONIK_EDGE_TRANSCODER","WATCH_FOLDER_VIDEO","EDITREADY","FLICS","WILDMOKA","LIBREOFFICE"],"type":"string"}},"required":["name","settings","type"],"type":"object"},"TranscoderSchema":{"properties":{"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"settings":{"type":"object"},"type":{"enum":["VANTAGE","FFMPEG","EDIT_PROXY","IMAGEMAGICK","ENCODING_COM","ZENCODER","TELESTREAM_CLOUD","ELEMENTAL_MEDIACONVERT","ELEMENTAL_SERVER","REDLINE","ICONIK_EDGE_TRANSCODER","WATCH_FOLDER_VIDEO","EDITREADY","FLICS","WILDMOKA","LIBREOFFICE"],"type":"string"}},"required":["name","settings","type"],"type":"object"},"TranscoderTokenRequestSchema":{"properties":{"expires_in":{"minimum":0,"type":"number"},"payload":{"type":"object"}},"type":"object"},"TranscoderTokenSchema":{"properties":{"token":{"type":"string"}},"type":"object"},"TranscoderUpdateSchema":{"properties":{"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"type":"string"},"settings":{"type":"object"},"type":{"enum":["VANTAGE","FFMPEG","EDIT_PROXY","IMAGEMAGICK","ENCODING_COM","ZENCODER","TELESTREAM_CLOUD","ELEMENTAL_MEDIACONVERT","ELEMENTAL_SERVER","REDLINE","ICONIK_EDGE_TRANSCODER","WATCH_FOLDER_VIDEO","EDITREADY","FLICS","WILDMOKA","LIBREOFFICE"],"type":"string"}},"required":["name","settings","type"],"type":"object"},"TranscodersByStorageSchema":{"properties":{"facets":{"type":"object"},"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/TranscoderByStorageReadSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"TranscodersQueryParamsSchema":{"properties":{"page":{"default":1,"description":"Which page number to fetch","format":"int32","maximum":10000,"minimum":1,"nullable":true,"type":"integer"},"per_page":{"default":10,"description":"The number of items for each page","format":"int32","maximum":1000,"minimum":1,"nullable":true,"type":"integer"},"sort":{"description":"A comma separated list of fieldnames with order (asc/desc)","type":"string"}},"type":"object"},"TranscodersSchema":{"properties":{"facets":{"type":"object"},"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/TranscoderReadSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"TransferAssetToStorageRequest":{"properties":{"all_versions":{"default":false,"type":"boolean"},"delete_only_from_source":{"default":false,"type":"boolean"},"delete_only_from_source_context":{"$ref":"#/components/schemas/SourceContext"},"delete_original":{"default":false,"type":"boolean"},"destination_directory_path":{"default":null,"nullable":true,"type":"string"},"formats":{"description":"List of format names to transfer. If not specified, all formats will be transferred.","items":{"type":"string"},"type":"array"},"id":{"description":"ID of the object to transfer.","format":"uuid","type":"string"},"preferred_original_storage_id":{"default":null,"format":"uuid","nullable":true,"type":"string"},"version_ids":{"description":"List of version IDs to transfer.","items":{"format":"uuid","type":"string"},"type":"array"}},"required":["id"],"type":"object"},"TransferAssetToStorageRequestSchema":{"properties":{"all_versions":{"default":false,"type":"boolean"},"delete_only_from_source":{"default":false,"type":"boolean"},"delete_only_from_source_context":{"$ref":"#/components/schemas/SourceContext"},"delete_original":{"default":false,"type":"boolean"},"destination_directory_path":{"default":null,"nullable":true,"type":"string"},"formats":{"description":"List of format names to transfer. If not specified, all formats will be transferred.","items":{"type":"string"},"type":"array"},"id":{"description":"ID of the object to transfer.","format":"uuid","type":"string"},"preferred_original_storage_id":{"default":null,"format":"uuid","nullable":true,"type":"string"},"version_ids":{"description":"List of version IDs to transfer.","items":{"format":"uuid","type":"string"},"type":"array"}},"required":["id"],"type":"object"},"TransferAssetToStorageSchema":{"properties":{"all_versions":{"description":"If true, all versions of the asset will be transferred","type":"boolean"},"destination_directory_path":{"type":"string"},"formats":{"description":"List of format names to transfer. If not specified, all formats will be transferred.","items":{"type":"string"},"type":"array"},"version_ids":{"description":"List of version IDs to transfer. If not specified, the latest version will be transferred.","items":{"format":"uuid","type":"string"},"type":"array"}},"type":"object"},"TransferBaseSchema":{"properties":{"destination_directory_path":{"type":"string"}},"type":"object"},"TransferCloudSchema":{"properties":{"asset_id":{"format":"uuid","type":"string"},"asset_paths":{"items":{"type":"string"},"type":"array"},"celery_task_id":{"format":"uuid","readOnly":true,"type":"string"},"collection_storage_id":{"format":"uuid","type":"string"},"component_ids":{"items":{"format":"uuid","type":"string"},"type":"array"},"date_created":{"format":"date-time","readOnly":true,"type":"string"},"date_modified":{"format":"date-time","readOnly":true,"type":"string"},"delete_only_from_source_folder":{"type":"boolean"},"delete_original":{"readOnly":true,"type":"boolean"},"destination_directory_path":{"readOnly":true,"type":"string"},"destination_filename":{"readOnly":true,"type":"string"},"destination_storage_id":{"format":"uuid","readOnly":true,"type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"job_id":{"format":"uuid","readOnly":true,"type":"string"},"job_steps":{"type":"object"},"original_file_set_id":{"format":"uuid","readOnly":true,"type":"string"},"original_storage_id":{"format":"uuid","type":"string"},"original_url":{"format":"url","type":"string"},"parent_job_id":{"format":"uuid","type":"string"},"priority":{"format":"int32","maximum":10,"minimum":1,"readOnly":true,"type":"integer"},"status":{"enum":["Q","U","E","D"],"readOnly":true,"type":"string"},"success":{"readOnly":true,"type":"string"},"transfer_type":{"format":"uuid","readOnly":true,"type":"string"},"user_id":{"format":"uuid","readOnly":true,"type":"string"}},"type":"object"},"TransferCollectionToStorageRequest":{"properties":{"all_versions":{"default":false,"type":"boolean"},"delete_only_from_source":{"default":false,"type":"boolean"},"delete_only_from_source_context":{"$ref":"#/components/schemas/SourceContext"},"delete_original":{"default":false,"type":"boolean"},"destination_directory_path":{"default":null,"nullable":true,"type":"string"},"formats":{"description":"List of format names to transfer. If not specified, all formats will be transferred.","items":{"type":"string"},"type":"array"},"id":{"description":"ID of the object to transfer.","format":"uuid","type":"string"},"keep_collection_structure":{"default":false,"description":"Whether to keep the collection structure when transferring collections.","type":"boolean"},"keep_parent_collection_structure":{"default":false,"description":"Whether to keep the parent collection structure when transferring collections.","type":"boolean"},"preferred_original_storage_id":{"default":null,"format":"uuid","nullable":true,"type":"string"}},"required":["id"],"type":"object"},"TransferCollectionToStorageRequestSchema":{"properties":{"all_versions":{"default":false,"type":"boolean"},"delete_only_from_source":{"default":false,"type":"boolean"},"delete_only_from_source_context":{"$ref":"#/components/schemas/SourceContext"},"delete_original":{"default":false,"type":"boolean"},"destination_directory_path":{"default":null,"nullable":true,"type":"string"},"formats":{"description":"List of format names to transfer. If not specified, all formats will be transferred.","items":{"type":"string"},"type":"array"},"id":{"description":"ID of the object to transfer.","format":"uuid","type":"string"},"keep_collection_structure":{"default":false,"description":"Whether to keep the collection structure when transferring collections.","type":"boolean"},"keep_parent_collection_structure":{"default":false,"description":"Whether to keep the parent collection structure when transferring collections.","type":"boolean"},"preferred_original_storage_id":{"default":null,"format":"uuid","nullable":true,"type":"string"}},"required":["id"],"type":"object"},"TransferFormatToStorageSchema":{"properties":{"destination_directory_path":{"type":"string"},"destination_filename":{"type":"string"}},"type":"object"},"TransferFromStorageReadSchema":{"properties":{"add_file_set":{"readOnly":true,"type":"boolean"},"asset_id":{"format":"uuid","type":"string"},"asset_paths":{"items":{"type":"string"},"type":"array"},"collection_storage_id":{"format":"uuid","type":"string"},"component_ids":{"items":{"format":"uuid","type":"string"},"type":"array"},"delete_local_file_set_after_upload":{"type":"boolean"},"delete_only_from_source_folder":{"type":"boolean"},"delete_source_file_set_after_download":{"type":"boolean"},"destination_directory_path":{"type":"string"},"destination_file_set_name":{"readOnly":true,"type":"string"},"destination_filename":{"type":"string"},"destination_storage_id":{"format":"uuid","type":"string"},"destination_storage_method":{"type":"string"},"export_metadata_format":{"readOnly":true,"type":"string"},"export_metadata_view":{"format":"uuid","readOnly":true,"type":"string"},"export_original":{"readOnly":true,"type":"boolean"},"export_posters":{"readOnly":true,"type":"boolean"},"export_proxy":{"readOnly":true,"type":"boolean"},"export_transcription_format":{"readOnly":true,"type":"string"},"format_id":{"format":"uuid","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"include_original_extension":{"readOnly":true,"type":"boolean"},"job_id":{"format":"uuid","type":"string"},"job_steps":{"type":"object"},"original_file_set_id":{"format":"uuid","type":"string"},"original_storage_id":{"format":"uuid","type":"string"},"original_url":{"format":"url","type":"string"},"overwrite":{"readOnly":true,"type":"boolean"},"parent_job_id":{"format":"uuid","type":"string"},"temporary_file_set_source":{"type":"boolean"},"transfer_type":{"readOnly":true,"type":"string"}},"type":"object"},"TransferFromStorageSchema":{"properties":{"asset_id":{"format":"uuid","type":"string"},"asset_paths":{"items":{"type":"string"},"type":"array"},"collection_storage_id":{"format":"uuid","type":"string"},"component_ids":{"items":{"format":"uuid","type":"string"},"type":"array"},"delete_local_file_set_after_upload":{"type":"boolean"},"delete_only_from_source_folder":{"type":"boolean"},"delete_source_file_set_after_download":{"type":"boolean"},"destination_directory_path":{"type":"string"},"destination_file_set_name":{"readOnly":true,"type":"string"},"destination_filename":{"type":"string"},"destination_storage_id":{"format":"uuid","type":"string"},"destination_storage_method":{"type":"string"},"format_id":{"format":"uuid","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"job_id":{"format":"uuid","type":"string"},"job_steps":{"type":"object"},"original_file_set_id":{"format":"uuid","type":"string"},"original_storage_id":{"format":"uuid","type":"string"},"original_url":{"format":"url","type":"string"},"parent_job_id":{"format":"uuid","type":"string"},"temporary_file_set_source":{"type":"boolean"},"transfer_type":{"readOnly":true,"type":"string"}},"type":"object"},"TransferSavedSearchToStorageRequest":{"properties":{"all_versions":{"default":false,"type":"boolean"},"delete_only_from_source":{"default":false,"type":"boolean"},"delete_only_from_source_context":{"$ref":"#/components/schemas/SourceContext"},"delete_original":{"default":false,"type":"boolean"},"destination_directory_path":{"default":null,"nullable":true,"type":"string"},"formats":{"description":"List of format names to transfer. If not specified, all formats will be transferred.","items":{"type":"string"},"type":"array"},"id":{"description":"ID of the object to transfer.","format":"uuid","type":"string"},"preferred_original_storage_id":{"default":null,"format":"uuid","nullable":true,"type":"string"}},"required":["id"],"type":"object"},"TransferSavedSearchToStorageRequestSchema":{"properties":{"all_versions":{"default":false,"type":"boolean"},"delete_only_from_source":{"default":false,"type":"boolean"},"delete_only_from_source_context":{"$ref":"#/components/schemas/SourceContext"},"delete_original":{"default":false,"type":"boolean"},"destination_directory_path":{"default":null,"nullable":true,"type":"string"},"formats":{"description":"List of format names to transfer. If not specified, all formats will be transferred.","items":{"type":"string"},"type":"array"},"id":{"description":"ID of the object to transfer.","format":"uuid","type":"string"},"preferred_original_storage_id":{"default":null,"format":"uuid","nullable":true,"type":"string"}},"required":["id"],"type":"object"},"TransferSignedURLSchema":{"properties":{"url":{"format":"url","type":"string"}},"type":"object"},"TransferToStorageBaseSchema":{"properties":{"all_versions":{"description":"If true, all versions of the asset will be transferred","type":"boolean"},"destination_directory_path":{"type":"string"},"formats":{"description":"List of format names to transfer. If not specified, all formats will be transferred.","items":{"type":"string"},"type":"array"}},"type":"object"},"TransferToStorageReadSchema":{"properties":{"add_file_set":{"readOnly":true,"type":"boolean"},"asset_id":{"format":"uuid","type":"string"},"asset_paths":{"items":{"type":"string"},"type":"array"},"collection_storage_id":{"format":"uuid","type":"string"},"component_ids":{"items":{"format":"uuid","type":"string"},"type":"array"},"delete_only_from_source_folder":{"type":"boolean"},"delete_remote_file_set_after_download":{"type":"boolean"},"delete_source_file_set_after_download":{"type":"boolean"},"destination_base_directory":{"type":"string"},"destination_directory_path":{"type":"string"},"destination_file_set_name":{"type":"string"},"destination_filename":{"type":"string"},"export_metadata_format":{"readOnly":true,"type":"string"},"export_metadata_view":{"format":"uuid","readOnly":true,"type":"string"},"export_original":{"readOnly":true,"type":"boolean"},"export_posters":{"readOnly":true,"type":"boolean"},"export_proxy":{"readOnly":true,"type":"boolean"},"export_transcription_format":{"readOnly":true,"type":"string"},"file_set_id":{"format":"uuid","type":"string"},"format_id":{"format":"uuid","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"include_original_extension":{"readOnly":true,"type":"boolean"},"job_id":{"format":"uuid","type":"string"},"job_steps":{"type":"object"},"local_storage_id":{"format":"uuid","type":"string"},"original_storage_id":{"format":"uuid","type":"string"},"original_url":{"format":"url","type":"string"},"overwrite":{"readOnly":true,"type":"boolean"},"parent_job_id":{"format":"uuid","type":"string"},"temporary_file_set_source":{"type":"boolean"},"transfer_type":{"readOnly":true,"type":"string"}},"required":["destination_directory_path","destination_file_set_name"],"type":"object"},"TransferToStorageSchema":{"properties":{"asset_id":{"format":"uuid","type":"string"},"asset_paths":{"items":{"type":"string"},"type":"array"},"collection_storage_id":{"format":"uuid","type":"string"},"component_ids":{"items":{"format":"uuid","type":"string"},"type":"array"},"delete_only_from_source_folder":{"type":"boolean"},"delete_remote_file_set_after_download":{"type":"boolean"},"delete_source_file_set_after_download":{"type":"boolean"},"destination_base_directory":{"type":"string"},"destination_directory_path":{"type":"string"},"destination_file_set_name":{"type":"string"},"destination_filename":{"type":"string"},"file_set_id":{"format":"uuid","type":"string"},"format_id":{"format":"uuid","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"job_id":{"format":"uuid","type":"string"},"job_steps":{"type":"object"},"local_storage_id":{"format":"uuid","type":"string"},"original_storage_id":{"format":"uuid","type":"string"},"original_url":{"format":"url","type":"string"},"parent_job_id":{"format":"uuid","type":"string"},"temporary_file_set_source":{"type":"boolean"},"transfer_type":{"readOnly":true,"type":"string"}},"required":["destination_directory_path","destination_file_set_name"],"type":"object"},"TransfersFromStorageSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/TransferFromStorageReadSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"TransfersToStorageSchema":{"properties":{"first_url":{"readOnly":true,"type":"string"},"last_url":{"readOnly":true,"type":"string"},"next_url":{"readOnly":true,"type":"string"},"objects":{"items":{"$ref":"#/components/schemas/TransferToStorageReadSchema"},"readOnly":true,"type":"array"},"page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"pages":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"per_page":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"readOnly":true,"type":"integer"},"prev_url":{"readOnly":true,"type":"string"},"scroll_id":{"readOnly":true,"type":"string"},"total":{"format":"int64","maximum":9223372036854775807,"minimum":-9223372036854775808,"readOnly":true,"type":"integer"}},"type":"object"},"UploadFilesSchema":{"properties":{"asset_id":{"format":"uuid","type":"string"},"asset_title":{"type":"string"},"collection_id":{"format":"uuid","type":"string"},"create_keyframes":{"type":"boolean"},"file_name":{"type":"string"},"format_metadata":{"description":"Sequence cannot have more than 10000. Excess values will be stripped","items":{"additionalProperties":{"type":"string"},"type":"object"},"type":"array"},"format_name":{"type":"string"},"storage_id":{"format":"uuid","type":"string"},"version_id":{"format":"uuid","type":"string"}},"required":["file_name","storage_id"],"type":"object"},"UploadIconikStorageGatewayLogsSchema":{"properties":{"filename":{"maxLength":100,"type":"string"}},"required":["filename"],"type":"object"},"VantageSettingsSchema":{"properties":{"exclude_patterns":{"items":{"type":"string"},"type":"array"},"host":{"type":"string"},"include_patterns":{"items":{"type":"string"},"type":"array"},"local":{"type":"boolean"},"port":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"priority":{"format":"int32","maximum":10,"minimum":1,"nullable":true,"type":"integer"},"share_name":{"type":"string"},"temp_proxy_folder":{"type":"string"},"workflow_id":{"type":"string"}},"required":["host","port","share_name","temp_proxy_folder","workflow_id"],"type":"object"},"WatchFolderVideoTranscoderSchema":{"properties":{"create_web_proxy_from_edit_proxy":{"type":"boolean"},"edit_proxy_local_storage_path":{"type":"string"},"edit_proxy_upload_storage_id":{"type":"string"},"edit_proxy_upload_storage_path":{"type":"string"},"exclude_patterns":{"items":{"type":"string"},"type":"array"},"file_grow_threshold":{"format":"int32","minimum":5,"type":"integer"},"include_patterns":{"items":{"type":"string"},"type":"array"},"keep_as_edit_proxy":{"type":"boolean"},"keyframe_folder_name":{"type":"string"},"keyframe_map_folder_name":{"type":"string"},"local":{"type":"boolean"},"proxy_folder_name":{"type":"string"},"proxy_timeout":{"format":"int32","maximum":86400,"minimum":10,"type":"integer"},"use_symlink":{"description":"If enabled a soft link is used to add original to the watch folder, if disabled a hard link is used with a fallback to copy.","type":"boolean"},"use_unique_sub_folder_workflow":{"description":"A sub-folder is created with a unique name inside the watch folder per job.","type":"boolean"},"watch_folder_location":{"type":"string"}},"required":["file_grow_threshold","keyframe_folder_name","keyframe_map_folder_name","proxy_folder_name","watch_folder_location"],"type":"object"},"WildmokaSettingsSchema":{"properties":{"audio_bitrate":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"bitrate":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"exclude_patterns":{"items":{"type":"string"},"type":"array"},"include_patterns":{"items":{"type":"string"},"type":"array"},"local":{"type":"boolean"},"priority":{"format":"int32","maximum":10,"minimum":1,"nullable":true,"type":"integer"},"scaling_method":{"enum":["fast_bilinear","bilinear","bicubic","experimental","neighbor","area","bicublin","gauss","sinc","lanczos","spline","accurate_rnd","full_chroma_int","full_chroma_inp","bitexact"],"type":"string"},"width":{"format":"int32","maximum":2147483647,"minimum":-2147483648,"type":"integer"},"wm_endpoint_url":{"description":"Wildmoka API endpoint URL","nullable":true,"type":"string"},"wm_issuer":{"description":"JWT issuer to use for authentication","nullable":true,"type":"string"},"wm_secret_key":{"description":"JWT secret key to use for authentication","nullable":true,"type":"string"},"wm_storage_id":{"description":"Storage ID to use for Wildmoka segmented and analyzed formats","format":"uuid","nullable":true,"type":"string"},"wm_video_variants":{"description":"List of video variants to prepare","items":{"type":"string"},"type":"array"}},"type":"object"},"ZencoderSettingsSchema":{"properties":{"api_key":{"type":"string"},"exclude_patterns":{"items":{"type":"string"},"type":"array"},"include_patterns":{"items":{"type":"string"},"type":"array"},"local":{"type":"boolean"},"priority":{"format":"int32","maximum":10,"minimum":1,"nullable":true,"type":"integer"}},"required":["api_key"],"type":"object"}}},"info":{"title":"iconik Files","version":"2.0.0"},"openapi":"3.0.3","paths":{"/":{},"/ip/":{},"/livez/":{},"/readyz/":{},"/spec/":{},"/static/{filename}":{},"/v1/analysis/copy/":{},"/v1/analysis/ml/setup/":{},"/v1/analysis/profiles/":{"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"ID of a last profile set on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisProfilesSchema"}}},"description":"Returns analysis profiles"},"401":{"description":"Token is invalid"},"404":{"description":"Profiles don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get analysis profiles"},"post":{"description":"\nRequired roles:\n - can_write_analysis_profiles\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisProfileSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisProfileSchema"}}},"description":"Returns an analysis profile"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a new analysis profile"}},"/v1/analysis/profiles/{media_type}/default/":{"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"media_type","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisProfileSchema"}}},"description":"The default analysis profile"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Permission denied"},"404":{"description":"Analysis profile does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get a default analysis profile"}},"/v1/analysis/profiles/{profile_id}/":{"delete":{"description":"\nRequired roles:\n - can_delete_analysis_profiles\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"profile_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Analysis profile doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete an analysis profile"},"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"profile_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisProfileSchema"}}},"description":"Returns an analysis profile for provided media type"},"401":{"description":"Token is invalid"},"404":{"description":"Profile doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get an analysis profile"},"patch":{"description":"\nRequired roles:\n - can_write_analysis_profiles\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"profile_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisProfileSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisProfileSchema"}}},"description":"Returns an analysis profile that was updated"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Profile doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update an analysis profile information"},"put":{"description":"\nRequired roles:\n - can_write_analysis_profiles\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"profile_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisProfileSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisProfileSchema"}}},"description":"Returns an analysis profile that was updated"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Profile doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update an analysis profile information"}},"/v1/analysis/profiles/{profile_id}/default/":{"delete":{"description":"\nRequired roles:\n - can_write_analysis_profiles\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"profile_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Removes the default flag on an analysis profile"},"post":{"description":"\nRequired roles:\n - can_write_analysis_profiles\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"profile_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Set an analysis profile to the default of its media type"}},"/v1/analysis/service_accounts/":{"get":{"description":"\nRequired roles:\n - can_read_analysis_service_accounts\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"ID of a last service account set on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisServiceAccountsSchema"}}},"description":"Returns analysis service accounts"},"401":{"description":"Token is invalid"},"404":{"description":"Service accounts don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get analysis service accounts"},"post":{"description":"\nRequired roles:\n - can_write_analysis_service_accounts\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisServiceAccountSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisServiceAccountReadSchema"}}},"description":"Returns an analysis service account"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a new analysis service account"}},"/v1/analysis/service_accounts/{analysis_service_account_id}/":{"delete":{"description":"\nRequired roles:\n - can_delete_analysis_service_accounts\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"analysis_service_account_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Analysis service account doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete an analysis service account"},"get":{"description":"\nRequired roles:\n - can_read_analysis_service_accounts\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"analysis_service_account_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisServiceAccountReadSchema"}}},"description":"Returns an analysis service account"},"401":{"description":"Token is invalid"},"404":{"description":"Service account doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get an analysis service account"},"patch":{"description":"\nRequired roles:\n - can_write_analysis_service_accounts\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"analysis_service_account_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisServiceAccountSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisServiceAccountSchema"}}},"description":"Returns an analysis service account that was updated"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Service account doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update an analysis service account information"},"put":{"description":"\nRequired roles:\n - can_write_analysis_service_accounts\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"analysis_service_account_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisServiceAccountSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisServiceAccountSchema"}}},"description":"Returns an analysis service account that was updated"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Service account doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update an analysis service account information"}},"/v1/analysis/settings/transcription/default/":{"get":{"description":"\nRequired roles:\n - can_transcribe_content\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalysisTranscriptionSettingsSchema"}}},"description":"The transcription settings of the default analysis profile"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Permission denied"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get default analysis settings for transcription"}},"/v1/assets/bulk/keyframes/":{"post":{"description":"\nRequired roles:\n - can_create_transcode_jobs\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkTranscodeSchema"}}},"description":"body","required":true},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a transcode job for proxy and keyframes generation of multiple assets"}},"/v1/assets/copy/":{},"/v1/assets/export_locations/{export_location_id}/":{"post":{"deprecated":true,"description":"\nRequired roles:\n - can_write_exports\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"export_location_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Enable transfer through iconik host (creates egress)","in":"query","name":"allow_host_transfer","schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetBatchExportSchema"}}},"description":"body","required":true},"responses":{"200":{"description":"Returns an export job id"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Export multiple assets to export location"}},"/v1/assets/{asset_id}/custom_keyframe/":{"post":{"description":"\nRequired roles:\n - can_write_keyframes\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Content type to add to the pre-signed upload url","in":"query","name":"content_type","schema":{"type":"string"},"style":"form"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyframeSchema"}}},"description":"Returns created keyframe"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create keyframe of type poster for asset"}},"/v1/assets/{asset_id}/custom_keyframe/{poster_id}/":{"post":{"description":"\nRequired roles:\n - can_write_keyframes\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"poster_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"set to false to keep current custom_poster and custom_keyframe on asset","in":"query","name":"overwrite","required":false,"schema":{"type":"boolean"},"style":"form"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyframeSchema"}}},"description":"Returns custom keyframe"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Set keyframe of type poster as asset keyframe"}},"/v1/assets/{asset_id}/export_locations/{export_location_id}/":{"post":{"description":"\nRequired roles:\n - can_write_exports\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"export_location_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Enable transfer through iconik host (creates egress)","in":"query","name":"allow_host_transfer","schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetExportSchema"}}},"description":"body","required":true},"responses":{"200":{"description":"Returns an export job id"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Export asset to export location"}},"/v1/assets/{asset_id}/file_sets/":{"get":{"description":"\nRequired roles:\n - can_read_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"ID of a last file set on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"},{"description":"Set to true if you need a total amount of files in a file set","in":"query","name":"file_count","schema":{"default":false,"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSetsSchema"}}},"description":"Returns all file sets associated with this asset"},"401":{"description":"Token is invalid"},"404":{"description":"FileSets for this asset don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all asset's file sets"},"post":{"description":"\nRequired roles:\n - can_write_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSetSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSetSchema"}}},"description":"Returns a file set that was created for this asset"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create file set and associate to asset"}},"/v1/assets/{asset_id}/file_sets/bulk/":{"post":{"description":"\nRequired roles:\n - can_delete_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"If true, keep source objects","in":"query","name":"keep_source","schema":{"default":false,"type":"boolean"},"style":"form"},{"description":"If true, skips the recycle bin and purges the file set immediately","in":"query","name":"immediately","schema":{"default":false,"type":"boolean"},"style":"form"},{"description":"If true, do not delete the last remaining file set.","in":"query","name":"do_not_delete_last_copy","schema":{"default":false,"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkFilesetSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"Deletion jobs created"},"401":{"description":"Token is invalid"},"404":{"description":"File set for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete asset's file set, file entries, and actual files in bulk"}},"/v1/assets/{asset_id}/file_sets/{file_set_id}/":{"delete":{"description":"\nRequired roles:\n - can_delete_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_set_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"If true, keep source objects","in":"query","name":"keep_source","schema":{"default":false,"type":"boolean"},"style":"form"},{"description":"If true, skips the recycle bin and purges the file set immediately","in":"query","name":"immediately","schema":{"default":false,"type":"boolean"},"style":"form"}],"responses":{"200":{"description":"File set that has been marked as deleted"},"204":{"description":"Without body in case `immediately` option was provided"},"401":{"description":"Token is invalid"},"404":{"description":"File set for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete asset's file set, file entries, and actual files"},"get":{"description":"\nRequired roles:\n - can_read_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_set_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSetSchema"}}},"description":"Returns a file set associated with this asset"},"401":{"description":"Token is invalid"},"404":{"description":"File set for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get asset's file set"},"patch":{"description":"\nRequired roles:\n - can_write_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_set_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSetSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSetSchema"}}},"description":"Returns a file set that was updated"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"File set for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update file set information"},"put":{"description":"\nRequired roles:\n - can_write_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_set_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSetSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSetSchema"}}},"description":"Returns a file set that was updated"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"File set for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update file set information"}},"/v1/assets/{asset_id}/file_sets/{file_set_id}/files/":{"get":{"description":"\nRequired roles:\n - can_read_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_set_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"format":"int32","type":"integer"},"style":"form"},{"in":"query","name":"last_id","schema":{"type":"string"},"style":"form"},{"description":"Set to false if you don't need a URL, will speed things up","in":"query","name":"generate_signed_url","schema":{"default":true,"type":"boolean"},"style":"form"},{"description":"Set to true if you need a total amount of files in a file set","in":"query","name":"file_count","schema":{"default":false,"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilesSchema"}}},"description":"Returns files from a file set"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get files from a file set"}},"/v1/assets/{asset_id}/file_sets/{file_set_id}/purge/":{"delete":{"description":"\nRequired roles:\n - can_delete_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_set_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"File set for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Purge deleted asset's file set, file entries, and actual files."}},"/v1/assets/{asset_id}/file_sets/{file_set_id}/restore/":{"put":{"description":"\nRequired roles:\n - can_write_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_set_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"File set that has been restored"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"File set for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Restore delete asset's file set"}},"/v1/assets/{asset_id}/files/":{"get":{"description":"\nRequired roles:\n - can_read_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"Set to True if you do need a URL, this makes the request slower.","in":"query","name":"generate_signed_url","schema":{"default":false,"type":"boolean"},"style":"form"},{"description":"Set to attachment if you want a download link. Note that this will not create a download in asset history\n","in":"query","name":"content_disposition","schema":{"default":"inline","type":"string"},"style":"form"},{"description":"ID of a last file on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilesSchema"}}},"description":"Returns all files associated with this asset"},"401":{"description":"Token is invalid"},"404":{"description":"Files for this asset don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all asset's files"},"post":{"description":"\nRequired roles:\n - can_write_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileCreateSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSchema"}}},"description":"Returns a file that was created for this asset"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create file and associate to asset"}},"/v1/assets/{asset_id}/files/{file_id}/":{"delete":{"description":"\nRequired roles:\n - can_delete_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"401":{"description":"Token is invalid"},"404":{"description":"File for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete asset's file entry (Not the actual file, use DELETE file_set for that)"},"get":{"description":"\nRequired roles:\n - can_read_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Set to true to get a new upload url for the file","in":"query","name":"generate_signed_post_url","schema":{"default":false,"type":"boolean"},"style":"form"},{"description":"Set to attachment if you want a download link. Note that this will not create an asset history entry for the download\n","in":"query","name":"content_disposition","schema":{"default":"inline","type":"string"},"style":"form"},{"description":"Content type to add to the pre-signed upload url","in":"query","name":"content_type","schema":{"type":"string"},"style":"form"},{"description":"Set to true to get a new url for the file rather than using a cached url","in":"query","name":"bypass_url_cache","schema":{"default":false,"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSchema"}}},"description":"Returns a file associated with this asset"},"401":{"description":"Token is invalid"},"404":{"description":"File for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get asset's file"},"patch":{"description":"\nRequired roles:\n - can_write_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSchema"}}},"description":"Returns a file that was updated"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"File for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update file information"},"put":{"description":"\nRequired roles:\n - can_write_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSchema"}}},"description":"Returns a file that was updated"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"File for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update file information"}},"/v1/assets/{asset_id}/files/{file_id}/capture/{milliseconds}/":{"post":{"description":"\nRequired roles:\n - can_create_poster\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"milliseconds","required":true,"schema":{"format":"int32","type":"integer"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscodeRequestSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscodeResponseSchema"}}},"description":"OK"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"File or asset not found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a transcode job for creating still keyframe"}},"/v1/assets/{asset_id}/files/{file_id}/download_url/":{"get":{"description":"\nRequired roles:\n - can_read_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileDownloadURLSchema"}}},"description":"Returns a file download url"},"401":{"description":"Token is invalid"},"404":{"description":"File for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get asset's file download URL"}},"/v1/assets/{asset_id}/files/{file_id}/edit_proxies/":{"post":{"description":"\nRequired roles:\n - can_create_transcode_jobs\n- can_write_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditProxySchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditProxyResponseSchema"}}},"description":"ID and status of the job"},"204":{"description":"No edit proxy created"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create format, file_set, and file for edit proxy if storage has edit proxy transcoder configured"}},"/v1/assets/{asset_id}/files/{file_id}/isg_handler_url/":{"get":{"description":"\nRequired roles:\n - can_read_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ISGHandlerURLSchema"}}},"description":"Returns a file handler URL for ISG"},"401":{"description":"Token is invalid"},"404":{"description":"File for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get asset's file handler URL for ISG"}},"/v1/assets/{asset_id}/files/{file_id}/keyframes/":{"post":{"description":"\nRequired roles:\n - can_create_transcode_jobs\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscodeRequestSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscodeResponseSchema"}}},"description":"OK"},"204":{"description":"Transcode was ignored by Storage ignore pattern"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"File or asset not found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a transcode job for proxy and keyframes"}},"/v1/assets/{asset_id}/files/{file_id}/mediainfo/":{"post":{"description":"\nRequired roles:\n - can_create_transcode_jobs\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscodeRequestSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscodeResponseSchema"}}},"description":"OK"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"File or asset not found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a job for extracting mediainfo"}},"/v1/assets/{asset_id}/files/{file_id}/multipart/":{"post":{"deprecated":true,"description":"\nRequired roles:\n - can_write_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Use temporary file record","in":"query","name":"temporary","schema":{"default":false,"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultipartUploadSchema"}}},"description":"body","required":true},"responses":{"200":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Complete multipart upload (GCS)."}},"/v1/assets/{asset_id}/files/{file_id}/multipart/b2/cancel/":{"post":{"description":"\nRequired roles:\n - can_write_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Use temporary file record","in":"query","name":"temporary","schema":{"default":false,"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultipartB2CancelUpload"}}},"description":"body","required":true},"responses":{"200":{"description":"Upload canceled"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Cancel Backblaze B2 multipart upload."}},"/v1/assets/{asset_id}/files/{file_id}/multipart/b2/finish/":{"post":{"description":"\nRequired roles:\n - can_write_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Use temporary file record","in":"query","name":"temporary","schema":{"default":false,"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultipartB2FinishUpload"}}},"description":"body","required":true},"responses":{"200":{"description":"Successful upload"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Complete Backblaze B2 multipart upload."}},"/v1/assets/{asset_id}/files/{file_id}/multipart/b2/start/":{"post":{"description":"\nRequired roles:\n - can_write_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Use temporary file record","in":"query","name":"temporary","schema":{"default":false,"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultipartB2StartUpload"}}},"description":"body","required":false},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultipartB2StartUpload"}}},"description":"Returns part upload url"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Start Backblaze B2 multipart upload."}},"/v1/assets/{asset_id}/files/{file_id}/multipart/cleanup/":{"post":{"description":"\nRequired roles:\n - can_write_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultipartUploadCleanupSchema"}}},"description":"body","required":true},"responses":{"200":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Cleanup multipart upload (GCS, S3)."}},"/v1/assets/{asset_id}/files/{file_id}/multipart/gcs/compose_url/":{"post":{"description":"\nRequired roles:\n - can_write_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Use temporary file record","in":"query","name":"temporary","schema":{"default":false,"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultipartUploadComposeSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiPartUploadComposeURLSchema"}}},"description":"Return pre-signed compose url"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get object compose url for GCS parallel upload."}},"/v1/assets/{asset_id}/files/{file_id}/multipart_url/":{"get":{"description":"\nRequired roles:\n - can_write_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Multipart UploadId","in":"query","name":"upload_id","required":true,"schema":{"type":"string"},"style":"form"},{"description":"List of multipart upload urls of required type","in":"query","name":"type","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Maximum PartNumber that multipart upload has","in":"query","name":"max_part_number","required":false,"schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"Use temporary file record","in":"query","name":"temporary","schema":{"default":false,"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiPartURLsSchema"}}},"description":"Returns presigned urls for multipart upload"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get presigned urls for multipart upload (S3)."}},"/v1/assets/{asset_id}/files/{file_id}/multipart_url/part/":{"get":{"description":"\nRequired roles:\n - can_write_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Multipart UploadId","in":"query","name":"upload_id","schema":{"type":"string"},"style":"form"},{"description":"Number of parts to upload","in":"query","name":"parts_num","required":true,"schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"Which page number to fetch","in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"integer"},"style":"form"},{"description":"Use temporary file record","in":"query","name":"temporary","schema":{"default":false,"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiPartUploadURLsSchema"}}},"description":"Returns presigned urls for multipart part upload"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get presigned urls for multipart part upload (S3 & GCS)."}},"/v1/assets/{asset_id}/files/{file_id}/multipart_url/s3/part/":{"post":{"description":"\nRequired roles:\n - can_write_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Use temporary file record","in":"query","name":"temporary","schema":{"default":false,"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiPartS3UrlPartsSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiPartS3UrlPartsSchema"}}},"description":"Returns presigned urls for S3 multipart part upload"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"File or asset not found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create presigned urls for multipart part S3 upload."}},"/v1/assets/{asset_id}/files/{file_id}/reindex/":{"post":{"description":"\nRequired roles:\n - can_reindex_storages\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"201":{"description":"ID and status of the job"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Trigger reindexing of a file"}},"/v1/assets/{asset_id}/files/{file_id}/subtitles/":{"post":{"description":"\nRequired roles:\n - can_create_transcode_jobs\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubtitleRequestSchema"}}},"description":"body","required":false},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"File or asset not found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a transcode job for subtitle files"}},"/v1/assets/{asset_id}/formats/":{"get":{"description":"\nRequired roles:\n - can_read_formats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"ID of a last format on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"},{"description":"If true return asset's formats for all versions","in":"query","name":"include_all_versions","schema":{"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatsSchema"}}},"description":"Returns all formats associated with this asset"},"401":{"description":"Token is invalid"},"404":{"description":"Formats for this asset don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all asset's formats"},"post":{"description":"\nRequired roles:\n - can_write_formats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatSchema"}}},"description":"Returns a format that was created for this asset"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create format and associate to asset"}},"/v1/assets/{asset_id}/formats/{format_id}/":{"delete":{"description":"\nRequired roles:\n - can_delete_formats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"format_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Permanently delete format without sending it to the Recycle Bin","in":"query","name":"immediately","required":false,"schema":{"type":"boolean"},"style":"form"}],"responses":{"200":{"description":"Format that marked as deleted"},"204":{"description":"Without body in case `immediately` option was provided"},"401":{"description":"Token is invalid"},"404":{"description":"Format for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete asset's format"},"get":{"description":"\nRequired roles:\n - can_read_formats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"format_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatSchema"}}},"description":"Returns a format associated with this asset"},"401":{"description":"Token is invalid"},"404":{"description":"Format for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get asset's format"},"patch":{"description":"\nRequired roles:\n - can_write_formats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"format_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"If true update component_ids for matching file sets","in":"query","name":"sync_components","schema":{"default":false,"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatSchema"}}},"description":"Returns a format that was updated"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Format for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update format information"},"put":{"description":"\nRequired roles:\n - can_write_formats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"format_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"If true update component_ids for matching file sets","in":"query","name":"sync_components","schema":{"default":false,"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatSchema"}}},"description":"Returns a format that was updated"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Format for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update format information"}},"/v1/assets/{asset_id}/formats/{format_id}/archive/":{"delete":{"description":"\nRequired roles:\n - can_delete_archived_formats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"format_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatDeleteArchiveSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"No body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Format for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete archived format"},"post":{"description":"\nRequired roles:\n - can_archive_formats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"format_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Enable transfer through iconik host (creates egress)","in":"query","name":"allow_host_transfer","schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatArchiveSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"No body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Format for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Archive format"}},"/v1/assets/{asset_id}/formats/{format_id}/components/":{"get":{"description":"\nRequired roles:\n - can_read_formats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"format_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComponentsSchema"}}},"description":"Returns all formats associated with this asset"},"400":{"description":"Invalid input (Wrong type of UUID or JSON)"},"401":{"description":"Token is invalid"},"404":{"description":"Asset/Format/Component don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all components for a format in an asset"},"post":{"description":"\nRequired roles:\n - can_create_formats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"format_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComponentSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComponentSchema"}}},"description":"Returns the created component"},"400":{"description":"Invalid input (Wrong type of UUID or JSON)"},"401":{"description":"Token is invalid"},"404":{"description":"Formats for this asset don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Add a new format component"}},"/v1/assets/{asset_id}/formats/{format_id}/components/{component_id}/":{"delete":{"description":"\nRequired roles:\n - can_delete_formats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"format_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"component_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComponentsSchema"}}},"description":"Returns all formats associated with this asset"},"400":{"description":"Invalid input (Wrong type of UUID or JSON)"},"401":{"description":"Token is invalid"},"404":{"description":"Formats for this asset don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete a component in a format"},"get":{"description":"\nRequired roles:\n - can_read_formats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"format_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"component_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComponentsSchema"}}},"description":"Returns all formats associated with this asset"},"400":{"description":"Invalid input (Wrong type of UUID or JSON)"},"401":{"description":"Token is invalid"},"404":{"description":"Asset/Format/Component don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get a component for a format in an asset"},"put":{"description":"\nRequired roles:\n - can_create_formats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"format_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"component_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComponentSchema"}}},"description":"Returns the edited component"},"400":{"description":"Invalid input (Wrong type of UUID or JSON)"},"401":{"description":"Token is invalid"},"404":{"description":"Formats for this asset don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update a component in a format"}},"/v1/assets/{asset_id}/formats/{format_id}/file_sets/":{"get":{"description":"\nRequired roles:\n - can_read_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"format_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"ID of a last file set on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSetsSchema"}}},"description":"Returns all file sets associated with this asset"},"401":{"description":"Token is invalid"},"404":{"description":"FileSets for this asset don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all asset's file sets in a specific format"}},"/v1/assets/{asset_id}/formats/{format_id}/file_sets/sources/":{"get":{"description":"\nRequired roles:\n - can_read_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"format_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSetSourcesSchema"}}},"description":"Returns a files"},"400":{"description":"Invalid input (Wrong type of UUID or JSON)"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all file sets with matching format and storage method"}},"/v1/assets/{asset_id}/formats/{format_id}/file_sets/sources/{storage_method}/":{"get":{"description":"\nRequired roles:\n - can_read_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"format_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_method","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSetsSchema"}}},"description":"Returns a files"},"400":{"description":"Invalid input (Wrong type of UUID or JSON)"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all file sets with matching format and storage method"}},"/v1/assets/{asset_id}/formats/{format_id}/purge/":{"delete":{"description":"\nRequired roles:\n - can_delete_formats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"format_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Format for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Purge deleted asset's format"}},"/v1/assets/{asset_id}/formats/{format_id}/restore/":{"post":{"description":"\nRequired roles:\n - can_restore_archived_formats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"format_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Enable transfer through iconik host (creates egress)","in":"query","name":"allow_host_transfer","schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatRestoreSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"No body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Format for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Restore archived format"},"put":{"description":"\nRequired roles:\n - can_write_formats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"format_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Format that has been restored"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Format for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Restore deleted asset's format"}},"/v1/assets/{asset_id}/formats/{format_id}/storages/{storage_id}/file_sets/":{"get":{"description":"\nRequired roles:\n - can_read_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"format_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"ID of a last file set on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSetsSchema"}}},"description":"Returns all file sets associated with this asset"},"401":{"description":"Token is invalid"},"404":{"description":"FileSets for this asset don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all asset's file sets in a specific format on a specific storage"}},"/v1/assets/{asset_id}/formats/{name}/":{"get":{"description":"\nRequired roles:\n - can_read_formats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"name","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatSchema"}}},"description":"Returns a format associated with this asset"},"401":{"description":"Token is invalid"},"404":{"description":"Format for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get asset's format"}},"/v1/assets/{asset_id}/keyframes/":{"get":{"description":"\nRequired roles:\n - can_read_assets\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"Set to false if you don't need a URL, will speed things up","in":"query","name":"generate_signed_url","schema":{"default":true,"type":"boolean"},"style":"form"},{"description":"Set to attachment if you do not want a download link","in":"query","name":"content_disposition","schema":{"default":"inline","type":"string"},"style":"form"},{"description":"ID of a last keyframe on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"},{"description":"If true return asset's keyframes for all versions","in":"query","name":"include_all_versions","schema":{"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyframesSchema"}}},"description":"Returns all keyframes associated with this asset"},"401":{"description":"Token is invalid"},"404":{"description":"Keyframes for this asset don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all asset's keyframes"},"post":{"description":"\nRequired roles:\n - can_write_keyframes\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Set to True to get a google resumable upload link","in":"query","name":"use_google_resumable_upload","schema":{"default":false,"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyframeCreateSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyframeCreateSchema"}}},"description":"Returns a keyframe that was created for this asset"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create keyframe and associate to asset"}},"/v1/assets/{asset_id}/keyframes/{keyframe_id}/":{"delete":{"description":"\nRequired roles:\n - can_write_keyframes\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"keyframe_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"keep_poster","required":false,"schema":{"type":"boolean"},"style":"form"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Keyframe for this asset don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete asset's keyframe"},"get":{"description":"\nRequired roles:\n - can_read_assets\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"keyframe_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Set to attachment if you do not want a download link","in":"query","name":"content_disposition","schema":{"default":"inline","type":"string"},"style":"form"},{"description":"Content type to add to the pre-signed upload url","in":"query","name":"content_type","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSchema"}}},"description":"Returns all files associated with this asset"},"401":{"description":"Token is invalid"},"404":{"description":"Keyframe for this asset don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get asset's proxy"},"patch":{"description":"\nRequired roles:\n - can_write_keyframes\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"keyframe_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyframeCreateSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyframeSchema"}}},"description":"Returns a keyframe that was updated"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Keyframe for this asset don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update keyframe information"},"put":{"description":"\nRequired roles:\n - can_write_keyframes\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"keyframe_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyframeCreateSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyframeSchema"}}},"description":"Returns a keyframe that was updated"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Keyframe for this asset don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update keyframe information"}},"/v1/assets/{asset_id}/keyframes/{keyframe_id}/public/":{"delete":{"description":"\nRequired roles:\n - can_write_keyframes\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"keyframe_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyframeSchema"}}},"description":"Returns a keyframe that was updated"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Make the keyframe link private"},"post":{"description":"\nRequired roles:\n - can_write_keyframes\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"keyframe_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyframeSchema"}}},"description":"Returns a keyframe that was updated"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Make the keyframe link public"}},"/v1/assets/{asset_id}/keyframes/{keyframe_id}/upload_url/":{},"/v1/assets/{asset_id}/method/{storage_method}/keyframes/":{"post":{"description":"\nRequired roles:\n - can_write_keyframes\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_method","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Set to True to get a google resumable upload link","in":"query","name":"use_google_resumable_upload","schema":{"default":false,"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyframeCreateSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyframeCreateSchema"}}},"description":"Returns a keyframe that was created for this asset"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create keyframe and associate to asset"}},"/v1/assets/{asset_id}/method/{storage_method}/proxies/":{"post":{"description":"\nRequired roles:\n - can_write_proxies\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_method","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyCreateSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyCreateSchema"}}},"description":"Returns a proxy that was created for this asset"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create proxy and associate to asset"}},"/v1/assets/{asset_id}/proxies/":{"get":{"description":"\nRequired roles:\n - can_read_proxies\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"Set to false if you don't need a URL, will speed things up","in":"query","name":"generate_signed_url","schema":{"default":true,"type":"boolean"},"style":"form"},{"description":"Set to attachment if you want a download link","in":"query","name":"content_disposition","schema":{"default":"inline","type":"string"},"style":"form"},{"description":"ID of a last proxy on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"},{"description":"Set to true to get a new url for the file rather than using a cached url","in":"query","name":"bypass_url_cache","schema":{"default":false,"type":"boolean"},"style":"form"},{"description":"If true return asset's keyframes for all versions","in":"query","name":"include_all_versions","schema":{"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxiesSchema"}}},"description":"Returns all proxies associated with this asset"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Proxies for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all asset's proxies"},"post":{"description":"\nRequired roles:\n - can_write_proxies\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyCreateSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyCreateSchema"}}},"description":"Returns a proxy that was created for this asset"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create proxy and associate to asset"}},"/v1/assets/{asset_id}/proxies/{proxy_id}/":{"delete":{"description":"\nRequired roles:\n - can_delete_proxies\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"proxy_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Proxy for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete asset's proxy"},"get":{"description":"\nRequired roles:\n - can_read_proxies\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"proxy_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Set to attachment if you want a download link","in":"query","name":"content_disposition","schema":{"default":"inline","type":"string"},"style":"form"},{"description":"Content type to add to the pre-signed upload url","in":"query","name":"content_type","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxySchema"}}},"description":"Returns proxy associated with this asset"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Proxy for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get asset's proxy"},"patch":{"description":"\nRequired roles:\n - can_write_proxies\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"proxy_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyUpdateSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxySchema"}}},"description":"Returns a proxy that was updated"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Proxy for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update proxy information"},"put":{"description":"\nRequired roles:\n - can_write_proxies\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"proxy_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyUpdateSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxySchema"}}},"description":"Returns a proxy that was updated"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Proxy for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update proxy information"}},"/v1/assets/{asset_id}/proxies/{proxy_id}/containers/":{"put":{"description":"\nRequired roles:\n - can_write_proxies\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"proxy_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"DRM","required":false,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Watermark","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyContainerSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyContainerSchema"}}},"description":"Returns created proxy file"},"302":{"description":"Redirect to playable url"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"425":{"description":"media not ready for streaming"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Crate Proxy container, this is just a testing endpoint"}},"/v1/assets/{asset_id}/proxies/{proxy_id}/containers/{container_id}/files/":{"post":{"description":"\nRequired roles:\n - can_write_proxies\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"proxy_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"container_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"DRM","required":false,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Watermark","required":false,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyFileSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyFileSchema"}}},"description":"Created Proxy File"},"302":{"description":"Redirect to playable url"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"425":{"description":"media not ready for streaming"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Crate Proxy container, this is just a testing endpoint"}},"/v1/assets/{asset_id}/proxies/{proxy_id}/download_url/":{"get":{"description":"\nRequired roles:\n - can_read_proxies\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"proxy_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyDownloadURLSchema"}}},"description":"Returns proxy associated with this asset"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Proxy for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get asset's proxy download url"}},"/v1/assets/{asset_id}/proxies/{proxy_id}/keyframes/":{"post":{"description":"\nRequired roles:\n - can_create_transcode_jobs\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"proxy_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscodeRequestSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscodeResponseSchema"}}},"description":"OK"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"File or asset not found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a transcode job for keyframes from a proxy"}},"/v1/assets/{asset_id}/proxies/{proxy_id}/multipart/cleanup/":{"post":{"description":"\nRequired roles:\n - can_write_proxies\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"proxy_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultipartUploadProxyCleanupSchema"}}},"description":"body","required":true},"responses":{"200":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Cleanup S3 multipart upload"}},"/v1/assets/{asset_id}/proxies/{proxy_id}/multipart_url/":{"get":{"description":"\nRequired roles:\n - can_write_proxies\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"proxy_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Multipart UploadId","in":"query","name":"upload_id","required":true,"schema":{"type":"string"},"style":"form"},{"description":"List of multipart upload urls of required type","in":"query","name":"type","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Maximum PartNumber that multipart upload has","in":"query","name":"max_part_number","required":false,"schema":{"format":"int32","type":"integer"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiPartURLsSchema"}}},"description":"Returns presigned urls for multipart upload"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get presigned urls for S3 multipart upload."}},"/v1/assets/{asset_id}/proxies/{proxy_id}/multipart_url/part/":{"get":{"description":"\nRequired roles:\n - can_write_proxies\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"proxy_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Multipart UploadId","in":"query","name":"upload_id","schema":{"type":"string"},"style":"form"},{"description":"Number of parts to upload","in":"query","name":"parts_num","required":true,"schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"Which page number to fetch","in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"integer"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiPartUploadURLsSchema"}}},"description":"Returns presigned urls for multipart part upload"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get presigned urls for S3 multipart part upload."}},"/v1/assets/{asset_id}/proxies/{proxy_id}/public/":{"delete":{"description":"\nRequired roles:\n - can_write_proxies\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"proxy_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxySchema"}}},"description":"Returns a proxy that was updated"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Make the proxy link private"},"post":{"description":"\nRequired roles:\n - can_write_proxies\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"proxy_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxySchema"}}},"description":"Returns a proxy that was updated"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Make the proxy link public"}},"/v1/assets/{asset_id}/subtitles/":{"get":{"description":"\nRequired roles:\n - can_read_asset_subtitles\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"ID of a last subtitle on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubtitlesSchema"}}},"description":"Returns all subtitles associated with this asset"},"401":{"description":"Token is invalid"},"404":{"description":"Subtitles for this asset don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all asset's subtitles"},"post":{"description":"\nRequired roles:\n - can_write_asset_subtitles\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubtitleSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubtitleSchema"}}},"description":"Returns a format that was created for this asset"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create subtitle proxy and associate to asset"}},"/v1/assets/{asset_id}/subtitles/{language}/":{"get":{"description":"\nRequired roles:\n - can_read_asset_subtitles\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"language","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubtitleSchema"}}},"description":"Returns a format associated with this asset"},"401":{"description":"Token is invalid"},"404":{"description":"Subtitle for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get asset's subtitle for a particular language"}},"/v1/assets/{asset_id}/subtitles/{language}/cc/":{"get":{"description":"\nRequired roles:\n - can_read_asset_subtitles\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"language","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubtitleSchema"}}},"description":"Returns a subtitle associated with this asset"},"401":{"description":"Token is invalid"},"404":{"description":"Subtitle for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get asset's closed captions subtitle for a particular language"}},"/v1/assets/{asset_id}/subtitles/{language}/cc/webvtt/":{"get":{"description":"\nRequired roles:\n - can_read_asset_subtitles\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"language","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"text/vtt":{"schema":{"type":"string"}}},"description":"Returns a subtitle file associated with this asset in a particular language"},"401":{"description":"Token is invalid"},"404":{"description":"Subtitle for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get asset's closed captions subtitle file for a particular language"}},"/v1/assets/{asset_id}/subtitles/{language}/webvtt/":{"get":{"description":"\nRequired roles:\n - can_read_asset_subtitles\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"language","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"text/vtt":{"schema":{"type":"string"}}},"description":"Returns a subtitle file associated with this asset in a particular language"},"401":{"description":"Token is invalid"},"404":{"description":"Subtitle for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get asset's subtitle file for a particular language"}},"/v1/assets/{asset_id}/subtitles/{subtitle_id}/":{"delete":{"description":"\nRequired roles:\n - can_delete_assets\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"subtitle_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"401":{"description":"Token is invalid"},"404":{"description":"Subtitle for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete asset's subtitle"},"get":{"description":"\nRequired roles:\n - can_read_asset_subtitles\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"subtitle_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubtitleSchema"}}},"description":"Returns a subtitle associated with this asset"},"401":{"description":"Token is invalid"},"404":{"description":"Subtitle for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get asset's subtitle for a language"},"patch":{"description":"\nRequired roles:\n - can_write_asset_subtitles\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"subtitle_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubtitleSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubtitleSchema"}}},"description":"Returns a subtitle that was updated"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Subtitle for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update subtitle information"},"put":{"description":"\nRequired roles:\n - can_write_asset_subtitles\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"subtitle_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubtitleSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubtitleSchema"}}},"description":"Returns a subtitle that was updated"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Subtitle for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update subtitle information"}},"/v1/assets/{asset_id}/subtitles/{subtitle_id}/cc/":{"delete":{"description":"\nRequired roles:\n - can_delete_assets\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"subtitle_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"401":{"description":"Token is invalid"},"404":{"description":"Subtitle for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete asset's subtitle"}},"/v1/assets/{asset_id}/temporary_file_sets/":{"post":{"description":"\nRequired roles:\n - can_write_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemporaryFileSetSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemporaryFileSetSchema"}}},"description":"Returns a file set that was created for this asset"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create temporary file set and associate to asset"}},"/v1/assets/{asset_id}/temporary_file_sets/{file_set_id}/":{"delete":{"description":"\nRequired roles:\n - can_delete_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_set_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"delete_cloud_objects","schema":{"default":true,"type":"boolean"},"style":"form"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"File set for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete temporary file set with files"}},"/v1/assets/{asset_id}/temporary_file_sets/{file_set_id}/files/":{"get":{"description":"\nRequired roles:\n - can_read_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_set_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Set to false if you don't need a URL, will speed things up","in":"query","name":"generate_signed_url","schema":{"default":true,"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilesSchema"}}},"description":"Returns files from a file set"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get files from a temporary file set"}},"/v1/assets/{asset_id}/temporary_files/":{"post":{"description":"\nRequired roles:\n - can_write_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"store","required":false,"schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemporaryFileCreateSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemporaryFileCreateSchema"}}},"description":"Returns a file that was created for this asset"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create temporary transfer file for FILE storage transfers"}},"/v1/assets/{asset_id}/temporary_files/{file_id}/":{"patch":{"description":"\nRequired roles:\n - can_write_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSchema"}}},"description":"Returns updated file"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Asset access denied"},"404":{"description":"No file found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update temporary file's info"},"put":{"description":"\nRequired roles:\n - can_write_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSchema"}}},"description":"Returns updated file"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Asset access denied"},"404":{"description":"No file found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update temporary file's info"}},"/v1/assets/{asset_id}/versions/all/file_sets/":{"delete":{"description":"\nRequired roles:\n - can_delete_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"ID of a last file set on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"description":"File sets were scheduled for deletion"},"401":{"description":"Token is invalid"},"404":{"description":"FileSets for this asset don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete asset's file sets"}},"/v1/assets/{asset_id}/versions/all/files/":{"delete":{"description":"\nRequired roles:\n - can_delete_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"401":{"description":"Token is invalid"},"404":{"description":"File for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete asset's files entries by version (Not the actual file, use DELETE file_set for that)"}},"/v1/assets/{asset_id}/versions/all/formats/":{"delete":{"description":"\nRequired roles:\n - can_delete_formats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Permanently delete format without sending it to the Recycle Bin","in":"query","name":"immediately","required":false,"schema":{"type":"boolean"},"style":"form"}],"responses":{"200":{"description":"Formats were scheduled for deletion"},"204":{"description":"Without body in case `immediately` option was provided"},"401":{"description":"Token is invalid"},"404":{"description":"Format for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete asset's formats all versions"}},"/v1/assets/{asset_id}/versions/all/keyframes/":{"delete":{"description":"\nRequired roles:\n - can_write_keyframes\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Keyframe for this asset don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete asset's keyframes all versions"}},"/v1/assets/{asset_id}/versions/all/proxies/":{"delete":{"description":"\nRequired roles:\n - can_delete_proxies\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Proxy for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete asset's proxies all versions"}},"/v1/assets/{asset_id}/versions/all/subtitles/":{"delete":{"description":"\nRequired roles:\n - can_delete_assets\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"401":{"description":"Token is invalid"},"404":{"description":"Subtitle for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete asset's subtitles all versions"}},"/v1/assets/{asset_id}/versions/{version_id}/file_sets/":{"delete":{"description":"\nRequired roles:\n - can_delete_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"version_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"ID of a last file set on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"description":"File sets were scheduled for deletion"},"401":{"description":"Token is invalid"},"404":{"description":"FileSets for this asset don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete asset's file sets by version"},"get":{"description":"\nRequired roles:\n - can_read_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"version_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"ID of a last file set on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"},{"description":"Set to true if you need a total amount of files in a file set","in":"query","name":"file_count","schema":{"default":false,"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSetsSchema"}}},"description":"Returns all file sets associated with this asset"},"401":{"description":"Token is invalid"},"404":{"description":"FileSets for this asset don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all asset's file sets by version"}},"/v1/assets/{asset_id}/versions/{version_id}/files/":{"delete":{"description":"\nRequired roles:\n - can_delete_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"version_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"401":{"description":"Token is invalid"},"404":{"description":"File for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete asset's files entries by version (Not the actual file, use DELETE file_set for that)"},"get":{"description":"\nRequired roles:\n - can_read_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"version_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"Set to False if you do not need a URL, will slow things down otherwise","in":"query","name":"generate_signed_url","schema":{"default":true,"type":"boolean"},"style":"form"},{"description":"Set to attachment if you want a download link. Note that this will not create a download in asset history\n","in":"query","name":"content_disposition","schema":{"default":"inline","type":"string"},"style":"form"},{"description":"ID of a last file on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilesSchema"}}},"description":"Returns all files associated with this asset"},"401":{"description":"Token is invalid"},"404":{"description":"Files for this asset don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all asset's files by version"}},"/v1/assets/{asset_id}/versions/{version_id}/formats/":{"delete":{"description":"\nRequired roles:\n - can_delete_formats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"version_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Permanently delete format without sending it to the Recycle Bin","in":"query","name":"immediately","required":false,"schema":{"type":"boolean"},"style":"form"}],"responses":{"200":{"description":"Formats were scheduled for deletion"},"204":{"description":"Without body in case `immediately` option was provided"},"401":{"description":"Token is invalid"},"404":{"description":"Format for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete asset's formats by version"},"get":{"description":"\nRequired roles:\n - can_read_formats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"version_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"ID of a last format on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatsSchema"}}},"description":"Returns all formats associated with this asset"},"401":{"description":"Token is invalid"},"404":{"description":"Formats for this asset don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all asset's formats by version"}},"/v1/assets/{asset_id}/versions/{version_id}/keyframes/":{"delete":{"description":"\nRequired roles:\n - can_write_keyframes\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"version_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"keep_poster","required":false,"schema":{"type":"boolean"},"style":"form"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Keyframe for this asset don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete asset's keyframes by version"},"get":{"description":"\nRequired roles:\n - can_read_assets\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"version_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"Set to false if you don't need a URL, will speed things up","in":"query","name":"generate_signed_url","schema":{"default":true,"type":"boolean"},"style":"form"},{"description":"Set to attachment if you do not want a download link","in":"query","name":"content_disposition","schema":{"default":"inline","type":"string"},"style":"form"},{"description":"ID of a last keyframe on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyframesSchema"}}},"description":"Returns all keyframes associated with this asset"},"401":{"description":"Token is invalid"},"404":{"description":"Keyframes for this asset don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all asset's keyframes by version"}},"/v1/assets/{asset_id}/versions/{version_id}/proxies/":{"delete":{"description":"\nRequired roles:\n - can_delete_proxies\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"version_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Proxy for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete asset's proxies by version"},"get":{"description":"\nRequired roles:\n - can_read_proxies\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"version_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"Set to false if you don't need a URL, will speed things up","in":"query","name":"generate_signed_url","schema":{"default":true,"type":"boolean"},"style":"form"},{"description":"Set to attachment if you want a download link","in":"query","name":"content_disposition","schema":{"default":"inline","type":"string"},"style":"form"},{"description":"ID of a last proxy on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxiesSchema"}}},"description":"Returns all proxies associated with this asset"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Proxies for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all asset's proxies by version"}},"/v1/assets/{asset_id}/versions/{version_id}/proxies/{proxy_id}/{manifest_type}/":{"get":{"description":"\nRequired roles:\n - can_read_proxies\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"version_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"proxy_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"manifest_type","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"DRM","required":false,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Watermark","required":false,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"description":"Returns manifest/playlist for asset proxy"},"302":{"description":"Redirect to playable url"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"425":{"description":"media not ready for streaming"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Retrieve manifest/playlist for asset proxy"}},"/v1/assets/{asset_id}/versions/{version_id}/subtitles/":{"delete":{"description":"\nRequired roles:\n - can_delete_assets\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"version_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"401":{"description":"Token is invalid"},"404":{"description":"Subtitle for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete asset's subtitles by version"},"get":{"description":"\nRequired roles:\n - can_read_asset_subtitles\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"version_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"ID of a last subtitle on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubtitlesSchema"}}},"description":"Returns all subtitles associated with this asset"},"401":{"description":"Token is invalid"},"404":{"description":"Subtitles for this asset don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all asset's subtitles by version"}},"/v1/assets/{asset_id}/versions/{version_id}/subtitles/{language}/cc/webvtt/":{"get":{"description":"\nRequired roles:\n - can_read_asset_subtitles\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"version_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"language","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"text/vtt":{"schema":{"type":"string"}}},"description":"Returns a subtitle file associated with this asset in a particular language"},"401":{"description":"Token is invalid"},"404":{"description":"Subtitle for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get asset's closed captions subtitle file for a particular language by version"}},"/v1/assets/{asset_id}/versions/{version_id}/subtitles/{language}/webvtt/":{"get":{"description":"\nRequired roles:\n - can_read_asset_subtitles\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"version_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"language","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"text/vtt":{"schema":{"type":"string"}}},"description":"Returns a subtitle file associated with this asset in a particular language"},"401":{"description":"Token is invalid"},"404":{"description":"Subtitle for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get asset's subtitle file for a particular language by version"}},"/v1/assets/{asset_id}/versions/{version_id}/transcode/":{"post":{"description":"\nRequired roles:\n - can_create_transcode_jobs\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"version_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscodeRequestSchema"}}},"description":"body","required":true},"responses":{"200":{"description":"Transcode job created successfully"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"404":{"description":"Asset or version not found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a transcode job for a specific asset version"}},"/v1/collections/{collection_id}/custom_keyframe/{poster_id}/":{"post":{"description":"\nRequired roles:\n - can_write_keyframes\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"collection_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"poster_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"set to false to keep current custom_poster and custom_keyframe on asset","in":"query","name":"overwrite","required":false,"schema":{"type":"boolean"},"style":"form"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionKeyframeSchema"}}},"description":"Returns custom keyframe"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Set keyframe of type poster as collection keyframe"}},"/v1/collections/{collection_id}/export_locations/{export_location_id}/":{"post":{"description":"\nRequired roles:\n - can_write_exports\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"collection_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"export_location_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Enable transfer through iconik host (creates egress)","in":"query","name":"allow_host_transfer","schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionExportSchema"}}},"description":"body","required":true},"responses":{"200":{"description":"Returns an export job id"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Export collection assets to export location"}},"/v1/collections/{collection_id}/keyframes/":{"get":{"description":"\nRequired roles:\n - can_read_collections\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"collection_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"Set to false if you don't need a URL, will speed things up","in":"query","name":"generate_signed_url","schema":{"default":true,"type":"boolean"},"style":"form"},{"description":"ID of a last collection keyframe on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionKeyframesSchema"}}},"description":"Returns all keyframes associated with this collection"},"401":{"description":"Token is invalid"},"404":{"description":"Keyframes for this collection don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all collection's keyframes"},"post":{"description":"\nRequired roles:\n - can_write_keyframes\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"collection_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionKeyframeCreateSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionKeyframeCreateSchema"}}},"description":"Returns a keyframe that was created for this collection"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create keyframe and associate to collection"}},"/v1/collections/{collection_id}/keyframes/copy/":{"post":{"description":"\nRequired roles:\n - can_write_keyframes\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"collection_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionCopyKeyframesRequestSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionCopyKeyframesResponseSchema"}}},"description":"Returns all keyframe that were created for this collection"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Copy collection keyframe to another collection"}},"/v1/collections/{collection_id}/keyframes/{keyframe_id}/":{"delete":{"description":"\nRequired roles:\n - can_write_keyframes\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"collection_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"keyframe_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"set to true to force a regeneration of default keyframes","in":"query","name":"regenerate_keyframes","required":false,"schema":{"type":"boolean"},"style":"form"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Keyframe for this collection don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete collection's keyframe"},"get":{"description":"\nRequired roles:\n - can_read_collections\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"collection_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"keyframe_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionKeyframeSchema"}}},"description":"Returns a keyframe associated with this collection"},"401":{"description":"Token is invalid"},"404":{"description":"Keyframe for this collection don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get collection's proxy"},"patch":{"description":"\nRequired roles:\n - can_write_keyframes\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"collection_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"keyframe_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionKeyframeSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionKeyframeSchema"}}},"description":"Returns a keyframe that was updated"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Keyframe for this collection don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update keyframe information"},"put":{"description":"\nRequired roles:\n - can_write_keyframes\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"collection_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"keyframe_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionKeyframeSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionKeyframeSchema"}}},"description":"Returns a keyframe that was updated"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Keyframe for this collection don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update keyframe information"}},"/v1/collections/{collection_id}/keyframes/{keyframe_id}/gcs_resumable_upload/":{},"/v1/collections/{collection_id}/keyframes/{keyframe_id}/upload_url/":{},"/v1/delete_queue/file_sets/":{"delete":{"description":"\nRequired roles:\n - can_write_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteQueueSchema"}}},"description":"body","required":true},"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Restore file sets from delete queue"},"get":{"description":"\nRequired roles:\n - can_read_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"Which page number to fetch","in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"integer"},"style":"form"},{"description":"A comma separated list of fieldnames with order. For example - first_name,asc;last_name,desc","in":"query","name":"sort","schema":{"type":"string"},"style":"form"},{"description":"Search using query","in":"query","name":"query","schema":{"type":"string"},"style":"form"},{"description":"filter by field_name","in":"query","name":"field_name","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileSetsElasticSchema"}}},"description":"Returns a list of file sets"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get deleted file sets"}},"/v1/delete_queue/file_sets/purge/":{"post":{"description":"\nRequired roles:\n - can_purge_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteQueueSchema"}}},"description":"body","required":true},"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Purge file sets from delete queue (Permanently delete)"}},"/v1/delete_queue/file_sets/purge/all/":{"post":{"description":"\nRequired roles:\n - can_purge_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"401":{"description":"Token is invalid"},"403":{"description":"User does not have permission"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Purge all file sets from delete queue (Permanently delete)"}},"/v1/delete_queue/formats/":{"delete":{"description":"\nRequired roles:\n - can_write_formats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteQueueSchema"}}},"description":"body","required":true},"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Restore formats from delete queue"},"get":{"description":"\nRequired roles:\n - can_read_formats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"Which page number to fetch","in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"integer"},"style":"form"},{"description":"A comma separated list of fieldnames with order. For example - first_name,asc;last_name,desc","in":"query","name":"sort","schema":{"type":"string"},"style":"form"},{"description":"Search using query","in":"query","name":"query","schema":{"type":"string"},"style":"form"},{"description":"filter by field_name","in":"query","name":"field_name","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormatsElasticSchema"}}},"description":"Returns a list of formats"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get deleted formats"}},"/v1/delete_queue/formats/purge/":{"post":{"description":"\nRequired roles:\n - can_purge_formats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteQueueSchema"}}},"description":"body","required":true},"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Purge formats from delete queue (Permanently delete)"}},"/v1/delete_queue/formats/purge/all/":{"post":{"description":"\nRequired roles:\n - can_purge_formats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"401":{"description":"Token is invalid"},"403":{"description":"User does not have permission"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Purge all formats from delete queue (Permanently delete)"}},"/v1/drm/assets/{asset_id}/versions/{version_id}/proxies/{proxy_id}/auth/":{"post":{"description":"\nRequired roles:\n - can_read_proxies\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"version_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"proxy_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"DRM","required":false,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"token":{"type":"string"}}}}},"description":"Authentication token"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Permission on storage denied"},"404":{"description":"Asset or storage not found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get authentication token for a given asset proxy."}},"/v1/export_locations/":{"get":{"description":"\nRequired roles:\n - can_read_export_locations\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Search query","in":"query","name":"query","schema":{"type":"string"},"style":"form"},{"description":"Filter list of id:s (comma separated)","in":"query","name":"ids","schema":{"type":"string"},"style":"form"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"ID of a last export_location on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"},{"description":"A comma separated list of fieldnames with order. For example - name,asc;id,desc","in":"query","name":"sort","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportLocationsSchema"}}},"description":"Returns a list of export_locations"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all export_locations"},"post":{"description":"\nRequired roles:\n - can_write_export_locations\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportLocationSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportLocationSchema"}}},"description":"Returns a created export_location entry"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a new export_location"}},"/v1/export_locations/{export_location_id}/":{"delete":{"description":"\nRequired roles:\n - can_delete_export_locations\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"export_location_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"401":{"description":"Token is invalid"},"404":{"description":"ExportLocation doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete a particular export_location by id"},"get":{"description":"\nRequired roles:\n - can_read_export_locations\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"export_location_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportLocationSchema"}}},"description":"Returns a export_location"},"401":{"description":"Token is invalid"},"404":{"description":"ExportLocation doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns a particular export_location by id"},"patch":{"description":"\nRequired roles:\n - can_write_export_locations\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"export_location_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportLocationSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportLocationSchema"}}},"description":"Returns an updated export_location"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update export_location"},"put":{"description":"\nRequired roles:\n - can_write_export_locations\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"export_location_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportLocationSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportLocationSchema"}}},"description":"Returns an updated export_location"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update export_location"}},"/v1/export_locations/{export_location_id}/bulk_export/":{"post":{"description":"\nRequired roles:\n - can_write_exports\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"export_location_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Enable transfer through iconik host (creates egress)","in":"query","name":"allow_host_transfer","schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkFilesetExportSchema"}}},"description":"body","required":true},"responses":{"200":{"description":"Returns an export job id"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Export multiple objects to export location"}},"/v1/export_locations/{export_location_id}/reindex/":{"post":{"description":"\nRequired roles:\n - can_reindex_export_locations\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"export_location_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"201":{"description":"ID and status of the job"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Trigger reindexing of a export location"}},"/v1/exports/temporary_file_sets/{file_set_id}/storages/{storage_id}/":{"post":{"description":"\nRequired roles:\n - can_read_files\n- can_write_transfers\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_set_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Destination storage_id","in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompleteExportToLocalStorageSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"Export queued"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Permission on storage denied"},"404":{"description":"File set or storage not found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Queue export job completion between local storages"}},"/v1/file_sets/{file_set_id}/files/":{"get":{"deprecated":true,"description":"\nRequired roles:\n - can_read_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_set_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Set to false if you don't need a URL, will speed things up","in":"query","name":"generate_signed_url","schema":{"default":true,"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilesSchema"}}},"description":"Returns files from a file set"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get files from a file set"}},"/v1/file_sets/{file_set_id}/storages/{storage_id}/":{"post":{"description":"\nRequired roles:\n - can_read_files\n- can_write_transfers\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_set_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Destination storage_id","in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Enable transfer through iconik host (creates egress)","in":"query","name":"allow_host_transfer","schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferFromStorageSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"Copy job created"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Permission on storage denied"},"404":{"description":"File set or storage not found"},"409":{"description":"File set with same components already exists on storage."},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Queue copying of a file set with files from one storage to another"}},"/v1/file_sets/{file_set_id}/transfers_from/{storage_id}/":{"delete":{"deprecated":true,"description":"\nRequired roles:\n - can_write_transfers\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_set_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"failed","required":false,"schema":{"type":"boolean"},"style":"form"}],"responses":{"204":{"description":"Transfer job was deleted"},"404":{"description":"Transfer job does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete file set transfer after handling it"}},"/v1/file_sets/{file_set_id}/transfers_to/{storage_id}/":{"delete":{"deprecated":true,"description":"\nRequired roles:\n - can_write_transfers\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_set_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"failed","required":false,"schema":{"type":"boolean"},"style":"form"}],"responses":{"204":{"description":"Transfer job was deleted"},"404":{"description":"Transfer job does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete file set transfer after handling it"}},"/v1/files/checksum/{checksum}/":{"get":{"description":"\nRequired roles:\n - can_read_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"checksum","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"format":"int32","type":"integer"},"style":"form"},{"in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilesSchema"}}},"description":"Returns all files that has specified checksum"},"401":{"description":"Token is invalid"},"404":{"description":"Files with this checksum don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get files by checksum"}},"/v1/files/missing/storages/{storage_id}/":{"delete":{"description":"\nRequired roles:\n - can_delete_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"remove_assets","schema":{"type":"boolean"},"style":"form"}],"responses":{"202":{"description":"Files cleanup scheduled"},"401":{"description":"Token is invalid"},"403":{"description":"Permission denied"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete all missing files from storage"}},"/v1/files/storages/{storage_id}/":{"post":{"description":"\nRequired roles:\n - can_read_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"get_file_size","required":false,"schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileExistenceCheckSchema"}}},"description":"body","required":true},"responses":{"200":{"description":"File exists"},"401":{"description":"Token is invalid"},"404":{"description":"File doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Check file is on storage"}},"/v1/files/upload/":{"post":{"description":"\nRequired roles:\n - can_write_files\n- can_write_formats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/UploadFilesSchema"}}},"required":true},"responses":{"200":{"description":"File uploaded"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Permission denied"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Upload small files"}},"/v1/files/{file_id}/deletions_from/{storage_id}/":{"delete":{"deprecated":true,"description":"\nRequired roles:\n - is_storage_worker\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Deletion job was deleted"},"404":{"description":"Deletion job does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete file deletion job after handling it"}},"/v1/formats/{format_id}/file_sets/sources/":{},"/v1/formats/{format_id}/storages/{storage_id}/":{"post":{"description":"\nRequired roles:\n - can_read_formats\n- can_write_transfers\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"format_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Destination storage_id","in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferFromStorageSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"Copy job created"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Permission on storage denied"},"404":{"description":"File set or storage not found"},"409":{"description":"File set with same components already exists on storage."},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Queue copying of a formats file sets with files from one storage to another"}},"/v1/formats/{format_name}/archive/bulk/":{"post":{"description":"\nRequired roles:\n - can_archive_formats\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"format_name","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Enable transfer through iconik host (creates egress)","in":"query","name":"allow_host_transfer","schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkFilesetArchiveSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"Archive job created"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Storage not found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Queue bulk archiving of assets, collections and saved_searches"}},"/v1/formats/{format_name}/restore/bulk/":{"post":{"description":"\nRequired roles:\n - can_restore_archived_formats\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"format_name","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Enable transfer through iconik host (creates egress)","in":"query","name":"allow_host_transfer","schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkFilesetRestoreSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"Restore job created"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Storage not found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Queue bulk restore of previously archived assets, collections or saved_searches"}},"/v1/playlists/{playlist_id}/keyframes/":{"get":{"description":"\nRequired roles:\n - can_read_playlists\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"playlist_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"Set to false if you don't need a URL, will speed things up","in":"query","name":"generate_signed_url","schema":{"default":true,"type":"boolean"},"style":"form"},{"description":"ID of a last playlist keyframe on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlaylistKeyframesSchema"}}},"description":"Returns all keyframes associated with this playlist"},"401":{"description":"Token is invalid"},"404":{"description":"Keyframes for this playlist don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all playlist's keyframes"},"post":{"description":"\nRequired roles:\n - can_write_keyframes\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"playlist_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlaylistKeyframeCreateSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlaylistKeyframeCreateSchema"}}},"description":"Returns a keyframe that was created for this playlist"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create keyframe and associate to playlist"}},"/v1/playlists/{playlist_id}/keyframes/{keyframe_id}/":{"delete":{"description":"\nRequired roles:\n - can_write_keyframes\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"playlist_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"keyframe_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"set to true to force a regeneration of default keyframes","in":"query","name":"regenerate_keyframes","required":false,"schema":{"type":"boolean"},"style":"form"}],"responses":{"204":{"description":"Without body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Keyframe for this playlist don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete playlist's keyframe"},"get":{"description":"\nRequired roles:\n - can_read_playlists\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"playlist_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"keyframe_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlaylistKeyframeSchema"}}},"description":"Returns a keyframe associated with this playlist"},"401":{"description":"Token is invalid"},"404":{"description":"Keyframe for this playlist don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get playlist's keyframe"},"patch":{"description":"\nRequired roles:\n - can_write_keyframes\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"playlist_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"keyframe_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlaylistKeyframeSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlaylistKeyframeSchema"}}},"description":"Returns a keyframe that was updated"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Keyframe for this playlist don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update keyframe information"},"put":{"description":"\nRequired roles:\n - can_write_keyframes\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"playlist_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"keyframe_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlaylistKeyframeSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlaylistKeyframeSchema"}}},"description":"Returns a keyframe that was updated"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Keyframe for this playlist don't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update keyframe information"}},"/v1/playlists/{playlist_id}/keyframes/{keyframe_id}/gcs_resumable_upload/":{},"/v1/shares/storages/{storage_id}/files/":{"get":{"description":"\nRequired roles:\n - can_write_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"directory_path","required":true,"schema":{"type":"string"},"style":"form"},{"description":"Filter by name","in":"query","name":"name","required":true,"schema":{"type":"string"},"style":"form"}],"responses":{"204":{"description":"File exists"},"401":{"description":"Token is invalid"},"404":{"description":"No files found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Check if a specific file is already on the storage for shares"}},"/v1/storage_gateway_clusters/":{"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Which page number to fetch","in":"query","name":"page","schema":{"default":1,"format":"int32","minimum":1,"type":"integer"},"style":"form"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"format":"int32","maximum":100,"minimum":1,"type":"integer"},"style":"form"},{"in":"query","name":"query","required":false,"schema":{"type":"string"},"style":"form"},{"in":"query","name":"view_nodes","required":false,"schema":{"type":"boolean"},"style":"form"},{"in":"query","name":"view_stats","required":false,"schema":{"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconikStorageGatewayClustersSchema"}}},"description":"Returns a list of storage gateway clusters"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all storage gateway clusters"},"post":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconikStorageGatewayClusterSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconikStorageGatewayClusterSchema"}}},"description":"Cluster created successfully"},"400":{"description":"Invalid input"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a new storage gateway cluster"}},"/v1/storage_gateway_clusters/{cluster_id}/":{"delete":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"cluster_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Cluster deleted successfully"},"401":{"description":"Token is invalid"},"404":{"description":"Cluster doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete a storage gateway cluster"},"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"cluster_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"view_nodes","required":false,"schema":{"type":"boolean"},"style":"form"},{"in":"query","name":"view_stats","required":false,"schema":{"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconikStorageGatewayClusterReadSchema"}}},"description":"Returns the cluster"},"401":{"description":"Token is invalid"},"404":{"description":"Cluster doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get a specific storage gateway cluster"},"patch":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"cluster_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconikStorageGatewayClusterSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconikStorageGatewayClusterSchema"}}},"description":"Cluster updated successfully"},"400":{"description":"Invalid input"},"401":{"description":"Token is invalid"},"404":{"description":"Cluster doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update a storage gateway cluster"},"put":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"cluster_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconikStorageGatewayClusterSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconikStorageGatewayClusterSchema"}}},"description":"Cluster updated successfully"},"400":{"description":"Invalid input"},"401":{"description":"Token is invalid"},"404":{"description":"Cluster doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update a storage gateway cluster"}},"/v1/storage_gateways/":{"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"cluster_id","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Which page number to fetch","in":"query","name":"page","schema":{"default":1,"format":"int32","minimum":1,"type":"integer"},"style":"form"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"format":"int32","maximum":100,"minimum":1,"type":"integer"},"style":"form"},{"in":"query","name":"query","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconikStorageGatewaysSchema"}}},"description":"Returns a list of storage gateways"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all storage gateways"},"post":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconikStorageGatewaySchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconikStorageGatewaySchema"}}},"description":"Storage gateway created successfully"},"400":{"description":"Invalid input"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a new storage gateway"}},"/v1/storage_gateways/telemetry/":{"get":{"description":"\nRequired roles:\n - can_read_storages\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"format":"int32","type":"integer"},"style":"form"},{"description":"ID of a last item on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconikStorageGatewaysTelemetrySchema"}}},"description":"Returns telemetry records"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all telemetry records with optional filtering"}},"/v1/storage_gateways/telemetry/{worker_id}/":{"get":{"description":"\nRequired roles:\n - can_read_storages\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"worker_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconikStorageGatewayTelemetrySchema"}}},"description":"Returns telemetry for the worker"},"401":{"description":"Token is invalid"},"404":{"description":"Telemetry doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get telemetry for a specific worker"}},"/v1/storage_gateways/{storage_gateway_id}/":{"delete":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_gateway_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Storage gateway deleted successfully"},"401":{"description":"Token is invalid"},"404":{"description":"Storage gateway doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete a storage gateway"},"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_gateway_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconikStorageGatewayReadSchema"}}},"description":"Returns the storage gateway"},"401":{"description":"Token is invalid"},"404":{"description":"Storage gateway doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get a specific storage gateway"},"patch":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_gateway_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconikStorageGatewaySchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconikStorageGatewaySchema"}}},"description":"Storage gateway updated successfully"},"400":{"description":"Invalid input"},"401":{"description":"Token is invalid"},"404":{"description":"Storage gateway doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update a storage gateway"},"put":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_gateway_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconikStorageGatewaySchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconikStorageGatewaySchema"}}},"description":"Storage gateway updated successfully"},"400":{"description":"Invalid input"},"401":{"description":"Token is invalid"},"404":{"description":"Storage gateway doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update a storage gateway"}},"/v1/storage_gateways/{storage_gateway_id}/telemetry/":{"get":{"description":"\nRequired roles:\n - can_read_storages\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_gateway_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconikStorageGatewaysTelemetrySchema"}}},"description":"Returns telemetry for the storage gateway"},"401":{"description":"Token is invalid"},"404":{"description":"Storage gateway doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all telemetry for a specific storage gateway"},"post":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_gateway_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconikStorageGatewayTelemetrySchema"}}},"description":"body","required":true},"responses":{"201":{"description":"Returns an empty object"},"400":{"description":"Invalid input"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create telemetry"}},"/v1/storages/":{"get":{"description":"\nRequired roles:\n - can_read_storages\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Which page number to fetch","in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"integer"},"style":"form"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"},"style":"form"},{"description":"A comma separated list of fieldnames with order. For example - status,asc;last_scanned,desc","in":"query","name":"sort","schema":{"type":"string"},"style":"form"},{"description":"Filter by id","in":"query","name":"id","schema":{"type":"string"},"style":"form"},{"description":"Filter by name","in":"query","name":"name","schema":{"type":"string"},"style":"form"},{"description":"Filter by method","in":"query","name":"method","schema":{"type":"string"},"style":"form"},{"description":"Filter by status","in":"query","name":"status","schema":{"type":"string"},"style":"form"},{"description":"Filter by purpose","in":"query","name":"purpose","schema":{"type":"string"},"style":"form"},{"description":"Filter by last_scanned","in":"query","name":"last_scanned","schema":{"type":"string"},"style":"form"},{"description":"Filter by scanner_status","in":"query","name":"scanner_status","schema":{"type":"string"},"style":"form"},{"description":"Filter by any of the above with wildcard support","in":"query","name":"query","schema":{"type":"string"},"style":"form"},{"description":"Filter list of id:s (comma separated)","in":"query","name":"ids","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoragesReadSchema"}}},"description":"Returns a list of storages"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all storages"},"post":{"description":"\nRequired roles:\n - can_write_storages\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageSchema"}}},"description":"Returns a created storage entry"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a new storage"}},"/v1/storages/copy/":{},"/v1/storages/files/reindex/":{"post":{"description":"\nRequired roles:\n - can_reindex_storages\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"201":{"description":"ID and status of the job"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Trigger reindexing of all files"}},"/v1/storages/isg/latest_version/":{"get":{"description":"\nRequired roles:\n - can_read_storages\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"version":{"type":"string"}}}}},"description":"Returns version"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Storage does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get latest ISG version"}},"/v1/storages/matching/{purpose}/":{"get":{"description":"\nRequired roles:\n - can_read_storages\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"purpose","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"storage_id","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageSchema"}}},"description":"Returns a storage"},"401":{"description":"Token is invalid"},"404":{"description":"No matching storage exists"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns a remote storage matching type"}},"/v1/storages/matching/{purpose}/method/{method}/":{"get":{"description":"\nRequired roles:\n - can_read_storages\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"purpose","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"method","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageSchema"}}},"description":"Returns a storage"},"401":{"description":"Token is invalid"},"404":{"description":"No matching storage exists"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns a remote storage matching type and method"}},"/v1/storages/reindex/":{"post":{"description":"\nRequired roles:\n - can_reindex_storages\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"201":{"description":"ID and status of the job"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Trigger reindexing of all storages"}},"/v1/storages/swap/":{"post":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwapStoragesSchema"}}},"description":"body","required":true},"responses":{"201":{"description":"Scan started"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Requires SuperAdmin access"}},"/v1/storages/verifications/access/":{"post":{"description":"\nRequired roles:\n - can_read_storages\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageAccessSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"access_check":{"example":false,"type":"boolean"},"error_message":{"example":"The AWS Access Key Id you provided does not exist in our records.","type":"string"}},"type":"object"}}},"description":"Returns a document describing storage access"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"501":{"description":"Not implemented"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Verify access prior to creating a storage"}},"/v1/storages/verifications/permissions/":{"post":{"description":"\nRequired roles:\n - can_read_storages\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoragePermissionsSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"example":{"cors":true,"delete_access":true,"read_access":true,"write_access":false,"write_access_error":"ERROR: no access"},"properties":{"cors":{"type":"boolean"},"cors_error":{"type":"string"},"delete_access":{"type":"boolean"},"delete_access_error":{"type":"string"},"error_message":{"type":"string"},"read_access":{"type":"boolean"},"read_access_error":{"type":"string"},"write_access":{"type":"boolean"},"write_access_error":{"type":"string"}}}}},"description":"Returns a document describing storage permissions"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Storage does not exist"},"501":{"description":"Not implemented"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Verify permissions prior to creating a storage"}},"/v1/storages/{purpose}/default/":{"get":{"description":"\nRequired roles:\n - can_read_storages\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"purpose","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageSchema"}}},"description":"The default storage"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Permission denied"},"404":{"description":"Storage does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get a purpose default storage"}},"/v1/storages/{storage_id}/":{"delete":{"description":"\nRequired roles:\n - can_delete_storages\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"401":{"description":"Token is invalid"},"404":{"description":"Storage doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete a particular storage by id"},"get":{"description":"\nRequired roles:\n - can_read_storages\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageSchema"}}},"description":"Returns a storage"},"401":{"description":"Token is invalid"},"404":{"description":"Storage doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns a particular storage by id"},"patch":{"description":"\nRequired roles:\n - can_write_storages\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageSchema"}}},"description":"Returns an updated storage"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update storage"},"put":{"description":"\nRequired roles:\n - can_write_storages\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageSchema"}}},"description":"Returns an updated storage"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update storage"}},"/v1/storages/{storage_id}/auto_scan/":{"delete":{"description":"\nRequired roles:\n - can_scan_bucket\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Storage auto scan disabled"},"401":{"description":"Token is invalid"},"404":{"description":"Storage auto scan already disabled"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Disable cloud storage auto scan"},"get":{"description":"\nRequired roles:\n - can_scan_bucket\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageAutoScanSchema"}}},"description":"Storage auto scan settings"},"401":{"description":"Token is invalid"},"404":{"description":"Storage auto scan is disabled"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get cloud storage auto scan settings"},"post":{"description":"\nRequired roles:\n - can_scan_bucket\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageAutoScanSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageAutoScanSchema"}}},"description":"Storage auto scan enabled"},"401":{"description":"Token is invalid"},"404":{"description":"No matching storage exists"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Enable cloud storage auto scan"}},"/v1/storages/{storage_id}/bulk/":{"post":{"description":"\nRequired roles:\n - can_read_files\n- can_write_transfers\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Destination storage_id","in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Enable transfer through iconik host (creates egress)","in":"query","name":"allow_host_transfer","schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkTransferToStorageSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"Copy job created"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Storage not found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Queue copying of files from current storage to specified one"}},"/v1/storages/{storage_id}/default/":{"delete":{"description":"\nRequired roles:\n - can_write_storages\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Removes the default flag on a storage"},"post":{"description":"\nRequired roles:\n - can_write_storages\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"201":{"description":"Success"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Set a storage to the default of its purpose"}},"/v1/storages/{storage_id}/deletions/":{"get":{"deprecated":true,"description":"\nRequired roles:\n - is_storage_worker\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"ID of a last file deletion entity on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileDeletionsSchema"}}},"description":"Returns pending deletions to be handled"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get pending deletions of files from a local storage"}},"/v1/storages/{storage_id}/deletions/{deletion_id}/":{"delete":{"deprecated":true,"description":"\nRequired roles:\n - is_storage_worker\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"deletion_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Deletion job was deleted"},"404":{"description":"Deletion job does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete file deletion job after handling it"}},"/v1/storages/{storage_id}/deletions_from/":{"get":{"description":"\nRequired roles:\n - is_storage_worker\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"ID of a last file deletion entity on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileDeletionsSchema"}}},"description":"Returns pending deletions to be handled"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get pending deletions of files from a local storage"}},"/v1/storages/{storage_id}/files/":{"delete":{"description":"\nRequired roles:\n - can_read_storages\n- can_delete_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"path","required":false,"schema":{"type":"string"},"style":"form"},{"in":"query","name":"path_separator","required":false,"schema":{"type":"string"},"style":"form"},{"in":"query","name":"directory_path","required":false,"schema":{"type":"string"},"style":"form"},{"in":"query","name":"checksum","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Filter by id","in":"query","name":"id","schema":{"type":"string"},"style":"form"},{"description":"Filter by name","in":"query","name":"name","schema":{"type":"string"},"style":"form"},{"description":"Filter by type","in":"query","name":"type","schema":{"type":"string"},"style":"form"},{"description":"Filter by status","in":"query","name":"status","schema":{"type":"string"},"style":"form"},{"description":"Filter by date_created","in":"query","name":"date_created","schema":{"type":"string"},"style":"form"},{"description":"Filter by date_modified","in":"query","name":"date_modified","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilesElasticSchema"}}},"description":"Returns files"},"401":{"description":"Token is invalid"},"404":{"description":"No files found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"DELETE files (with copies in different storages) from a storage folder, or a storage"},"get":{"description":"\nRequired roles:\n - can_list_storage_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"path","required":false,"schema":{"type":"string"},"style":"form"},{"in":"query","name":"path_separator","required":false,"schema":{"type":"string"},"style":"form"},{"in":"query","name":"directory_path","required":false,"schema":{"type":"string"},"style":"form"},{"in":"query","name":"checksum","required":false,"schema":{"type":"string"},"style":"form"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"},"style":"form"},{"description":"Which page number to fetch","in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"integer"},"style":"form"},{"description":"If true passed then uses scroll pagination instead of default one","in":"query","name":"scroll","schema":{"type":"boolean"},"style":"form"},{"description":"In order to get next batch of results using scroll pagination the scroll_id is required","in":"query","name":"scroll_id","schema":{"type":"string"},"style":"form"},{"description":"A comma separated list of fieldnames with order. For example - first_name,asc;last_name,desc","in":"query","name":"sort","schema":{"type":"string"},"style":"form"},{"description":"Filter by id","in":"query","name":"id","schema":{"type":"string"},"style":"form"},{"description":"Filter by name","in":"query","name":"name","schema":{"type":"string"},"style":"form"},{"description":"Filter by type","in":"query","name":"type","schema":{"type":"string"},"style":"form"},{"description":"Filter by status","in":"query","name":"status","schema":{"type":"string"},"style":"form"},{"description":"Filter by date_created","in":"query","name":"date_created","schema":{"type":"string"},"style":"form"},{"description":"Filter by date_modified","in":"query","name":"date_modified","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilesElasticSchema"}}},"description":"Returns files"},"401":{"description":"Token is invalid"},"404":{"description":"No files found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get files in a storage folder, or all files on a storage"},"patch":{"description":"\nRequired roles:\n - can_write_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileBaseSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileBaseSchema"}}},"description":"Returns updated file"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Asset access denied"},"404":{"description":"No file found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update file by storage ID and path"},"post":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileBaseSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileBaseSchema"}}},"description":"Returns a file that was created"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create file without associating it to an asset"},"put":{"description":"\nRequired roles:\n - can_write_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileBaseSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileBaseSchema"}}},"description":"Returns updated file"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Asset access denied"},"404":{"description":"No file found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update file by storage ID and path"}},"/v1/storages/{storage_id}/files/reindex/":{"post":{"description":"\nRequired roles:\n - can_reindex_storages\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"201":{"description":"ID and status of the job"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Trigger reindexing of all files"}},"/v1/storages/{storage_id}/files/{file_id}/reindex/":{"post":{"description":"\nRequired roles:\n - can_reindex_storages\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"file_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"201":{"description":"ID and status of the job"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Trigger reindexing for a file on a storage"}},"/v1/storages/{storage_id}/gateway/events/":{"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"last_id","required":false,"schema":{"type":"string"},"style":"form"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconikStorageGatewayEventsSchema"}}},"description":"Returns a gateway storage events"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"No matching storage exists"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get pending storage gateway events"},"post":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconikStorageGatewayEventSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconikStorageGatewayEventSchema"}}},"description":"Returns a created gateway storage event"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"No matching storage exists"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create new storage gateway event"}},"/v1/storages/{storage_id}/gateway/events/purge/":{"post":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconikStorageGatewayEventsPurgeSchema"}}},"description":"body","required":true},"responses":{"204":{"description":"Success"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete storage gateway events in bulk"}},"/v1/storages/{storage_id}/gateway/events/{event_id}/":{"delete":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"event_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Success"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete storage gateway event"}},"/v1/storages/{storage_id}/gateway/report/":{"get":{"description":"","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayReportSchema"}}},"description":"Returns storage gateway report"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"No matching storage exists"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get storage gateway report"},"put":{"description":"\nRequired roles:\n - is_storage_worker\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayReportSchema"}}},"description":"body","required":true},"responses":{"200":{"description":"Returns empty dict"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"No matching storage exists"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create storage gateway report"}},"/v1/storages/{storage_id}/gateway/status/":{"put":{"description":"\nRequired roles:\n - is_storage_worker\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayStatusSchema"}}},"description":"body","required":true},"responses":{"200":{"description":"Returns empty dict"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"No matching storage exists"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update storage gateway status"}},"/v1/storages/{storage_id}/logs/":{"post":{"description":"\nRequired roles:\n - is_storage_worker\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"filename","required":true,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"path":{"type":"string"},"upload_url":{"type":"string"}}}}},"description":"Returns upload_url and path for storage logs"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Storage does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Upload storage logs"}},"/v1/storages/{storage_id}/private_data/":{},"/v1/storages/{storage_id}/reindex/":{"post":{"description":"\nRequired roles:\n - can_reindex_storages\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"201":{"description":"ID and status of the job"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Trigger reindexing of a storage"}},"/v1/storages/{storage_id}/scan/":{"post":{"description":"\nRequired roles:\n - can_scan_bucket\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageScanSchema"}}},"description":"body","required":true},"responses":{"201":{"description":"Scan started"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Requests to scan a storage"}},"/v1/storages/{storage_id}/search_document/":{"put":{"deprecated":true,"description":"\nRequired roles:\n - can_reindex_storages\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageSchema"}}},"description":"body","required":true},"responses":{"204":{"description":"Storage document updated"},"400":{"description":"No document supplied"},"401":{"description":"Token is invalid"},"404":{"description":"Storage does not exist in search index"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update search document for storage"}},"/v1/storages/{storage_id}/temporary_files/":{"get":{"description":"\nRequired roles:\n - can_read_storages\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":100,"type":"integer"},"style":"form"},{"description":"ID of a last file on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilesSchema"}}},"description":"Returns exported files"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Requested page does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get storage's exported files"}},"/v1/storages/{storage_id}/transcoders/":{"get":{"description":"\nRequired roles:\n - can_read_storages\n- can_read_transcoders\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"ID of a last transcoder on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscodersByStorageSchema"}}},"description":"Returns a list of transcoders"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all transcoders for a particular storage"}},"/v1/storages/{storage_id}/transcoders/{transcoder_id}/":{"delete":{"description":"\nRequired roles:\n - can_write_transcoders\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"transcoder_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Returns a created transcoder entry"},"401":{"description":"Token is invalid"},"404":{"description":"Storage or transcoder does not exists"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete a transcoder from storage"},"put":{"description":"\nRequired roles:\n - can_write_transcoders\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"transcoder_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscoderByStorageReadSchema"}}},"description":"Returns a created transcoder entry"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Storage or transcoder does not exists"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a new transcoder for storage"}},"/v1/storages/{storage_id}/transfers_from/":{"get":{"description":"\nRequired roles:\n - can_read_transfers\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"ID of a last transfer on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransfersFromStorageSchema"}}},"description":"Returns pending transfers to be handled"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get pending transfers of file sets from a local storage"}},"/v1/storages/{storage_id}/transfers_from/{transfer_id}/":{"delete":{"description":"\nRequired roles:\n - can_write_transfers\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"transfer_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"failed","required":false,"schema":{"type":"boolean"},"style":"form"},{"in":"query","name":"completed","required":false,"schema":{"type":"boolean"},"style":"form"}],"responses":{"204":{"description":"Transfer job was deleted"},"404":{"description":"Transfer job does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete file set transfer after handling it"},"get":{"description":"\nRequired roles:\n - can_read_transfers\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"transfer_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferFromStorageReadSchema"}}},"description":"Returns a file set transfer from local storage"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Transfer does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get file set transfer record"}},"/v1/storages/{storage_id}/transfers_to/":{"get":{"description":"\nRequired roles:\n - can_read_transfers\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"ID of a last transfer on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransfersToStorageSchema"}}},"description":"Returns pending transfers to be handled"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get pending transfers of file sets to a local storage"}},"/v1/storages/{storage_id}/transfers_to/{transfer_id}/":{"delete":{"description":"\nRequired roles:\n - can_write_transfers\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"transfer_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"failed","required":false,"schema":{"type":"boolean"},"style":"form"},{"in":"query","name":"completed","required":false,"schema":{"type":"boolean"},"style":"form"}],"responses":{"204":{"description":"Transfer job was deleted"},"404":{"description":"Transfer job does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete file set transfer after handling it"},"get":{"description":"\nRequired roles:\n - can_read_transfers\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"transfer_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferToStorageReadSchema"}}},"description":"Returns a file set transfer to local storage"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Transfer does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get file set transfer record"}},"/v1/storages/{storage_id}/verifications/access/":{"get":{"description":"\nRequired roles:\n - can_read_storages\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"access_check":{"example":false,"type":"boolean"},"error_message":{"example":"The AWS Access Key Id you provided does not exist in our records.","type":"string"}},"type":"object"}}},"description":"Returns a document describing storage access"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Storage does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Verify storage access"}},"/v1/storages/{storage_id}/verifications/permissions/":{"get":{"description":"\nRequired roles:\n - can_read_storages\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"example":{"cors":true,"delete_access":true,"read_access":true,"write_access":false,"write_access_error":"ERROR: no access"},"properties":{"cors":{"type":"boolean"},"cors_error":{"type":"string"},"delete_access":{"type":"boolean"},"delete_access_error":{"type":"string"},"error_message":{"type":"string"},"read_access":{"type":"boolean"},"read_access_error":{"type":"string"},"write_access":{"type":"boolean"},"write_access_error":{"type":"string"}}}}},"description":"Returns a document describing storage permissions"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Storage does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Verify storage permissions"}},"/v1/storages/{storage_id}/{object_type}/files/":{"delete":{"description":"\nRequired roles:\n - can_read_storages\n- can_delete_files\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"object_type","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageFilesDeleteBulkSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"Returns the updated objects"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"501":{"description":"Invalid object type"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete files from a particular storage from multiple objects"}},"/v1/transcoders/":{"get":{"description":"\nRequired roles:\n - can_read_transcoders\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"format":"int32","type":"integer"},"style":"form"},{"description":"Which page number to fetch","in":"query","name":"page","schema":{"default":1,"minimum":1,"type":"integer"},"style":"form"},{"description":"Search query","in":"query","name":"query","schema":{"type":"string"},"style":"form"},{"description":"Filter list of id:s (comma separated)","in":"query","name":"ids","schema":{"type":"string"},"style":"form"},{"description":"A comma separated list of fieldnames with order. For example - first_name,asc;last_name,desc","in":"query","name":"sort","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscodersSchema"}}},"description":"Returns a list of transcoders"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get all transcoders"},"post":{"description":"\nRequired roles:\n - can_write_transcoders\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscoderSchema"}}},"description":"body","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscoderSchema"}}},"description":"Returns a created transcoder entry"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Create a new transcoder"}},"/v1/transcoders/copy/":{},"/v1/transcoders/{transcoder_id}/":{"delete":{"description":"\nRequired roles:\n - can_delete_transcoders\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"transcoder_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"204":{"description":"Without body"},"401":{"description":"Token is invalid"},"404":{"description":"Transcoder doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Delete a particular transcoder by id"},"get":{"description":"\nRequired roles:\n - can_read_transcoders\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"transcoder_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscoderSchema"}}},"description":"Returns a transcoder"},"401":{"description":"Token is invalid"},"404":{"description":"Transcoder doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Returns a particular transcoder by id"},"patch":{"description":"\nRequired roles:\n - can_write_transcoders\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"transcoder_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscoderSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscoderSchema"}}},"description":"Returns an updated transcoder"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update transcoder"},"put":{"description":"\nRequired roles:\n - can_write_transcoders\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"transcoder_id","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscoderSchema"}}},"description":"body","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscoderSchema"}}},"description":"Returns an updated transcoder"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Update transcoder"}},"/v1/transcoders/{transcoder_id}/logs/":{"post":{"description":"\nRequired roles:\n - is_storage_worker\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"transcoder_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"filename","required":true,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"path":{"type":"string"},"upload_url":{"type":"string"}}}}},"description":"Returns upload_url and path for transcoder logs"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Storage does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Upload transcoder logs"}},"/v1/transcoders/{transcoder_id}/options/{option_name}/":{"get":{"description":"\nRequired roles:\n - can_read_transcoders\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"transcoder_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The name of the transcoder configuration option to retrieve options for.\nFor Transcoders of type 'WILDMOKA', supported option names include:\n- 'transcode_profiles'\n- 'templates'\n","in":"path","name":"option_name","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TranscoderOptionsSchema"}}},"description":"Returns a list of value options for the specified transcoder configuration option.\n"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get options for a transcoder configuration."}},"/v1/transcoders/{transcoder_id}/reindex/":{"post":{"description":"\nRequired roles:\n - can_reindex_transcoders\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"transcoder_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"201":{"description":"ID and status of the job"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Trigger reindexing of a transcoder"}},"/v1/transcoders/{transcoder_id}/storages/":{"get":{"description":"\nRequired roles:\n - can_read_transcoders\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"transcoder_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"The number of items for each page","in":"query","name":"per_page","schema":{"default":10,"type":"integer"},"style":"form"},{"description":"ID of a last storage on previous page","in":"query","name":"last_id","schema":{"type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoragesReadSchema"}}},"description":"Returns a list of storages"},"401":{"description":"Token is invalid"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Get storages linked to a transcoder"}},"/v1/transfers/{transfer_id}/urls/":{"post":{"description":"","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"transfer_id","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferSignedURLSchema"}}},"description":"Generated signed url"},"400":{"description":"Failed to generate url"},"403":{"description":"User not authorized to get url for job"},"404":{"description":"Transfer job does not exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Generates a url for direct file downloads (for IGSs)"}},"/v1/transfers/{transfer_id}/urls/verify/":{"get":{"description":"","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"transfer_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"query","name":"user_id","required":true,"schema":{"type":"string"},"style":"form"},{"in":"query","name":"signature","required":true,"schema":{"type":"string"},"style":"form"}],"responses":{"200":{"description":"Verified signed url"},"400":{"description":"Not a valid signed url"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Verifies the signature of a url"}},"/v2/assets/bulk/archive/":{"post":{"description":"\nRequired roles:\n - can_archive_formats\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Enable transfer through iconik host (creates egress)","in":"query","name":"allow_host_transfer","schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkArchiveAssetRequestSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"Archive jobs created"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Permission on storage denied"},"404":{"description":"Asset or storage not found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Archive multiple assets to a storage."}},"/v2/assets/bulk/restore/":{"post":{"description":"\nRequired roles:\n - can_restore_archived_formats\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Enable transfer through iconik host (creates egress)","in":"query","name":"allow_host_transfer","schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkRestoreAssetRequestSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"Transfer jobs created"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Permission on storage denied"},"404":{"description":"Format or storage not found"},"409":{"description":"Format already exists on storage."},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Restore multiple objects."}},"/v2/assets/export_locations/{export_location_id}/bulk/export/":{"post":{"description":"\nRequired roles:\n - can_write_exports\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"export_location_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Enable transfer through iconik host (creates egress)","in":"query","name":"allow_host_transfer","schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkExportAssetRequestSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"Transfer jobs created"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Permission on storage denied"},"404":{"description":"Format or storage not found"},"409":{"description":"Format already exists on storage."},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Export multiple assets."}},"/v2/assets/storages/{storage_id}/bulk/transfer/":{"post":{"description":"\nRequired roles:\n - can_write_transfers\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Destination storage_id","in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Enable transfer through iconik host (creates egress)","in":"query","name":"allow_host_transfer","schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkTransferAssetRequestSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"Transfer jobs created"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Permission on storage denied"},"404":{"description":"Format or storage not found"},"409":{"description":"Format already exists on storage."},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Transfer multiple objects."}},"/v2/assets/{asset_id}/formats/{format_id}/archive/":{"post":{"description":"\nRequired roles:\n - can_archive_formats\n","parameters":[{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"format_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Enable transfer through iconik host (creates egress)","in":"query","name":"allow_host_transfer","schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArchiveAssetFormatSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"No body"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"404":{"description":"Format for this asset doesn't exist"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Archive format"}},"/v2/assets/{asset_id}/formats/{format_id}/storages/{storage_id}/":{"post":{"description":"\nRequired roles:\n - can_write_transfers\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"asset_id","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"format_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Destination storage_id","in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Enable transfer through iconik host (creates egress)","in":"query","name":"allow_host_transfer","schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferFormatToStorageSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"Copy job created"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Permission on storage denied"},"404":{"description":"Format or storage not found"},"409":{"description":"Format already exists on storage."},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Transfer formats file sets to another storage."}},"/v2/collections/bulk/archive/":{"post":{"description":"\nRequired roles:\n - can_archive_formats\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Enable transfer through iconik host (creates egress)","in":"query","name":"allow_host_transfer","schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkArchiveCollectionRequestSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"Archive jobs created"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Permission on storage denied"},"404":{"description":"Asset or storage not found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Archive multiple assets to a storage."}},"/v2/collections/bulk/restore/":{"post":{"description":"\nRequired roles:\n - can_restore_archived_formats\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Enable transfer through iconik host (creates egress)","in":"query","name":"allow_host_transfer","schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkRestoreCollectionRequestSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"Restore jobs created"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Permission on storage denied"},"404":{"description":"Asset or storage not found"},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Restore multiple collections to a storage."}},"/v2/collections/export_locations/{export_location_id}/bulk/export/":{"post":{"description":"\nRequired roles:\n - can_write_exports\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"export_location_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Enable transfer through iconik host (creates egress)","in":"query","name":"allow_host_transfer","schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkExportCollectionRequestSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"Transfer jobs created"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Permission on storage denied"},"404":{"description":"Format or storage not found"},"409":{"description":"Format already exists on storage."},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Export multiple collections."}},"/v2/collections/storages/{storage_id}/bulk/transfer/":{"post":{"description":"\nRequired roles:\n - can_write_transfers\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Destination storage_id","in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Enable transfer through iconik host (creates egress)","in":"query","name":"allow_host_transfer","schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkTransferCollectionRequestSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"Transfer jobs created"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Permission on storage denied"},"404":{"description":"Format or storage not found"},"409":{"description":"Format already exists on storage."},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Transfer multiple objects."}},"/v2/saved_searches/bulk/archive/":{"post":{"description":"\nRequired roles:\n - can_archive_formats\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Enable transfer through iconik host (creates egress)","in":"query","name":"allow_host_transfer","schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkArchiveSavedSearchRequestSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"Transfer jobs created"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Permission on storage denied"},"404":{"description":"Format or storage not found"},"409":{"description":"Format already exists on storage."},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Transfer multiple objects."}},"/v2/saved_searches/bulk/restore/":{"post":{"description":"\nRequired roles:\n - can_restore_archived_formats\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Enable transfer through iconik host (creates egress)","in":"query","name":"allow_host_transfer","schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkRestoreSavedSearchRequestSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"Transfer jobs created"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Permission on storage denied"},"404":{"description":"Format or storage not found"},"409":{"description":"Format already exists on storage."},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Restore multiple saved searches."}},"/v2/saved_searches/export_locations/{export_location_id}/bulk/export/":{"post":{"description":"\nRequired roles:\n - can_write_exports\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"path","name":"export_location_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Enable transfer through iconik host (creates egress)","in":"query","name":"allow_host_transfer","schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkExportSavedSearchRequestSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"Transfer jobs created"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Permission on storage denied"},"404":{"description":"Format or storage not found"},"409":{"description":"Format already exists on storage."},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Export multiple saved searches."}},"/v2/saved_searches/storages/{storage_id}/bulk/transfer/":{"post":{"description":"\nRequired roles:\n - can_write_transfers\n","parameters":[{"in":"header","name":"Auth-Token","required":true,"schema":{"type":"string"},"style":"simple"},{"in":"header","name":"App-ID","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Destination storage_id","in":"path","name":"storage_id","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Enable transfer through iconik host (creates egress)","in":"query","name":"allow_host_transfer","schema":{"type":"boolean"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkTransferSavedSearchRequestSchema"}}},"description":"body","required":true},"responses":{"202":{"description":"Transfer jobs created"},"400":{"description":"Bad request"},"401":{"description":"Token is invalid"},"403":{"description":"Permission on storage denied"},"404":{"description":"Format or storage not found"},"409":{"description":"Format already exists on storage."},"default":{"content":{"application/json":{"examples":{"multiple":{"summary":"Example multiple messages.","value":{"errors":{"field1":"Error message for field1","field2":"Error message for field2"}}},"single":{"summary":"Example single message.","value":{"errors":["Example error message."]}}},"schema":{"oneOf":[{"properties":{"errors":{"items":{"type":"string"},"type":"array"}},"type":"object"},{"properties":{"errors":{"type":"object"}},"type":"object"}]}}},"description":"Error response"}},"summary":"Transfer multiple objects."}}},"servers":[{"url":"/API/files/"}]}