Logo

View the Project on GitHub elements-storage/elements-sdk-python

ELEMENTS Python SDK

Installation & Usage

pip install elements-sdk

Then import the package:

import elements_sdk

Example

from elements_sdk import ApiClient, Configuration, StorageApi, Share, Volume

config = Configuration(
    host='http://elements.local',
    api_key={'Authorization': 'Bearer your-api-token'},
)
config.debug = True

with ApiClient(config) as api_client:
    storage_api = StorageApi(api_client)

    volume: Volume = storage_api.get_all_volumes()[0]
    share: Share = storage_api.create_share(dict(
        name='test',
        volume=volume,
        path='foo/bar'
    ))
    print(share)
    storage_api.delete_share(share.id)

API Endpoints

Class Method HTTP request Description
AIApi abort_ai_dataset_model_creation POST /api/2/ai/models/{id}/abort  
AIApi create_ai_annotation_track POST /api/2/ai/annotations/tracks/create  
AIApi create_ai_category POST /api/2/ai/categories  
AIApi create_ai_dataset POST /api/2/ai/datasets  
AIApi create_ai_dataset_model POST /api/2/ai/models/create  
AIApi create_ai_metadata POST /api/2/ai/metadata/create  
AIApi create_ai_model POST /api/2/ai/models  
AIApi delete_ai_annotation DELETE /api/2/ai/annotations/{id}  
AIApi delete_ai_annotation_track DELETE /api/2/ai/annotations/tracks/{id}  
AIApi delete_ai_category DELETE /api/2/ai/categories/{id}  
AIApi delete_ai_dataset DELETE /api/2/ai/datasets/{id}  
AIApi delete_ai_model DELETE /api/2/ai/models/{id}  
AIApi get_ai_annotation GET /api/2/ai/annotations/{id}  
AIApi get_ai_annotation_image GET /api/2/ai/annotations/{id}/image  
AIApi get_ai_category GET /api/2/ai/categories/{id}  
AIApi get_ai_connection GET /api/2/ai/connections/{id}  
AIApi get_ai_dataset GET /api/2/ai/datasets/{id}  
AIApi get_ai_dataset_model_stats GET /api/2/ai/models/{id}/stats  
AIApi get_ai_image GET /api/2/ai/images/{id}  
AIApi get_ai_image_content GET /api/2/ai/images/{id}/content  
AIApi get_ai_metadata GET /api/2/ai/metadata/{id}  
AIApi get_ai_model GET /api/2/ai/models/{id}  
AIApi get_all_ai_annotation_tracks GET /api/2/ai/annotations/tracks  
AIApi get_all_ai_annotations GET /api/2/ai/annotations  
AIApi get_all_ai_categories GET /api/2/ai/categories  
AIApi get_all_ai_connections GET /api/2/ai/connections  
AIApi get_all_ai_datasets GET /api/2/ai/datasets  
AIApi get_all_ai_images GET /api/2/ai/images  
AIApi get_all_ai_metadata GET /api/2/ai/metadata  
AIApi get_all_ai_models GET /api/2/ai/models  
AIApi patch_ai_category PATCH /api/2/ai/categories/{id}  
AIApi patch_ai_dataset PATCH /api/2/ai/datasets/{id}  
AIApi patch_ai_model PATCH /api/2/ai/models/{id}  
AIApi update_ai_category PUT /api/2/ai/categories/{id}  
AIApi update_ai_dataset PUT /api/2/ai/datasets/{id}  
AIApi update_ai_model PUT /api/2/ai/models/{id}  
AuthApi check_auth_ticket POST /api/2/auth/ticket/check  
AuthApi create_auth_ticket POST /api/2/auth/ticket  
AuthApi delete_one_time_access_token DELETE /api/2/auth/access-tokens/{id}  
AuthApi generate_password POST /api/2/auth/generate-password  
AuthApi get_all_one_time_access_tokens GET /api/2/auth/access-tokens  
AuthApi get_one_time_access_token GET /api/2/auth/access-tokens/{id}  
AuthApi login POST /api/2/auth/login  
AuthApi logout POST /api/2/auth/logout  
AutomationApi abort_task POST /api/2/tasks/{id}/abort  
AutomationApi create_job POST /api/2/jobs  
AutomationApi create_schedule POST /api/2/schedules  
AutomationApi create_subtask POST /api/2/subtasks  
AutomationApi delete_job DELETE /api/2/jobs/{id}  
AutomationApi delete_schedule DELETE /api/2/schedules/{id}  
AutomationApi delete_subtask DELETE /api/2/subtasks/{id}  
AutomationApi delete_task DELETE /api/2/tasks/{id}  
AutomationApi download_all_task_logs GET /api/2/tasks/logs/download  
AutomationApi download_task_log GET /api/2/tasks/{id}/log/download  
AutomationApi get_all_jobs GET /api/2/jobs  
AutomationApi get_all_schedules GET /api/2/schedules  
AutomationApi get_all_subtasks GET /api/2/subtasks  
AutomationApi get_all_tasks GET /api/2/tasks  
AutomationApi get_finished_tasks GET /api/2/tasks/finished  
AutomationApi get_job GET /api/2/jobs/{id}  
AutomationApi get_pending_tasks GET /api/2/tasks/pending  
AutomationApi get_schedule GET /api/2/schedules/{id}  
AutomationApi get_subtask GET /api/2/subtasks/{id}  
AutomationApi get_task GET /api/2/tasks/{id}  
AutomationApi get_task_log GET /api/2/tasks/{id}/log  
AutomationApi get_tasks_summary GET /api/2/tasks/summary  
AutomationApi kill_all_pending_tasks DELETE /api/2/tasks/pending  
AutomationApi kill_task POST /api/2/tasks/{id}/kill  
AutomationApi patch_job PATCH /api/2/jobs/{id}  
AutomationApi patch_schedule PATCH /api/2/schedules/{id}  
AutomationApi patch_subtask PATCH /api/2/subtasks/{id}  
AutomationApi restart_task POST /api/2/tasks/{id}/restart  
AutomationApi start_job POST /api/2/jobs/{id}/start  
AutomationApi start_task POST /api/2/tasks/start  
AutomationApi update_job PUT /api/2/jobs/{id}  
AutomationApi update_schedule PUT /api/2/schedules/{id}  
AutomationApi update_subtask PUT /api/2/subtasks/{id}  
MainApi apply_configuration POST /api/2/configuration/apply  
MainApi check_chunk_uploaded GET /api/2/uploads/chunk  
MainApi check_stor_next_license POST /api/2/stornext-license/check  
MainApi create_group POST /api/2/groups  
MainApi create_home_workspace POST /api/2/users/{id}/home  
MainApi create_user POST /api/2/users  
MainApi create_workstation POST /api/2/workstations  
MainApi delete_group DELETE /api/2/groups/{id}  
MainApi delete_home_workspace DELETE /api/2/users/{id}/home  
MainApi delete_user DELETE /api/2/users/{id}  
MainApi delete_workstation DELETE /api/2/workstations/{id}  
MainApi disable_user_totp DELETE /api/2/users/{id}/totp  
MainApi enable_user_totp POST /api/2/users/{id}/totp  
MainApi finish_upload POST /api/2/uploads/finish  
MainApi fix_ldap_group_memberships POST /api/2/ldap-servers/{id}/fix-memberships  
MainApi get_all_downloads GET /api/2/downloads  
MainApi get_all_groups GET /api/2/groups  
MainApi get_all_ldap_servers GET /api/2/ldap-servers  
MainApi get_all_storage_nodes GET /api/2/nodes  
MainApi get_all_users GET /api/2/users  
MainApi get_all_workstations GET /api/2/workstations  
MainApi get_client_download_file GET /api/2/downloads/clients/{file}  
MainApi get_client_downloads GET /api/2/downloads/clients  
MainApi get_current_workstation GET /api/2/workstations/current  
MainApi get_download GET /api/2/downloads/{id}  
MainApi get_download_file GET /api/2/downloads/{id}/download  
MainApi get_download_icon GET /api/2/downloads/{id}/icon  
MainApi get_group GET /api/2/groups/{id}  
MainApi get_home_workspace GET /api/2/users/{id}/home  
MainApi get_ldap_server GET /api/2/ldap-servers/{id}  
MainApi get_ldap_server_groups GET /api/2/ldap-servers/{id}/groups  
MainApi get_ldap_server_users GET /api/2/ldap-servers/{id}/users  
MainApi get_license GET /api/2/license  
MainApi get_node_ipmi_sensors GET /api/2/nodes/{id}/sensors  
MainApi get_node_stats GET /api/2/nodes/{id}/stats  
MainApi get_parameters GET /api/2/parameters  
MainApi get_profile GET /api/2/users/me  
MainApi get_release_notes GET /api/2/release-notes  
MainApi get_stor_next_license GET /api/2/stornext-license  
MainApi get_storage_node GET /api/2/nodes/{id}  
MainApi get_system_info GET /api/2/system/info  
MainApi get_user GET /api/2/users/{id}  
MainApi get_workstation GET /api/2/workstations/{id}  
MainApi install_stor_next_license POST /api/2/stornext-license  
MainApi patch_current_workstation PATCH /api/2/workstations/current  
MainApi patch_group PATCH /api/2/groups/{id}  
MainApi patch_user PATCH /api/2/users/{id}  
MainApi patch_workstation PATCH /api/2/workstations/{id}  
MainApi preview_user POST /api/2/users/preview  
MainApi register_upload POST /api/2/uploads/register  
MainApi reset_user_password POST /api/2/users/{id}/password/reset  
MainApi set_my_password POST /api/2/users/me/password  
MainApi set_user_password POST /api/2/users/{id}/password  
MainApi sync_ldap_group POST /api/2/groups/{id}/ldap-sync  
MainApi sync_ldap_users POST /api/2/ldap-servers/{id}/sync-users  
MainApi sync_user_totp PUT /api/2/users/{id}/totp  
MainApi update_current_workstation PUT /api/2/workstations/current  
MainApi update_group PUT /api/2/groups/{id}  
MainApi update_parameters PUT /api/2/parameters  
MainApi update_profile PUT /api/2/users/me  
MainApi update_user PUT /api/2/users/{id}  
MainApi update_workstation PUT /api/2/workstations/{id}  
MainApi upload_chunk POST /api/2/uploads/chunk  
MediaLibraryApi clear_subclip_clipboard DELETE /api/2/media/subclips/clipboard/clear  
MediaLibraryApi combine_assets_into_set POST /api/2/media/assets/combine  
MediaLibraryApi create_asset POST /api/2/media/assets  
MediaLibraryApi create_asset_rating POST /api/2/media/ratings  
MediaLibraryApi create_comment POST /api/2/media/comments  
MediaLibraryApi create_custom_field POST /api/2/media/custom-fields  
MediaLibraryApi create_marker POST /api/2/media/markers  
MediaLibraryApi create_media_file_template POST /api/2/media/files/templates  
MediaLibraryApi create_media_root POST /api/2/media/roots  
MediaLibraryApi create_media_root_permission POST /api/2/media/root-permissions  
MediaLibraryApi create_media_tag POST /api/2/media/tags  
MediaLibraryApi create_proxy_profile POST /api/2/media/proxy-profiles  
MediaLibraryApi create_subclip POST /api/2/media/subclips  
MediaLibraryApi create_subclip_clipboard_entry POST /api/2/media/subclips/clipboard  
MediaLibraryApi delete_asset DELETE /api/2/media/assets/{id}  
MediaLibraryApi delete_asset_rating DELETE /api/2/media/ratings/{id}  
MediaLibraryApi delete_comment DELETE /api/2/media/comments/{id}  
MediaLibraryApi delete_custom_field DELETE /api/2/media/custom-fields/{id}  
MediaLibraryApi delete_marker DELETE /api/2/media/markers/{id}  
MediaLibraryApi delete_media_file_template DELETE /api/2/media/files/templates/{id}  
MediaLibraryApi delete_media_root DELETE /api/2/media/roots/{id}  
MediaLibraryApi delete_media_root_permission DELETE /api/2/media/root-permissions/{id}  
MediaLibraryApi delete_media_tag DELETE /api/2/media/tags/{id}  
MediaLibraryApi delete_media_update DELETE /api/2/media/updates/{id}  
MediaLibraryApi delete_proxy DELETE /api/2/media/proxies/{id}  
MediaLibraryApi delete_proxy_profile DELETE /api/2/media/proxy-profiles/{id}  
MediaLibraryApi delete_subclip DELETE /api/2/media/subclips/{id}  
MediaLibraryApi delete_subclip_clipboard_entry DELETE /api/2/media/subclips/clipboard/{id}  
MediaLibraryApi discover_media POST /api/2/scanner/discover  
MediaLibraryApi get_all_asset_project_links GET /api/2/media/assets/project-links  
MediaLibraryApi get_all_asset_ratings GET /api/2/media/ratings  
MediaLibraryApi get_all_asset_tape_backups GET /api/2/media/backups  
MediaLibraryApi get_all_assets GET /api/2/media/assets  
MediaLibraryApi get_all_bundles_for_media_root GET /api/2/media/bundles/flat/{root}  
MediaLibraryApi get_all_click_links GET /api/2/media/assets/click-links  
MediaLibraryApi get_all_comments GET /api/2/media/comments  
MediaLibraryApi get_all_custom_fields GET /api/2/media/custom-fields  
MediaLibraryApi get_all_markers GET /api/2/media/markers  
MediaLibraryApi get_all_media_file_bundles GET /api/2/media/bundles  
MediaLibraryApi get_all_media_file_templates GET /api/2/media/files/templates  
MediaLibraryApi get_all_media_files GET /api/2/media/files  
MediaLibraryApi get_all_media_files_for_bundles POST /api/2/media/files/for-bundles  
MediaLibraryApi get_all_media_files_for_media_root GET /api/2/media/files/flat/{root}  
MediaLibraryApi get_all_media_root_permissions GET /api/2/media/root-permissions  
MediaLibraryApi get_all_media_roots GET /api/2/media/roots  
MediaLibraryApi get_all_media_tags GET /api/2/media/tags  
MediaLibraryApi get_all_media_updates GET /api/2/media/updates  
MediaLibraryApi get_all_proxies GET /api/2/media/proxies  
MediaLibraryApi get_all_proxy_profiles GET /api/2/media/proxy-profiles  
MediaLibraryApi get_all_subclip_clipboard_entries GET /api/2/media/subclips/clipboard  
MediaLibraryApi get_all_subclips GET /api/2/media/subclips  
MediaLibraryApi get_all_transcoder_profiles GET /api/2/transcoder-profiles  
MediaLibraryApi get_asset GET /api/2/media/assets/{id}  
MediaLibraryApi get_asset_rating GET /api/2/media/ratings/{id}  
MediaLibraryApi get_comment GET /api/2/media/comments/{id}  
MediaLibraryApi get_custom_field GET /api/2/media/custom-fields/{id}  
MediaLibraryApi get_latest_media_update GET /api/2/media/updates/latest  
MediaLibraryApi get_marker GET /api/2/media/markers/{id}  
MediaLibraryApi get_media_file GET /api/2/media/files/{id}  
MediaLibraryApi get_media_file_bundle GET /api/2/media/bundles/{id}  
MediaLibraryApi get_media_file_contents GET /api/2/media/files/{id}/contents  
MediaLibraryApi get_media_file_template GET /api/2/media/files/templates/{id}  
MediaLibraryApi get_media_root GET /api/2/media/roots/{id}  
MediaLibraryApi get_media_root_permission GET /api/2/media/root-permissions/{id}  
MediaLibraryApi get_media_tag GET /api/2/media/tags/{id}  
MediaLibraryApi get_multiple_assets POST /api/2/media/assets/multiple  
MediaLibraryApi get_multiple_bundles POST /api/2/media/bundles/multiple  
MediaLibraryApi get_multiple_files POST /api/2/media/files/multiple  
MediaLibraryApi get_my_media_root_permissions GET /api/2/media/root-permissions/mine  
MediaLibraryApi get_my_resolved_media_root_permissions GET /api/2/media/root-permissions/mine/resolved  
MediaLibraryApi get_proxy GET /api/2/media/proxies/{id}  
MediaLibraryApi get_proxy_profile GET /api/2/media/proxy-profiles/{id}  
MediaLibraryApi get_proxy_profile_proxy_count GET /api/2/media/proxy-profiles/{id}/proxy-count  
MediaLibraryApi get_subclip GET /api/2/media/subclips/{id}  
MediaLibraryApi get_transcoder_profile GET /api/2/transcoder-profiles/{id}  
MediaLibraryApi patch_asset PATCH /api/2/media/assets/{id}  
MediaLibraryApi patch_asset_rating PATCH /api/2/media/ratings/{id}  
MediaLibraryApi patch_comment PATCH /api/2/media/comments/{id}  
MediaLibraryApi patch_custom_field PATCH /api/2/media/custom-fields/{id}  
MediaLibraryApi patch_marker PATCH /api/2/media/markers/{id}  
MediaLibraryApi patch_media_file PATCH /api/2/media/files/{id}  
MediaLibraryApi patch_media_file_template PATCH /api/2/media/files/templates/{id}  
MediaLibraryApi patch_media_root PATCH /api/2/media/roots/{id}  
MediaLibraryApi patch_media_root_permission PATCH /api/2/media/root-permissions/{id}  
MediaLibraryApi patch_media_tag PATCH /api/2/media/tags/{id}  
MediaLibraryApi patch_proxy_profile PATCH /api/2/media/proxy-profiles/{id}  
MediaLibraryApi patch_subclip PATCH /api/2/media/subclips/{id}  
MediaLibraryApi request_media_scan POST /api/2/scanner/scan  
MediaLibraryApi resolve_comment POST /api/2/media/comments/{id}/resolve  
MediaLibraryApi unresolve_comment POST /api/2/media/comments/{id}/unresolve  
MediaLibraryApi update_asset PUT /api/2/media/assets/{id}  
MediaLibraryApi update_asset_rating PUT /api/2/media/ratings/{id}  
MediaLibraryApi update_comment PUT /api/2/media/comments/{id}  
MediaLibraryApi update_custom_field PUT /api/2/media/custom-fields/{id}  
MediaLibraryApi update_marker PUT /api/2/media/markers/{id}  
MediaLibraryApi update_media_file PUT /api/2/media/files/{id}  
MediaLibraryApi update_media_file_template PUT /api/2/media/files/templates/{id}  
MediaLibraryApi update_media_root PUT /api/2/media/roots/{id}  
MediaLibraryApi update_media_root_permission PUT /api/2/media/root-permissions/{id}  
MediaLibraryApi update_media_tag PUT /api/2/media/tags/{id}  
MediaLibraryApi update_proxy_profile PUT /api/2/media/proxy-profiles/{id}  
MediaLibraryApi update_subclip PUT /api/2/media/subclips/{id}  
StatusApi get_alert GET /api/2/alerts/{id}  
StatusApi get_all_alerts GET /api/2/alerts  
StatusApi patch_alert PATCH /api/2/alerts/{id}  
StatusApi update_alert PUT /api/2/alerts/{id}  
StorageApi apply_workspace_affinity POST /api/2/workspaces/{id}/apply-affinity  
StorageApi bookmark_workspace POST /api/2/workspaces/{id}/bookmark  
StorageApi check_in_into_workspace POST /api/2/workspaces/{id}/check-in  
StorageApi check_out_of_workspace POST /api/2/workspaces/{id}/check-out  
StorageApi create_production POST /api/2/productions  
StorageApi create_share POST /api/2/shares  
StorageApi create_snapshot POST /api/2/snapshots  
StorageApi create_workspace POST /api/2/workspaces  
StorageApi create_workspace_permission POST /api/2/workspace-permissions  
StorageApi delete_production DELETE /api/2/productions/{id}  
StorageApi delete_share DELETE /api/2/shares/{id}  
StorageApi delete_snapshot DELETE /api/2/snapshots/{id}  
StorageApi delete_workspace DELETE /api/2/workspaces/{id}  
StorageApi delete_workspace_permission DELETE /api/2/workspace-permissions/{id}  
StorageApi get_all_deleted_workspaces GET /api/2/workspaces/deleted  
StorageApi get_all_productions GET /api/2/productions  
StorageApi get_all_shares GET /api/2/shares  
StorageApi get_all_snapshots GET /api/2/snapshots  
StorageApi get_all_volumes GET /api/2/volumes  
StorageApi get_all_workspace_permissions GET /api/2/workspace-permissions  
StorageApi get_all_workspaces GET /api/2/workspaces  
StorageApi get_my_workspaces GET /api/2/workspaces/mine  
StorageApi get_production GET /api/2/productions/{id}  
StorageApi get_share GET /api/2/shares/{id}  
StorageApi get_snapshot GET /api/2/snapshots/{id}  
StorageApi get_volume GET /api/2/volumes/{id}  
StorageApi get_volume_active_connections GET /api/2/volumes/{id}/connections  
StorageApi get_volume_file_size_distribution GET /api/2/volumes/{id}/file-size-distribution  
StorageApi get_volume_stats GET /api/2/volumes/{id}/stats  
StorageApi get_workspace GET /api/2/workspaces/{id}  
StorageApi get_workspace_permission GET /api/2/workspace-permissions/{id}  
StorageApi move_workspace_to_production POST /api/2/workspaces/{id}/move-to  
StorageApi patch_production PATCH /api/2/productions/{id}  
StorageApi patch_share PATCH /api/2/shares/{id}  
StorageApi patch_snapshot PATCH /api/2/snapshots/{id}  
StorageApi patch_volume PATCH /api/2/volumes/{id}  
StorageApi patch_workspace PATCH /api/2/workspaces/{id}  
StorageApi patch_workspace_permission PATCH /api/2/workspace-permissions/{id}  
StorageApi repair_workspace_permissions POST /api/2/workspaces/{id}/repair-permissions  
StorageApi unbookmark_workspace DELETE /api/2/workspaces/{id}/bookmark  
StorageApi update_production PUT /api/2/productions/{id}  
StorageApi update_share PUT /api/2/shares/{id}  
StorageApi update_snapshot PUT /api/2/snapshots/{id}  
StorageApi update_volume PUT /api/2/volumes/{id}  
StorageApi update_workspace PUT /api/2/workspaces/{id}  
StorageApi update_workspace_permission PUT /api/2/workspace-permissions/{id}  
TapeArchiveApi create_tape POST /api/2/archive/tape/tapes  
TapeArchiveApi create_tape_group POST /api/2/archive/tape/groups  
TapeArchiveApi delete_tape DELETE /api/2/archive/tape/tapes/{id}  
TapeArchiveApi delete_tape_group DELETE /api/2/archive/tape/groups/{id}  
TapeArchiveApi get_all_archived_file_entries GET /api/2/archive/tape/files  
TapeArchiveApi get_all_tape_groups GET /api/2/archive/tape/groups  
TapeArchiveApi get_all_tapes GET /api/2/archive/tape/tapes  
TapeArchiveApi get_archived_file_entry GET /api/2/archive/tape/files/{id}  
TapeArchiveApi get_tape GET /api/2/archive/tape/tapes/{id}  
TapeArchiveApi get_tape_group GET /api/2/archive/tape/groups/{id}  
TapeArchiveApi patch_tape PATCH /api/2/archive/tape/tapes/{id}  
TapeArchiveApi patch_tape_group PATCH /api/2/archive/tape/groups/{id}  
TapeArchiveApi update_tape PUT /api/2/archive/tape/tapes/{id}  
TapeArchiveApi update_tape_group PUT /api/2/archive/tape/groups/{id}  

Models