Mimir REST API Reference¶
API documentation generated from live probing of us.mjoll.no.
The vendor's published spec is known to be outdated — this is ground truth.
Overview¶
| Metric | Count |
|---|---|
| Total endpoints probed | 282 |
| Confirmed live | 149 |
| ↳ Responded with data (2xx) | 93 |
| ↳ Exists but rejected input (4xx) | 50 |
| Not found (404) | 133 |
| Forbidden (403) | 0 |
| Server error (5xx) | 0 |
Authentication¶
All endpoints require the following header:
API keys are generated from the Mimir web console → User Settings → API Keys.
Base URLs¶
| Prefix | Purpose |
|---|---|
/api/v1/ |
Core API (items, folders, search, metadata) |
/prime/api/v1/ |
Live video, recordings, presets, shares |
/config/api/v1/ |
System configuration |
All Confirmed Endpoints¶
| Method | Path | Description | Area |
|---|---|---|---|
GET |
/config/api/v1/bookmarks |
Retrieve all visible system bookmarks | config |
POST |
/config/api/v1/bookmarks |
Create a new system bookmark | config |
PUT |
/config/api/v1/bookmarks |
Delete old system bookmarks and create new bookmarks from payload | config |
DELETE |
/config/api/v1/bookmarks/{bookmarkId} |
Delete a system bookmark | config |
GET |
/config/api/v1/bookmarks/{bookmarkId} |
Retrieve a system bookmark | config |
PUT |
/config/api/v1/bookmarks/{bookmarkId} |
Update a system bookmark | config |
GET |
/config/api/v1/config |
Get tenant configuration information | config |
POST |
/config/api/v1/config |
Update the tenant configuration information | config |
GET |
/config/api/v1/configs/kelda |
Retrieve kelda | config |
POST |
/config/api/v1/configs/kelda |
Create a new kelda | config |
DELETE |
/config/api/v1/configs/kelda/{id} |
Delete kelda | config |
GET |
/config/api/v1/storages |
Get all storages under the tenant | config |
POST |
/config/api/v1/storages |
Create a storage under the tenant | config |
DELETE |
/config/api/v1/storages/{storageId} |
Delete a storage entry | config |
PUT |
/config/api/v1/storages/{storageId} |
Update a storage under the tenant | config |
GET |
/ingest/api/v1/ingestStorageConfigs |
Get all ingest configuration in the system | config |
POST |
/ingest/api/v1/ingestStorageConfigs |
Create a new ingest storage configuration | config |
POST |
/api/v1/folders/ancestry |
Retrieve folder path for a set of items or folders | folders |
POST |
/api/v1/folders/path |
Create folder structure for given path | folders |
DELETE |
/api/v1/folders/{folderId} |
Delete a folder | folders |
GET |
/api/v1/folders/{folderId} |
Retrieve a folder entry | folders |
POST |
/api/v1/folders/{folderId} |
Rename, move, change owner, or update access-controls or sortKey of a folder | folders |
GET |
/api/v1/folders/{folderId}/content |
Retrieve the content of a folder | folders |
GET |
/api/v1/folders/{folderId}/metadata |
Retrieve metadata for a folder | folders |
PUT |
/api/v1/folders/{folderId}/metadata |
Update metadata of a folder | folders |
GET |
/config/api/v1/bookmarkFolders |
Retrieve Bookmark Folders | folders |
PUT |
/config/api/v1/bookmarkFolders |
Write Bookmark Folders | folders |
DELETE |
/api/v1/batchItems |
Delete items in batches | items |
GET |
/api/v1/batchItems |
Retrieve batchItems | items |
PATCH |
/api/v1/batchItems |
Update items in batches | items |
POST |
/api/v1/batchItems |
Create items in batches | items |
GET |
/api/v1/clipLists/{itemId} |
Get clip entries of a sequence | items |
PUT |
/api/v1/clipLists/{itemId} |
Update clip list of a sequence | items |
PATCH |
/api/v1/itemMetadata/{itemId} |
Update item metadata | items |
GET |
/api/v1/items |
Poll items | items |
POST |
/api/v1/items |
Create an Item entry | items |
GET |
/api/v1/items/{id} |
Retrieve items for a item | items |
GET |
/api/v1/items/{id}/ancestry |
Retrieve ancestry for a item | items |
GET |
/api/v1/items/{id}/attachments |
Retrieve attachments for a item | items |
GET |
/api/v1/items/{id}/comments |
Retrieve comments for a item | items |
GET |
/api/v1/items/{id}/customIcons |
Retrieve customIcons for a item | items |
GET |
/api/v1/items/{id}/relations |
Retrieve relations for a item | items |
GET |
/api/v1/items/{id}/timedMetadata |
Retrieve timedMetadata for a item | items |
GET |
/api/v1/items/{id}/transcript |
Retrieve transcript for a item | items |
DELETE |
/api/v1/items/{itemId} |
Delete an Item entry | items |
GET |
/api/v1/items/{itemId} |
Retrieve an Item entry | items |
POST |
/api/v1/items/{itemId} |
Update an Item entry | items |
POST |
/api/v1/items/{itemId}/aaf |
AAF subclip generation | items |
GET |
/api/v1/items/{itemId}/ancestry |
Get the ancestries of the item | items |
PUT |
/api/v1/items/{itemId}/archive |
Archives/Unarchives an item | items |
DELETE |
/api/v1/items/{itemId}/attachments |
Delete an attachment from a specific item | items |
GET |
/api/v1/items/{itemId}/attachments |
Get list of attachments or specific one | items |
POST |
/api/v1/items/{itemId}/attachments |
Create an attachment to a specific item | items |
PUT |
/api/v1/items/{itemId}/attachments |
Update an existing item attachment | items |
GET |
/api/v1/items/{itemId}/comments |
Get all comments for an item | items |
POST |
/api/v1/items/{itemId}/comments |
Create a new comment | items |
GET |
/api/v1/items/{itemId}/customIcons |
Get all custom icons for an item | items |
PATCH |
/api/v1/items/{itemId}/customIcons |
Partially update custom icons for an item | items |
PUT |
/api/v1/items/{itemId}/customIcons |
Save custom icons for an item | items |
DELETE |
/api/v1/items/{itemId}/deleteHighres |
Cancel highres deletion of an item | items |
POST |
/api/v1/items/{itemId}/deleteHighres |
Delete item's highres media | items |
POST |
/api/v1/items/{itemId}/itemUploadPartsSignUrls |
Create signed urls for multipart upload for an item | items |
DELETE |
/api/v1/items/{itemId}/labels |
Delete label(s) from the Item | items |
GET |
/api/v1/items/{itemId}/mediaSegments/{streamIds}/{signedForMethod}/{firstSegmentIndex} |
Get media segment URLs for an item | items |
POST |
/api/v1/items/{itemId}/mediaUsage |
Update the media usage of an item | items |
POST |
/api/v1/items/{itemId}/migrateMediaLocation |
Migrate media location for an item | items |
POST |
/api/v1/items/{itemId}/multipartUploadComplete |
Complete multipart upload for an item | items |
GET |
/api/v1/items/{itemId}/relations |
Retrieve all relation of the item | items |
PUT |
/api/v1/items/{itemId}/relations/{relationType} |
Update relation entries of a single relation type | items |
DELETE |
/api/v1/items/{itemId}/relations/{relationType}/{relatedItemId} |
Delete a relation entry between two items | items |
GET |
/api/v1/items/{itemId}/thumbnail/{position} |
Get thumbnail URL at time position | items |
POST |
/api/v1/items/{itemId}/thumbnails/upload-urls |
Generate thumbnail upload URLs | items |
GET |
/api/v1/items/{itemId}/thumbnails/urls |
Get bulk thumbnail URLs | items |
GET |
/api/v1/items/{itemId}/timedMetadata |
Get the timed metadata of an item | items |
PUT |
/api/v1/items/{itemId}/timedMetadata |
Update timed metadata of an item | items |
PUT |
/api/v1/items/{itemId}/transcript |
Update transcript of the Item | items |
POST |
/api/v1/items/{itemId}/undelete |
Undelete an Item entry if not permanently deleted | items |
DELETE |
/api/v1/items/{itemId}/upload |
Deletes the upload lock on an item | items |
GET |
/api/v1/items/{itemId}/upload |
Get upload lock information for an item | items |
PUT |
/api/v1/items/{itemId}/upload |
Create upload lock for an item | items |
GET |
/api/v1/items/{itemId}/version |
Retrieve an Item's latest version | items |
POST |
/api/v1/items/{itemId}/version |
Create a new version of item | items |
GET |
/api/v1/items/{itemId}/versionsHistory |
Retrieve the version history of an item | items |
POST |
/api/v1/items/{itemId}/versionsHistory |
Promote an item to latest version | items |
PUT |
/api/v1/items/{itemId}/versionsHistory |
Update version name | items |
GET |
/api/v1/itemsByExternalId |
Get item ids from external ids | items |
GET |
/auxiliary/api/v1/itemAnalyticsSearch |
Search in item analytics | items |
POST |
/auxiliary/api/v1/items/{itemId}/restoreMedia |
Create a restore request in Glacier for a media | items |
GET |
/auxiliary/api/v1/systemActivity/item/{itemId} |
Retrieve system activity for a specific item | items |
POST |
/prime/api/v1/cropImage |
Crop an image | items |
GET |
/prime/api/v1/feed/items/{since} |
Get Feed Items | items |
POST |
/prime/api/v1/items/{itemId}/bundle |
Get Item Bundle | items |
POST |
/prime/api/v1/live/series/{id}/items |
Create an Item for an upcoming series recording | items |
GET |
/prime/api/v1/playableItem/{itemId} |
Get playable item information for media playback | items |
GET |
/prime/api/v1/live/pipelines |
Retrieve pipelines | live |
PATCH |
/api/v1/itemMetadata/{id} |
Partially update itemMetadata | metadata |
GET |
/api/v1/mdfs |
Retrieve MDF entries | metadata |
POST |
/api/v1/mdfs |
Create an MDF entry | metadata |
DELETE |
/api/v1/mdfs/{mdfId} |
Delete an MDF entry | metadata |
GET |
/api/v1/mdfs/{mdfId} |
Retrieve an MDF entry | metadata |
PUT |
/api/v1/mdfs/{mdfId} |
Update an MDF entry | metadata |
GET |
/api/v1/optionLists |
Retrieve option lists | metadata |
POST |
/api/v1/optionLists |
Create an option list | metadata |
DELETE |
/api/v1/optionLists/{optionListId} |
Delete an option list | metadata |
PUT |
/api/v1/optionLists/{optionListId} |
Update an option list | metadata |
GET |
/prime/api/v1/notifications |
Get notifications for the current user | notifications |
POST |
/prime/api/v1/notifications |
Create and send custom notifications | notifications |
GET |
/prime/api/v1/presets |
Retrieve presets | presets |
POST |
/prime/api/v1/presets |
Create a new Mimir preset | presets |
DELETE |
/prime/api/v1/presets/{presetId} |
Delete a Mimir preset | presets |
PUT |
/prime/api/v1/presets/{presetId} |
Update an existing Mimir preset | presets |
GET |
/prime/api/v1/live/scheduled |
Get scheduled recordings that have a start time within a specified time period | recordings |
GET |
/prime/api/v1/live/scheduled/{id} |
Get a scheduled recording item | recordings |
GET |
/auxiliary/api/v1/transfers |
Get all transfer request | replication |
GET |
/prime/api/v1/replication |
Get Replication | replication |
PUT |
/prime/api/v1/replication |
Put Replication | replication |
GET |
/api/v1/search |
Perform search operation on items | search |
POST |
/prime/api/v1/renderSequenceRequests |
Create a render sequence request | sequences |
GET |
/prime/api/v1/shares |
Retrieve shares | shares |
POST |
/prime/api/v1/shares |
Create a new share | shares |
GET |
/api/v1/storageManagers |
Get Status of all the Storage Managers | storage |
GET |
/ingest/api/v1/generatedMediaLocations |
Get tenant generated media locations | storage |
POST |
/ingest/api/v1/generatedMediaLocations |
Create generated media location | storage |
DELETE |
/prime/api/v1/storages |
Delete storage location | storage |
GET |
/prime/api/v1/storages |
Get storage locations | storage |
POST |
/prime/api/v1/storages |
Create storage location | storage |
PUT |
/prime/api/v1/storages |
Update storage location | storage |
GET |
/api/v1/metering |
Get metering information for one or several tenants | system |
GET |
/api/v1/stats |
Retrieve various statistics for the tenant | system |
GET |
/auth/api/v1/security |
Get security | system |
PUT |
/auth/api/v1/security |
Put security | system |
GET |
/auxiliary/api/v1/systemActivity |
Retrieve system activity events for your tenant | system |
GET |
/config/api/v1/tenantIds |
Get tenant ids list | system |
PUT |
/api/v1/items/{id}/transcript |
Update transcript for a item | transcription |
GET |
/config/api/v1/config/transcriptionLanguageSettings |
Get transcription language settings for the tenant | transcription |
POST |
/config/api/v1/config/transcriptionLanguageSettings |
Create transcription language settings for the tenant | transcription |
GET |
/config/api/v1/systemConfig/transcriptionLanguageSettings |
Get All Transcription Language Settings for the system | transcription |
POST |
/api/v1/process |
Execute Media Processing | unknown |
GET |
/auth/api/v1/keys |
Get all API keys | unknown |
POST |
/auth/api/v1/keys |
Create a new API key | unknown |
DELETE |
/auth/api/v1/keys/{keyId} |
Delete an API key | unknown |
PUT |
/auxiliary/api/v1/keldaIngestFile/{keldaId} |
Ingest a file via kelda | unknown |
POST |
/ingest/api/v1/ingestFile |
Ingest file in an external storage into Mimir | unknown |
GET |
/config/api/v1/config/defaultUploadLocation |
Get the default upload location in the system | upload |
GET |
/config/api/v1/config/uploadLocations |
Get all upload locations in the system | upload |
POST |
/api/v1/persons |
Create a person | users |
GET |
/auth/api/v1/user/status |
User deactivation status | users |
GET |
/auxiliary/api/v1/userSettings |
Retrieve user settings | users |
PUT |
/auxiliary/api/v1/userSettings |
Update user settings | users |