Jump to content

TuCloudAPI getprofiles: Difference between revisions

From Wiki 7Kas
API docs (generated from func=help) — add #50 security profiles/ACL
 
TuCloudAPI reference: product name -> FuturePBX (API surface unchanged); regenerated from func=help
Line 1: Line 1:
''TuCloudAPI function to manage tucloud (PBX) services. Available to: '''SuperRoot, Operator, Client'''.''
''TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: '''SuperRoot, Operator, Client'''.''


== Description ==
== Description ==

Revision as of 14:14, 3 August 2026

TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.

Description

List this PBX's security profiles (Perfiles) with member counts.

Call

GET  https://tucloudapi.7kas.com:9087/tucloud?func=getprofiles&ukey=YOUR_KEY

Requires the ukey parameter.

Parameters

Parameter Type Required Default Meaning
pbx string Yes TuCloud PBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX and scopes every profile to it.
q string No Optional description search (contains).

Example

https://tucloudapi.7kas.com:9087/tucloud?func=getprofiles&ukey=KEY&pbx=tucall

Response

{ok, rows:[{_id,description,member_count}]}.


Back to TuCloudAPI