v24.10.0

Changes

Multiple properties that were previously incorrectly nullable are now correctly required.

New endpoints

• /api/2/alerts/{id}/acknowledge
• /api/2/alerts/{id}/silence
• /api/2/alerts/active
• /api/2/jobs/{id}/variables/{name}/options
• /api/2/jobs/fs-triggers/{id}
• /api/2/jobs/fs-triggers
• /api/2/ldap-servers/{id}
• /api/2/ldap-servers/probe
• /api/2/ldap-servers
• /api/2/license/components
• /api/2/media/assets/{asset_id}/proxies/{id}/progress
• /api/2/media/custom-fields/{id}/options
• /api/2/media/workflows/{id}
• /api/2/media/workflows
• /api/2/nodes/{id}/time
• /api/2/nodes/current
• /api/2/private/elements-agent-auth
• /api/2/private/qumulo-integrations/{id}
• /api/2/private/qumulo-integrations
• /api/2/system/certificate/csr
• /api/2/system/certificate (PATCH)
• /api/2/system/smtp (DELETE)

Added query parameters

• /api/2/media/assets (get) - Optional param include_full_info added
• /api/2/media/assets/multiple (post) - Optional param include_full_info added
• /api/2/media/assets/{id} (get) - Optional param include_full_info added

Added properties

• Alert.silenced_by
• BackendProperties.supports_sharing_smb_hidden
• BackendProperties.supports_sharing_smb_locking_options
• CustomField.users_from_group
• FormatMetadata.acodec_long
• FormatMetadata.acodec
• FormatMetadata.bpp
• FormatMetadata.metadata
• FormatMetadata.pages
• FormatMetadata.sample_rate
• FormatMetadata.streams
• FormatMetadata.subtitles
• FormatMetadata.system_timecode
• FormatMetadata.timecode
• FormatMetadata.type
• FormatMetadata.vcodec_long
• FormatMetadata.vcodec
• Job.fs_triggers
• Job.workflow
• JobDetail.fs_triggers
• JobDetail.workflow
• License.product_subtype
• MediaRoot.disable_framestacks
• MediaRootDetail.disable_framestacks
• Parameters.ntp_enable
• StorageNode.apply_configuration_queue
• Volume.qumulo_integration

Removed endpoints

• deleteAlert
• patchAlert
• getLocalTime
• updateLocalTime

Removed properties

• AssetMini.info
• Job.allow_groups
• Job.allow_users
• Job.media_roots
• Job.subtasks
• MediaFile.bookmarked_by
• MediaRootDetail.workflow_jobs

v24.7.0

Added fields

• Asset.set_stack_order
• Asset.set_stack
• Asset.version_stack
• AssetPartialUpdate.set_stack_order
• AssetUpdate.set_stack_order
• ElementsGroup.ldap_guid
• ElementsUser.ldap_guid
• Event.new_since_version
• LDAPServerGroup.guid
• LDAPServerUser.guid
• Parameters.media_detect_versions
• SAMLProvider.auto_create_users
• SAMLProvider.user_template

Removed fields

• Asset.set

New endpoints

• /api/2/archive/tape/jobs/{id}/log-stream
• /api/2/media/assets/{id}/set
• /api/2/media/assets/{id}/versions
• /api/2/media/bundles/{id}/files
• /api/2/media/stacks/combine-into-set
• /api/2/media/stacks/link-versions
• /api/2/media/stacks/{id}/members
• /api/2/media/web/upload-completed

Removed endpoints

• /api/2/media/assets/combine

v24.4.0

New fields

• BackendProperties.supports_sharing_smb_allow_execute
• MediaFile.exclusion_info
• MediaFileBundle.exclusion_info
• MediaFileReference.exclusion_info
• Parameters.password_login
• ParametersUpdate.password_login
• ProxyProfileMini.proxy_generator
• SystemInfoEndpointResponse.has_password_policy
• SystemInfoEndpointResponse.password_login
• TaskInfo.related_bundle_id
• TaskInfo.related_proxy_id

New objects

• MediaFileBundleExclusionInfo
• MediaFileExclusionInfo
• PasswordPolicy
• PasswordPolicyRule
• PathExclusionInfo
• ProductionMini
• WorkspaceMini

New endpoints

• /api/2/archive/tape/jobs/{id}/log
• /api/2/auth/evaluate-password
• /api/2/media/files/{id}/dont-proxy
• /api/2/media/files/{id}/dont-scan
• /api/2/nodes/{id}/raid/silence-alarm
• /api/2/nodes/{id}/raid/status
• /api/2/system/password-policy

Removed objects

• RecursiveField
• LizardFSNode
• LizardFSDisk
• VolumeLizardFSStatus

v24.1.0

Changes

• getAllJobs won't return subtasks/allow_groups/allow_users/media_roots anymore. These fields are still available via getJob.

Removed fields

• Parameters.workspaces_folder_template_path

Removed operations

• getLatestMediaUpdate
• createTemplateFolder

v23.10.0

Changes

• StorageNode API now offers more fields and is writable

New objects

• /api/2/notifications - Notification
• /api/2/notification-receipts - NotificationReceipt

New endpoints

• /api/2/archive/tape/jobs/{}/cancel

New fields

• GET /api/2/system/info - offers_iperf_benchmarking
• TaskType.required_permissions

v23.7.0

New fields

• TaskInfo.is_finished
• TaskInfo.is_running
• TaskInfo.outputs

New request parameters

• POST /api/2/media/assets/multiple

  • include_proxies
  • include_modified_by
  • resolve_asset_permission
  • for_root

• GET /api/2/media/bundles/flat/subtree/{}

  • exclude_deleted
  • exclude_unrecognized
  • include_proxies
  • include_parents
  • include_modified_by
  • advanced_search
  • in_media_root

• GET /api/2/media/files/{}/contents

  • include_modified_by

v23.5.0

New objects

• /api/2/media/sharing-permission-presets
• /api/2/notification-settings

New endpoints

• GET /api/2/auth/access-tokens/get/{}
• GET /api/2/auth/impersonation/redirect/{}
• GET /api/2/tasks/{}/log-v2

Removed endpoints

• POST /api/2/aws-accounts/test-credentials

New fields

• Proxy.skipped
• Proxy.generated
• Proxy.failed_count
• ProxyProfile.type
• Parameters.media_allow_anonymous_links
• Parameters.media_require_link_password
• Parameters.media_max_link_views
• Parameters.session_key_restrict_to_ip
• Parameters.user_notification_settings

Removed fields

• TaskInfo.log_path

v3.6.1

New endpoints

• DELETE /api/2/nodes/{}
• PATCH /api/2/nodes/{}
• POST /api/2/nodes
• PUT /api/2/nodes/{}
• DELETE /api/2/volumes/{}
• GET /api/2/cloud/accounts/{}/costs
• GET /api/2/cloud/accounts/{}/volume-sizes
• GET /api/2/media/roots/{}/users
• POST /api/2/workspaces/{}/authorize-cloud-mount

Removed endpoints

• DELETE /api/2/image/{}
• DELETE /api/2/veritone/connections/{}/tdo/{}
• GET /api/2/veritone/connections
• GET /api/2/veritone/connections/{}
• GET /api/2/veritone/connections/{}/engines
• GET /api/2/veritone/connections/{}/jobs
• GET /api/2/veritone/metadata
• GET /api/2/veritone/metadata/{}
• POST /api/2/users/preview
• POST /api/2/veritone/connections/{}/upload

Changes

• Images are now managed through individual endpoints:

  • DELETE /api/2/users/me/avatar
  • DELETE /api/2/users/{}/avatar
  • GET /api/2/users/me/avatar
  • GET /api/2/users/{}/avatar
  • POST /api/2/users/me/avatar
  • POST /api/2/users/{}/avatar
  • DELETE /api/2/media/proxy-profiles/{}/watermark
  • GET /api/2/media/proxy-profiles/{}/watermark
  • POST /api/2/media/proxy-profiles/{}/watermark
  • DELETE /api/2/media/roots/{}/cover
  • GET /api/2/media/roots/{}/cover
  • POST /api/2/media/roots/{}/cover

• TaskInfo kwargs are omitted by default, set ?include_kwargs=true to include them.

New request parameters

• GET /api/2/media/backups
  • exclude_unrecognized
  • in_media_root
• GET /api/2/media/bundles
  • include_modified_by
  • in_media_root
• GET /api/2/media/bundles/{}
  • include_modified_by
  • in_media_root
• GET /api/2/media/files
  • in_media_root
  • in_directory
  • exclude_deleted
• GET /api/2/media/files/{}
  • in_media_root
  • in_directory
  • exclude_deleted
  • path
• GET /api/2/media/files/{}/contents
  • ordering
• GET /api/2/media/updates
  • filter
• GET /api/2/tasks
  • include_kwargs
• GET /api/2/tasks/{}
  • include_kwargs
• GET /api/2/workspaces
  • full_path
• GET /api/2/workspaces/mine
  • full_path
  • resolve_access_for
  • include_endpoints
  • include_quotas
• POST /api/2/panel/locate-proxies
  • for_root
  • include_proxies

v3.4.0

New objects

• /api/2/archive/tape/jobs (TapeJob)

New endpoints

• /api/2/archive/tape/archive
• /api/2/archive/tape/library
• /api/2/archive/tape/library/check
• /api/2/archive/tape/library/format
• /api/2/archive/tape/library/load
• /api/2/archive/tape/library/move
• /api/2/archive/tape/library/refresh
• /api/2/archive/tape/library/reindex
• /api/2/archive/tape/library/unload
• /api/2/archive/tape/restore
• /api/2/archive/tape/search
• /api/2/click/connections/{connection_id}/galleries
• /api/2/click/connections/{connection_id}/galleries/{id}
• /api/2/click/connections/{connection_id}/gallery-links
• /api/2/click/connections/{connection_id}/gallery-links/{id}
• /api/2/click/connections/{connection_id}/gallery-links/{link_id}/send
• /api/2/click/uploads
• /api/2/click/uploads/{upload_id}
• /api/2/click/uploads/{upload_id}/background
• /api/2/client-sessions
• /api/2/client-sessions/{id}
• /api/2/filesystem/trace
• /api/2/jobs/{id}/export
• /api/2/jobs/import
• /api/2/media/editor
• /api/2/media/editor/{id}
• /api/2/media/editor/{id}/locate-paths
• /api/2/media/editor/{id}/xml-export
• /api/2/media/editor/asset/{asset_id}/{export_format}-export/avid-comments
• /api/2/media/editor/asset/{asset_ids}/xml-export
• /api/2/media/editor/bundle/{bundle_ids}/xml-export
• /api/2/media/editor/render
• /api/2/media/editor/timeline-export
• /api/2/media/files/{id}/bookmark
• /api/2/media/files/{id}/search-reindex
• /api/2/media/files/{id}/tag
• /api/2/media/files/bookmarks
• /api/2/media/files/templates/{id}/instantiate
• /api/2/rdc/hosts
• /api/2/rdc/hosts/{id}
• /api/2/rdc/hosts/{id}/activate
• /api/2/rdc/hosts/announce
• /api/2/rdc/sessions
• /api/2/rdc/sessions/{id}
• /api/2/share-to-home-workspace
• /api/2/system/certificate
• /api/2/system/certificate/check
• /api/2/uploads/metadata

Model changes

• File model renamed to FilesystemFile
• Subtask.trigger is now a comma separated list

Removed fields

• Asset.urls
• ProxyProfile.enable_realtime_read
• Parameters:
  • email_logo_url
  • fm_new_directory_mode
  • icap_port
  • icap_server
  • icap_service
  • id
  • identify_command
  • media_proxy_h264_preset
  • slugify_shares
  • slugify_workspace_path
  • smtp_ehlo
  • smtp_from
  • smtp_port
  • smtp_server
  • smtp_tls
  • smtp_username
  • tasks_hard_limit
  • tasks_limit
  • umask_afp
  • umask_smb
  • workspaces_mode

v3.3.0

New objects

• /api/2/system/time/servers (NTPServer)
• /api/2/tasks/types (TaskType)
• /api/2/volumes/{id}/quotas/path/{relative_path} (PathQuota)
• /api/2/volumes/{id}/quotas/user/{user_id} (UserQuota)
• /api/2/volumes/{id}/quotas/group/{group_id} (GroupQuota)

New endpoints

• /api/2/auth/impersonation (startImpersonation / stopImpersonation)
• /api/2/auth/reset-password (resetPassword)
• /api/2/media/assets/{id}/proxy-files/{filename} (`downloadAssetProxyFile)
• /api/2/media/custom-fields/{id}/rename (renameCustomField)
• /api/2/media/delete (deleteMediaLibraryObjects)
• /api/2/media/files/{id}/download (downloadMediaFile)
• /api/2/media/files/{id}/forget-deleted (forgetDeletedMediaFiles)
• /api/2/media/files/{id}/showroom (markMediaDirectoryAsShowroom / unmarkMediaDirectoryAsShowroom)
• /api/2/media/proxies/{id}/download (downloadProxy)
• /api/2/media/proxies (generateProxies)
• /api/2/media/workflow/transition (transitionWorkflow)
• /api/2/system/log/{path} (getLog)
• /api/2/system/smtp/preview (emailTemplatePreview)
• /api/2/tasks/queues (getAllTaskQueues)
• /api/2/workspaces/{id}/move (moveWorkspace)

Removed fields

• License:

  • hardware_key
  • components_license

• Parameters:

  • ntp_server

New fields

• MediaFile:

  • is_hardlink
  • is_excluded

• MediaRoot:

  • workflow_jobs

• SystemInfoEndpointResponse:

  • global_alerts

• Proxy:

  • transforms

• Subtask:

  • enqueue_at_front
  • queue

• StorageNode:

  • is_log_aggregator

• Job:

  • enabled

• Production:

  • total_size

• Parameters:

  • email_styling
  • otp_policy

New parameters

• /api/2/media/bundles / getAllMediaFileBundles: include_proxies
• /api/2/media/assets / getAllMediaAssets: include_proxies
• /api/2/productions / getAllProductions: include_total_size
• /api/2/filesystem/delete / deleteFiles: sync