> ## Documentation index > Fetch the complete documentation index at: https://developer.rhombus.com/llms.txt > Use it to discover all available pages before exploring further. # Add third party camera via ONVIF > Probe a single camera by IP address over ONVIF, auto-derive its metadata, and (unless disabled) provision it — adding a camera from just an IP and credentials. ```http POST https://api2.rhombussystems.com/api/relay/addThirdPartyCameraViaOnvif ``` 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 `write` 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`. Add a third-party camera via ONVIF from an IP address and credentials. - `autoAssign` (boolean | null): Provision (assign to the NVR) automatically after a successful probe. Defaults to false (probe-then-confirm). - `ipAddress` (string | null): IPv4 address of the camera to probe - `locationUuid` (string | null): base 64 (url-safe) uuid string - `name` (string | null): Camera name. When blank, derived from the ONVIF manufacturer and model. - `nvrUuid` (string | null): base 64 (url-safe) uuid string - `password` (string | null): ONVIF password to try first (optional) - `trySavedCredentials` (boolean | null): Also try the org's saved third-party camera credentials. Defaults to true. - `username` (string | null): ONVIF username to try first (optional) ## Response 200 OK. Content type: `application/json` - `assignedDeviceUuid` (string | null): RUUID with optional appended facet information - `assignmentMsg` (string | null): Why auto-assignment did not happen or failed, when applicable - `codec` (string | null): Detected codec(s) - `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) - `found` (boolean | null): Whether an ONVIF-streamable camera was found at the address - `ipAddress` (string | null): Resolved camera IP address - `macAddress` (string | null): Camera MAC address as reported by ONVIF - `manufacturer` (string | null): Manufacturer reported by ONVIF - `model` (string | null): Model reported by ONVIF - `name` (string | null): Name the camera was (or would be) provisioned with - `rtspUrl` (string | null): RTSP stream URL derived from ONVIF - `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/relay/addThirdPartyCameraViaOnvif: post: description: Probe a single camera by IP address over ONVIF, auto-derive its metadata, and (unless disabled) provision it — adding a camera from just an IP and credentials. operationId: addThirdPartyCameraViaOnvif 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/Relay_AddThirdPartyCameraViaOnvifWSRequest" responses: "200": content: application/json: schema: $ref: "#/components/schemas/Relay_AddThirdPartyCameraViaOnvifWSResponse" 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: - write summary: Add third party camera via ONVIF tags: - Relay Webservice components: schemas: Relay_AddThirdPartyCameraViaOnvifWSRequest: description: Add a third-party camera via ONVIF from an IP address and credentials. properties: autoAssign: description: Provision (assign to the NVR) automatically after a successful probe. Defaults to false (probe-then-confirm). nullable: true type: boolean ipAddress: description: IPv4 address of the camera to probe example: 10.5.4.20 nullable: true type: string locationUuid: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string name: description: Camera name. When blank, derived from the ONVIF manufacturer and model. nullable: true type: string nvrUuid: description: base 64 (url-safe) uuid string example: AAAAAAAAAAAAAAAAAAAAAA format: RUUID nullable: true type: string password: description: ONVIF password to try first (optional) nullable: true type: string trySavedCredentials: description: Also try the org's saved third-party camera credentials. Defaults to true. nullable: true type: boolean username: description: ONVIF username to try first (optional) nullable: true type: string type: object Relay_AddThirdPartyCameraViaOnvifWSResponse: description: Result of adding a third-party camera via ONVIF. properties: assignedDeviceUuid: description: RUUID with optional appended facet information example: AAAAAAAAAAAAAAAAAAAAAA.v0 format: DeviceFacetUuid nullable: true type: string assignmentMsg: description: Why auto-assignment did not happen or failed, when applicable nullable: true type: string codec: description: Detected codec(s) nullable: true type: string 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 found: description: Whether an ONVIF-streamable camera was found at the address nullable: true type: boolean ipAddress: description: Resolved camera IP address nullable: true type: string macAddress: description: Camera MAC address as reported by ONVIF nullable: true type: string manufacturer: description: Manufacturer reported by ONVIF nullable: true type: string model: description: Model reported by ONVIF nullable: true type: string name: description: Name the camera was (or would be) provisioned with nullable: true type: string rtspUrl: description: RTSP stream URL derived from ONVIF nullable: true type: string warningMsg: nullable: true type: string type: object 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 ````