Sip options prober API

create new entry

POST /api/rest/admin/sip-options-probers

Parameters

Name	Description
data[type]	Resource type (sip-options-probers)
data[attributes][name]	Name
data[attributes][ruri-username]	Ruri username
data[attributes][ruri-domain]	Ruri domain
data[attributes][append-headers]	Append headers
data[attributes][auth-password]	Auth password
data[attributes][auth-username]	Auth username
data[attributes][contact-uri]	Contact uri
data[attributes][enabled]	Enabled
data[attributes][from-uri]	From uri
data[attributes][interval]	Interval
data[attributes][route-set]	Route set
data[attributes][sip-interface-name]	Sip interface name
data[attributes][sip-schema-id]	Sip schema id
data[attributes][to-uri]	To uri
data[attributes][created-at]	Created at
data[attributes][updated-at]	Updated at
data[attributes][external-id]	External id
data[relationships][transport-protocol]	Transport protocol
data[relationships][node]	Node
data[relationships][pop]	Pop

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjI0NCwiYXVkIjpbImFkbWluIl0sImV4cCI6MTc3NjM2NTc0M30.AwpzAkqufutZHxELl-xlkXmmAXYjWABdwRbZNTBh8mQ
Host: example.org
Cookie: 

Route

POST /api/rest/admin/sip-options-probers

Body

{"data":{"type":"sip-options-probers","attributes":{"name":"name","ruri-username":"ruri-username","ruri-domain":"ruri-domain"},"relationships":{"transport-protocol":{"data":{"type":"transport-protocols","id":1}}}}}

Response

Headers

x-frame-options: SAMEORIGIN
x-xss-protection: 0
x-content-type-options: nosniff
x-permitted-cross-domain-policies: none
referrer-policy: strict-origin-when-cross-origin
content-type: application/vnd.api+json
location: http://example.org/api/rest/admin/sip-options-probers/4
vary: Accept
etag: W/"d4869022336865662cab8deebbdfd2dd"
cache-control: max-age=0, private, must-revalidate
x-request-id: 1f5ff41c-9d63-40de-8473-c3ed920df025
x-runtime: 0.012265
content-length: 1097

Status

201 Created

Body

{
  "data": {
    "id": "4",
    "type": "sip-options-probers",
    "links": {
      "self": "http://example.org/api/rest/admin/sip-options-probers/4"
    },
    "attributes": {
      "append-headers": null,
      "auth-password": null,
      "auth-username": null,
      "contact-uri": null,
      "enabled": true,
      "from-uri": null,
      "interval": 60,
      "name": "name",
      "route-set": [],
      "ruri-domain": "ruri-domain",
      "ruri-username": "ruri-username",
      "sip-interface-name": null,
      "sip-schema-id": 1,
      "to-uri": null,
      "created-at": "2026-04-16T18:45:43.956Z",
      "updated-at": "2026-04-16T18:45:43.956Z",
      "external-id": null
    },
    "relationships": {
      "node": {
        "links": {
          "self": "http://example.org/api/rest/admin/sip-options-probers/4/relationships/node",
          "related": "http://example.org/api/rest/admin/sip-options-probers/4/node"
        }
      },
      "pop": {
        "links": {
          "self": "http://example.org/api/rest/admin/sip-options-probers/4/relationships/pop",
          "related": "http://example.org/api/rest/admin/sip-options-probers/4/pop"
        }
      },
      "transport-protocol": {
        "links": {
          "self": "http://example.org/api/rest/admin/sip-options-probers/4/relationships/transport-protocol",
          "related": "http://example.org/api/rest/admin/sip-options-probers/4/transport-protocol"
        }
      }
    }
  }
}