Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

REST API Method: GET /rest/siplocalregistrartable/{identifier}/historicalstatistics/{identifier}

Page Tree
rootResource - siplocalregistrartable

This action retrieves the historical statistics for a given SIP Local Registrar Table in the

...

SBC

...

. The collections are over 1 hour intervals for a period of 1 day, thus giving a maximum of 24 historical records.

Info

The current interval is always the resource with ID 1. There will be a maximum of 25 rows returned for a lookup, where the row with ID 1 is the current interval being collected and the rows with ID 2-25 are the historical collections.

Tip

If no ID is specified, a listing of all collections will be returned along with their associated IDs. These identifiers can be used to get the individual resource element values.

URL:

https://

...

192.

...

168.

...

0.

...

111/rest/siplocalregistrartable/{identifier}/historicalstatistics/{identifier}

HTTP Method

GET

Requires Authentication

true

Noprint
Panel
bgColortransparent
titleBGColor#DDD
title[siplocalregistrartable - REST API Methods|Resource - siplocalregistrartable]

Page Tree
root@parent

Resource Schema

Statistics

Parameter Name Description Data Type Possible Values
rt_AcceptedRegsDisplays the Displays the number of accepted registrations.int
rt_RejectedRegsDisplays the number of failed registrations due to maximum number of registration exceeded or authentication failure.int
rt_CurrentUsersDisplays the number of current registered endpoints in the registrar.int
rt_PeakUsersDisplays the peak number of registered endpoints in the registrar.

Usage Example: (about cURL | requires a session token)

Code Block
languagebash
curl --cookie PHPSESSID=ima0r3nkaeg8mo0suln67vg4m7 --cacert 134.56.227.163.crt 
-i https://134.56.227.163/rest/siplocalregistrartable/1/historicalstatistics/1

Response:

...

languagehtml/xml

...

int
rt_RegistrarIDstring