---
title: "Retrieve current system status"
method: GET
path: "/admin/status"
tags: ["Administration"]
---

# Retrieve current system status

`GET /admin/status`

## Request

- Base URL: `https://HOSTNAME:8887/api`
- URL: `https://HOSTNAME:8887/api/admin/status`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/docs/admin/status/get.ts> (a function with typed inputs; its response is checked against the schema)

Get current status of system.

## Response `200`

OK

- object
  - `version` string: The version information of PortSIP PBX.
  - `news` string: The news information of PortSIP PBX.
  - `license_key` string: The license key of PortSIP PBX.
  - `license_type` string: The license type of product.
  - `maintenance_expires_at` string, date_time: The RFC 3339 format is defined by The date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), for example, 2017-07-21T17:32:28Z
  - `max_concurrent_calls` integer: The number of authorized concurrent calls purchased by the user.
  - `licensed_users` integer: The maximum number of authorized users purchased by the system admin.
  - `current_users` integer: The number of current users of the system.
  - `online_users` integer: The number of current online users of the system.
  - `current_tenants` integer: The number of current tenants of the system.
  - `current_dealers` integer: The number of current dealers of the system.
  - `current_calls` integer: The current number of calls.
  - `current_trunks` integer: The current number of trunks.
  - `current_conference_servers` integer: The current number of conference servers.
  - `current_media_servers` integer: The current number of media servers.
  - `current_call_queue_servers` integer: The current number of call queue servers.
  - `current_ivr_servers` integer: The current number of ivr servers.
  - `calls_in_24_hours` object[]
    - `time` string, date_time: The RFC 3339 format is defined by The date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), for example, 2017-07-21T17:32:28Z
    - `count` integer: The number of calls at this time.

## Other responses

- `4XX`: Error

---

[API](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api.md) - [All operations](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/revisions/577415d4a3d5?raw)
