OperatorAPI pro:list

newadmapi (Operator API) function. Available to: Operator, SuperRoot.

Description

Lists the upstream carriers. GLOBAL data: a carrier belongs to the platform, not to a tenant. Paginated. Sorting and searching are restricted to the declared fields; anything else is rejected and named. Read audience is provisional pending operator confirmation.

Call

GET|POST https://YOUR_HOST:9089/newadm?func=pro:list

Send your API key with every request (header X-API-Key: YOUR_KEY, or Authorization: Bearer YOUR_KEY, or the ukey query parameter).

Parameters

None beyond the API key and func=pro:list.

Example

https://host:port/newadm?func=pro:list

Response

Success is {"ok":true,"data":{...}}; on refusal {"ok":false,"code":"...","message":"..."}. This function's data shape: {"ok":true,"data":{"rows":[{"id":n,"provider":s,"proxy_uri1":s,"proxy_uri2":s,"route":n}],"page":n,"pagesize":n,"fields":[s],"available":[s],"order":s,"dir":s,"filterby":s?,"filter":s?}}.

Errors

Refusals carry a machine-readable code (branch on the code, never the message). See OperatorAPI#Error codes.

Back to OperatorAPI