alias

Changed on

Adds alias to system

post/alias

Request

  • Base URL: http://localhost:9080/api/v3
  • URL: http://localhost:9080/api/v3/alias
  • Auth: one of:
    • API key in header Authorization
    • SecurityDefinitions (a scheme the document does not define)
    • API key in header Authorization
    • type (a scheme the document does not define)
    • name (a scheme the document does not define)
    • in (a scheme the document does not define)

Request body

aliasstring required

alias name

captureIDstring required
guidstring
idinteger
ipstring required
maskinteger required
portinteger required
statusboolean

Example request

{
  "alias": "verizon",
  "captureID": "0",
  "ip": "192.168.10.20",
  "mask": 32,
  "port": 5060
}

Response

AliasCreationSuccessResponse

datastring
messagestring

Example response

{
  "data": "f2d0a540-bf21-4c0d-ac73-8696ea10855a",
  "message": "successfully created alias"
}

Changes