arrow-clients

Add Arrow service

Add a custom service to the Arrow client service table.

This method is supported only if the add_custom_service capability is signaled by the Arrow client. It can be used to access IP cameras in the target network if the automatic service discovery does not find them. The Arrow client will verify that the IP address belongs to the same local network it is connected to. Other IP addresses will be rejected for security reasons.

post/arrow-clients/{uuid}/services/

Request

  • Base URL
    https://api.angelcam.com/v1
  • Auth
    • OAuth 2
      Authorization codehttps://my.angelcam.com/oauth/authorize/, token URL https://my.angelcam.com/oauth/token/
      PasswordToken URL https://api.angelcam.com/oauth/token/
      Scopesarrow_client_manage
    • or API key in header Authorization
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

uuidstring uuid required

Arrow client UUID

Request body

type'http' | 'rtsp' required

Type of the target service

ipstring required

local IP address

portinteger required

service port

Example request

{
  "type": "rtsp",
  "ip": "192.168.1.100",
  "port": 554
}

Response

OK

service_idstring required

Arrow service ID

Example response

{
  "service_id": "abcd"
}

Changes

No recorded changes to this operation across all 1 revision of this API.