SIP Registration API

get specific entry

GET /api/rest/admin/registrations/:id

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE4OCwiYXVkIjpbImFkbWluIl0sImV4cCI6MTc3MjIxMjAwOX0.tACFh0LLsPnhHRP2m5uHcG-4HOx_BznsBmjUaOBD9qU
Host: example.org
Cookie: 

Route

GET /api/rest/admin/registrations/7?timezone=%28GMT%2B00%3A00%29+UTC

Query Parameters

timezone: (GMT+00:00) UTC

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/"eb2069399176283826660fd0013c3623"
cache-control: max-age=0, private, must-revalidate
x-request-id: e9189b65-a8aa-442d-89c9-553127a7a25d
x-runtime: 0.006161
content-length: 1037

Status

200 OK

Body

{
  "data": {
    "id": "7",
    "type": "registrations",
    "links": {
      "self": "http://example.org/api/rest/admin/registrations/7"
    },
    "attributes": {
      "auth-password": null,
      "auth-user": null,
      "contact": "sip:user@domain",
      "display-username": null,
      "domain": "localhost",
      "enabled": true,
      "expire": null,
      "force-expire": false,
      "max-attempts": null,
      "name": "Equipment Registration 3",
      "route-set": [
        "sip:user@proxy-domain1",
        "sip:user@proxy-domain2"
      ],
      "retry-delay": 5,
      "sip-interface-name": null,
      "username": "user name",
      "sip-schema-id": 1
    },
    "relationships": {
      "transport-protocol": {
        "links": {
          "self": "http://example.org/api/rest/admin/registrations/7/relationships/transport-protocol",
          "related": "http://example.org/api/rest/admin/registrations/7/transport-protocol"
        }
      },
      "pop": {
        "links": {
          "self": "http://example.org/api/rest/admin/registrations/7/relationships/pop",
          "related": "http://example.org/api/rest/admin/registrations/7/pop"
        }
      },
      "node": {
        "links": {
          "self": "http://example.org/api/rest/admin/registrations/7/relationships/node",
          "related": "http://example.org/api/rest/admin/registrations/7/node"
        }
      }
    }
  }
}