Sip options prober API

update values

PUT /api/rest/admin/equipment/sip-options-probers/:id

Parameters

Name Description
data[type] Resource type (sip-options-probers)
data[id] Sip Options Prober ID
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][proxy] Proxy
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][proxy-transport-protocol] Proxy transport protocol
data[relationships][node] Node
data[relationships][pop] Pop

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3MjEyMzYzMTUsInN1YiI6MTE3fQ.Heigd6J3Zp9_WrP-42AfHHyLiGwRfe_w4Nf_5432W3A
Host: example.org
Cookie: 

Route

PUT /api/rest/admin/equipment/sip-options-probers/5

Body

{"data":{"type":"sip-options-probers","id":5,"attributes":{"name":"test_name"}}}

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/vnd.api+json
Vary: Accept
ETag: W/"f0467b580b3c04007ba3d1c76d999799"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 009873e2-4d73-4485-bb54-1b98d8e0a5c4
X-Runtime: 0.022272
Content-Length: 1418

Status

200 OK

Body

{
  "data": {
    "id": "5",
    "type": "sip-options-probers",
    "links": {
      "self": "http://example.org/api/rest/admin/equipment/sip-options-probers/5"
    },
    "attributes": {
      "append-headers": null,
      "auth-password": null,
      "auth-username": null,
      "contact-uri": null,
      "enabled": true,
      "from-uri": null,
      "interval": 60,
      "name": "test_name",
      "proxy": null,
      "ruri-domain": "4.sip.com",
      "ruri-username": "username_4",
      "sip-interface-name": null,
      "sip-schema-id": 1,
      "to-uri": null,
      "created-at": "2024-07-17T17:01:55.745Z",
      "updated-at": "2024-07-17T17:01:55.779Z",
      "external-id": 4
    },
    "relationships": {
      "node": {
        "links": {
          "self": "http://example.org/api/rest/admin/equipment/sip-options-probers/5/relationships/node",
          "related": "http://example.org/api/rest/admin/equipment/sip-options-probers/5/node"
        }
      },
      "pop": {
        "links": {
          "self": "http://example.org/api/rest/admin/equipment/sip-options-probers/5/relationships/pop",
          "related": "http://example.org/api/rest/admin/equipment/sip-options-probers/5/pop"
        }
      },
      "proxy-transport-protocol": {
        "links": {
          "self": "http://example.org/api/rest/admin/equipment/sip-options-probers/5/relationships/proxy-transport-protocol",
          "related": "http://example.org/api/rest/admin/equipment/sip-options-probers/5/proxy-transport-protocol"
        }
      },
      "transport-protocol": {
        "links": {
          "self": "http://example.org/api/rest/admin/equipment/sip-options-probers/5/relationships/transport-protocol",
          "related": "http://example.org/api/rest/admin/equipment/sip-options-probers/5/transport-protocol"
        }
      }
    }
  }
}