> ## Documentation index > Fetch the complete documentation index at: https://developer.rhombus.com/llms.txt > Use it to discover all available pages before exploring further. # Get bulk media device details > Get media information of any video-supporting media device ```http POST https://api2.rhombussystems.com/api/mediadevice/getBulkMediaDeviceDetails ``` EU organizations send the same request to `https://api2.eu.rhombussystems.com`. ## Authentication and parameters - `x-auth-apikey` (header, required): Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header set to `api-token` (or `partner-api-token` for partner endpoints). - `Authorization` (header): instead of an API key, an OAuth access token (`Bearer `) with the `read` scope. - `x-auth-scheme` (header, string, default: `api-token`): Authentication scheme identifier. Use `api-token` or `partner-api-token` with the `x-auth-apikey` header, `api` or `partner-api` with `x-auth-apikey` plus a client certificate, `api-oauth-token` or `partner-api-oauth-token` with `x-auth-access-token`, and `federated-token` with `x-auth-ft`. A request with `Authorization: Bearer ` and no `x-auth-scheme` is treated as OAuth, and `federated-token` may also be sent as the `x-auth-scheme` and `x-auth-ft` query parameters. One of: `api-token`, `api`, `api-oauth-token`, `federated-token`, `partner-api-token`, `partner-api`, `partner-api-oauth-token`. - `x-auth-org` (header, string): Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry `Deprecation` and `Sunset: Tue, 05 Jan 2027 00:00:00 GMT`). A malformed value returns 400 `INVALID_AUTH_ORG`; a client organization the partner cannot access returns 403 `PARTNER_CLIENT_ACCESS_DENIED`. ## Request body Content type: `application/json`. Request object for getting media information of any video-supporting media device. - `devices` (array | null> | null): Set of device facet UUIDs to get media details for ## Response 200 OK. Content type: `application/json` - `error` (boolean | null) - `errorCode` (string | null): Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg. - `errorMsg` (string | null) - `mediaDeviceDetails` (map | null): Map of device facet UUIDs to their media device details - `warningMsg` (string | null) ## Errors Also 400, 401, 403, 429, 500, 503 with the standard error body (`errorCode`, `errorMsg`): https://developer.rhombus.com/errors ## OpenAPI ````yaml openapi: 3.0.1 info: title: Rhombus API version: "1.0" servers: - description: Production Server url: https://api2.rhombussystems.com security: - ApiKeyAuth: [] paths: /api/mediadevice/getBulkMediaDeviceDetails: post: description: Get media information of any video-supporting media device operationId: getBulkMediaDeviceDetails parameters: - description: "Authentication scheme identifier. Use `api-token` or `partner-api-token` with the `x-auth-apikey` header, `api` or `partner-api` with `x-auth-apikey` plus a client certificate, `api-oauth-token` or `partner-api-oauth-token` with `x-auth-access-token`, and `federated-token` with `x-auth-ft`. A request with `Authorization: Bearer ` and no `x-auth-scheme` is treated as OAuth, and `federated-token` may also be sent as the `x-auth-scheme` and `x-auth-ft` query parameters." example: api-token in: header name: x-auth-scheme required: false schema: default: api-token enum: - api-token - api - api-oauth-token - federated-token - partner-api-token - partner-api - partner-api-oauth-token type: string - description: "Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry `Deprecation` and `Sunset: Tue, 05 Jan 2027 00:00:00 GMT`). A malformed value returns 400 `INVALID_AUTH_ORG`; a client organization the partner cannot access returns 403 `PARTNER_CLIENT_ACCESS_DENIED`." in: header name: x-auth-org required: false schema: format: RUUID maxLength: 22 minLength: 22 type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/Mediadevice_GetBulkMediaDeviceDetailsWSRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Mediadevice_GetBulkMediaDeviceDetailsWSResponse" description: OK "400": $ref: "#/components/responses/BadRequest" "401": $ref: "#/components/responses/Unauthorized" "403": $ref: "#/components/responses/Forbidden" "429": $ref: "#/components/responses/TooManyRequests" "500": $ref: "#/components/responses/InternalServerError" "503": $ref: "#/components/responses/ServiceUnavailable" security: - ApiKeyAuth: [] - oauth2: - read summary: Get bulk media device details tags: - Media Device Webservice components: schemas: Mediadevice_GetBulkMediaDeviceDetailsWSRequest: description: Request object for getting media information of any video-supporting media device. properties: devices: description: Set of device facet UUIDs to get media details for items: description: RUUID with optional appended facet information example: AAAAAAAAAAAAAAAAAAAAAA.v0 format: DeviceFacetUuid nullable: true type: string nullable: true type: array uniqueItems: true type: object Mediadevice_GetBulkMediaDeviceDetailsWSResponse: description: Response object containing media information for video-supporting media devices. properties: error: nullable: true type: boolean errorCode: description: Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg. nullable: true type: string errorMsg: nullable: true type: string mediaDeviceDetails: additionalProperties: $ref: "#/components/schemas/Mediadevice_MediaDeviceDetailsType" description: Map of device facet UUIDs to their media device details nullable: true type: object warningMsg: nullable: true type: string type: object Mediadevice_MediaDeviceDetailsType: description: Detailed information about a media device including streaming URLs and device characteristics. properties: audioGateways: description: List of audio gateway UUIDs associated with the device items: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string nullable: true type: array deviceFacetUuid: description: RUUID with optional appended facet information example: AAAAAAAAAAAAAAAAAAAAAA.v0 format: DeviceFacetUuid nullable: true type: string deviceType: $ref: "#/components/schemas/DeviceTypeEnum" hwVariation: $ref: "#/components/schemas/HardwareVariationEnum" lanCheckUrls: description: URLs to check if the device is available on LAN items: description: URLs to check if the device is available on LAN nullable: true type: string nullable: true type: array lanLiveH264Uris: description: LAN live H264 streaming URIs items: description: LAN live H264 streaming URIs nullable: true type: string nullable: true type: array lanLiveM3u8Uris: description: LAN live M3U8 streaming URIs items: description: LAN live M3U8 streaming URIs nullable: true type: string nullable: true type: array lanLiveMpdUris: description: LAN live MPD streaming URIs items: description: LAN live MPD streaming URIs nullable: true type: string nullable: true type: array lanVodM3u8UrisTemplates: description: LAN VOD M3U8 URI templates items: description: LAN VOD M3U8 URI templates nullable: true type: string nullable: true type: array lanVodMpdUrisTemplates: description: LAN VOD MPD URI templates items: description: LAN VOD MPD URI templates nullable: true type: string nullable: true type: array name: description: Name of the device example: Front Door Camera nullable: true type: string region: description: Region where the device is located example: us-west-2 nullable: true type: string timezone: description: Timezone of the device nullable: true properties: displayName: nullable: true type: string dstsavings: format: int32 nullable: true type: integer id: nullable: true type: string rawOffset: format: int32 nullable: true type: integer type: object uri: description: URI of the device example: rtsp://device.local/stream nullable: true type: string wanLiveH264Uri: description: WAN live H264 streaming URI example: https://stream.rhombussystems.com/live/device123.h264 nullable: true type: string wanLiveM3u8Uri: description: WAN live M3U8 streaming URI example: https://stream.rhombussystems.com/live/device123.m3u8 nullable: true type: string wanLiveMpdUri: description: WAN live MPD streaming URI example: https://stream.rhombussystems.com/live/device123.mpd nullable: true type: string wanVodH264UriTemplate: description: WAN VOD H264 URI template example: https://vod.rhombussystems.com/{timestamp}/device123.h264 nullable: true type: string wanVodM3u8UriTemplate: description: WAN VOD M3U8 URI template example: https://vod.rhombussystems.com/{timestamp}/device123.m3u8 nullable: true type: string wanVodMpdUriTemplate: description: WAN VOD MPD URI template example: https://vod.rhombussystems.com/{timestamp}/device123.mpd nullable: true type: string type: object DeviceTypeEnum: enum: - BLE_TRACKER - CAMERA - DOOR_SENSOR - ENVIRONMENTAL_SENSOR - OCCUPANCY_SENSOR - AUDIO_GATEWAY - EXECUTABLE - BADGE_READER - DOOR_CONTROLLER - BLE_BUTTON - IO_BOARD - ENVIRONMENTAL_GATEWAY - NVR - ROBOT - UNKNOWN type: string HardwareVariationEnum: enum: - RASPBERRY_PI_3 - CAMERA_R1 - CAMERA_R2 - CAMERA_R2_LONG_RANGE - CAMERA_R2_180 - CAMERA_R3 - CAMERA_R4 - CAMERA_R100 - CAMERA_R120 - CAMERA_R170 - CAMERA_R200 - CAMERA_R500 - CAMERA_R510 - CAMERA_R520 - CAMERA_R600 - SENSOR_ASSET_TAG_T1 - SENSOR_DOOR_D1 - SENSOR_DOOR_D20 - SENSOR_ENVIRONMENTAL_E1 - SENSOR_ENVIRONMENTAL_E15 - SENSOR_ENVIRONMENTAL_E2 - SENSOR_MOTION_M1 - SENSOR_MOTION_M15 - GATEWAY_A1 - GATEWAY_A100 - GATEWAY_ENVIRONMENTAL_E50 - CAMERA_R220 - CAMERA_R230 - CAMERA_R36S - CAMERA_R410 - CAMERA_R540 - CAMERA_R545 - BADGE_READER_DR1 - BADGE_READER_DR40 - BADGE_READER_DR20 - DOOR_CONTROLLER_DC1 - DOOR_CONTROLLER_DC20 - DOOR_CONTROLLER_DC10 - ETHERNET_TESTER_ET1 - IO_BOARD_TB1 - BLE_BUTTON_B10 - BLE_BUTTON_B15 - CAMERA_THIRD_PARTY_RELAY - CAMERA_THIRD_PARTY_NVR - CAMERA_THIRD_PARTY_NVR_MULTISENSOR - NVR_N100 - CAMERA_R130 - NVR_N500 - CAMERA_R150 - ROBOT_RC1 - CAMERA_R210 - CAMERA_R650 - NVR_N550 - NVR_N551 - ROBOT_RC2 - UNSPECIFIED type: string securitySchemes: ApiKeyAuth: description: Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header set to `api-token` (or `partner-api-token` for partner endpoints). in: header name: x-auth-apikey type: apiKey oauth2: description: 'OAuth 2.0 authorization code flow with PKCE (`S256`). Send the access token as `Authorization: Bearer `. Each operation lists the scopes it requires; a token without them is refused 403 with `WWW-Authenticate: Bearer error="insufficient_scope"`.' flows: authorizationCode: authorizationUrl: https://console.rhombus.com/oauth/authorize refreshUrl: https://auth-web.rhombussystems.com/oauth/token scopes: physical: Unlock doors and elevators, lockdown, alarms, speakers and robots read: View cameras, footage and settings write: Change settings and data tokenUrl: https://auth-web.rhombussystems.com/oauth/token type: oauth2 ````