Sip options prober API

get listing

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

Parameters

Name Description
filter[id] id filter

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjIzNywiYXVkIjpbImFkbWluIl0sImV4cCI6MTc3MjIxMjAxMX0.nhYCpkxh-TOiWEqUta8cNdhzkG_RxRCP0e1GStGma8U
Host: example.org
Cookie: 

Route

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

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
vary: Accept
etag: W/"3c8de3e1a2b2a7f76d9990e62f7bf927"
cache-control: max-age=0, private, must-revalidate
x-request-id: 6efdd4a4-3522-4880-aef7-d25c8df1c8b7
x-runtime: 0.007449
content-length: 2594

Status

200 OK

Body

{
  "data": [
    {
      "id": "1",
      "type": "sip-options-probers",
      "links": {
        "self": "http://example.org/api/rest/admin/sip-options-probers/1"
      },
      "attributes": {
        "append-headers": null,
        "auth-password": null,
        "auth-username": null,
        "contact-uri": null,
        "enabled": true,
        "from-uri": null,
        "interval": 60,
        "name": "SIP Options Prober 1",
        "route-set": [
          "sip:proxy1.example.com;transport=tls",
          "sip:proxy2.example.com;transport=tls"
        ],
        "ruri-domain": "1.sip.com",
        "ruri-username": "username_1",
        "sip-interface-name": null,
        "sip-schema-id": 1,
        "to-uri": null,
        "created-at": "2026-02-27T16:56:51.037Z",
        "updated-at": "2026-02-27T16:56:51.037Z",
        "external-id": 1
      },
      "relationships": {
        "node": {
          "links": {
            "self": "http://example.org/api/rest/admin/sip-options-probers/1/relationships/node",
            "related": "http://example.org/api/rest/admin/sip-options-probers/1/node"
          }
        },
        "pop": {
          "links": {
            "self": "http://example.org/api/rest/admin/sip-options-probers/1/relationships/pop",
            "related": "http://example.org/api/rest/admin/sip-options-probers/1/pop"
          }
        },
        "transport-protocol": {
          "links": {
            "self": "http://example.org/api/rest/admin/sip-options-probers/1/relationships/transport-protocol",
            "related": "http://example.org/api/rest/admin/sip-options-probers/1/transport-protocol"
          }
        }
      }
    },
    {
      "id": "2",
      "type": "sip-options-probers",
      "links": {
        "self": "http://example.org/api/rest/admin/sip-options-probers/2"
      },
      "attributes": {
        "append-headers": null,
        "auth-password": null,
        "auth-username": null,
        "contact-uri": null,
        "enabled": true,
        "from-uri": null,
        "interval": 60,
        "name": "SIP Options Prober 2",
        "route-set": [
          "sip:proxy1.example.com;transport=tls",
          "sip:proxy2.example.com;transport=tls"
        ],
        "ruri-domain": "2.sip.com",
        "ruri-username": "username_2",
        "sip-interface-name": null,
        "sip-schema-id": 1,
        "to-uri": null,
        "created-at": "2026-02-27T16:56:51.045Z",
        "updated-at": "2026-02-27T16:56:51.045Z",
        "external-id": 2
      },
      "relationships": {
        "node": {
          "links": {
            "self": "http://example.org/api/rest/admin/sip-options-probers/2/relationships/node",
            "related": "http://example.org/api/rest/admin/sip-options-probers/2/node"
          }
        },
        "pop": {
          "links": {
            "self": "http://example.org/api/rest/admin/sip-options-probers/2/relationships/pop",
            "related": "http://example.org/api/rest/admin/sip-options-probers/2/pop"
          }
        },
        "transport-protocol": {
          "links": {
            "self": "http://example.org/api/rest/admin/sip-options-probers/2/relationships/transport-protocol",
            "related": "http://example.org/api/rest/admin/sip-options-probers/2/transport-protocol"
          }
        }
      }
    }
  ],
  "meta": {
    "total-count": 2
  },
  "links": {
    "first": "http://example.org/api/rest/admin/sip-options-probers?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/admin/sip-options-probers?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}