SIP Registration API

get listing

GET /api/rest/admin/registrations

Parameters

Name	Description
filter[id]	id filter

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE4NywiYXVkIjpbImFkbWluIl0sImV4cCI6MTc3MjIxMjAwOX0.zHOyHM2fbU5Y1vW3Jn7PhGTFLTRi1XoDMhQftKnTxnk
Host: example.org
Cookie: 

Route

GET /api/rest/admin/registrations

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/"64a5b952b3393717d22427ef2b119257"
cache-control: max-age=0, private, must-revalidate
x-request-id: ebe3b0e9-c48b-447d-967a-f433b969123d
x-runtime: 0.007293
content-length: 2292

Status

200 OK

Body

{
  "data": [
    {
      "id": "5",
      "type": "registrations",
      "links": {
        "self": "http://example.org/api/rest/admin/registrations/5"
      },
      "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 1",
        "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/5/relationships/transport-protocol",
            "related": "http://example.org/api/rest/admin/registrations/5/transport-protocol"
          }
        },
        "pop": {
          "links": {
            "self": "http://example.org/api/rest/admin/registrations/5/relationships/pop",
            "related": "http://example.org/api/rest/admin/registrations/5/pop"
          }
        },
        "node": {
          "links": {
            "self": "http://example.org/api/rest/admin/registrations/5/relationships/node",
            "related": "http://example.org/api/rest/admin/registrations/5/node"
          }
        }
      }
    },
    {
      "id": "6",
      "type": "registrations",
      "links": {
        "self": "http://example.org/api/rest/admin/registrations/6"
      },
      "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 2",
        "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/6/relationships/transport-protocol",
            "related": "http://example.org/api/rest/admin/registrations/6/transport-protocol"
          }
        },
        "pop": {
          "links": {
            "self": "http://example.org/api/rest/admin/registrations/6/relationships/pop",
            "related": "http://example.org/api/rest/admin/registrations/6/pop"
          }
        },
        "node": {
          "links": {
            "self": "http://example.org/api/rest/admin/registrations/6/relationships/node",
            "related": "http://example.org/api/rest/admin/registrations/6/node"
          }
        }
      }
    }
  ],
  "meta": {
    "total-count": 2
  },
  "links": {
    "first": "http://example.org/api/rest/admin/registrations?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/admin/registrations?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}