{ "info": { "name": "Interstellio Subscriber", "_postman_id": "af871e9e-358f-4803-892e-c13c702ba21a", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "API collection for the NebularStack Subscriber service." }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Auth-Token", "type": "string" }, { "key": "value", "value": "{{authToken}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Remove any header whose resolved value is empty.", "var toRemove = [];", "pm.request.headers.each(function (header) {", " var resolved = pm.variables.replaceIn(header.value || '');", " if (resolved.trim() === '') {", " toRemove.push(header.key);", " }", "});", "toRemove.forEach(function (key) {", " pm.request.headers.remove(key);", "});" ] } } ], "variable": [ { "key": "authToken", "value": "", "type": "string", "description": "API key (JWT) sent as the X-Auth-Token header on every authenticated request. Create and manage keys from the console at https://console.interstellio.io, or via the Identity API. See the authentication guide: https://docs.interstellio.io/nebularstack/api_guide/auth." }, { "key": "region", "value": "za", "type": "string", "description": "Service region. Available: za." }, { "key": "domain", "value": "", "type": "string", "description": "Entity domain context sent as the X-Domain header. Leave empty to use the domain your API key belongs to. See regions, domains and tenants: https://docs.interstellio.io/nebularstack/users#regions-domains-and-tenants." }, { "key": "tenantId", "value": "", "type": "string", "description": "Tenant context sent as the X-Tenant-ID header. Leave empty when not operating on a specific tenant. When set, you must also set domain (X-Domain), even if it is your default domain, because a tenant is scoped to a domain. See regions, domains and tenants: https://docs.interstellio.io/nebularstack/users#regions-domains-and-tenants." }, { "key": "timezone", "value": "UTC", "type": "string", "description": "IANA timezone name sent as the X-Timezone header. Response datetimes are formatted as ISO 8601 in this timezone; defaults to UTC. See timezone support: https://docs.interstellio.io/nebularstack/api_guide/timezones." }, { "key": "subscriberUrl", "value": "https://subscriber-{{region}}.interstellio.io", "type": "string" }, { "key": "telemetryUrl", "value": "https://telemetry-{{region}}.interstellio.io", "type": "string" } ], "item": [ { "name": "Subscriber Accounts", "item": [ { "name": "List Subscriber Accounts", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/subscribers", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "subscribers" ], "query": [ { "key": "p", "value": "", "description": "Paginate Current Page. (default 1)", "disabled": true }, { "key": "l", "value": "", "description": "Paginate Limit / Entities per Page. (1-50, 0 for infinite, -1 for streaming)", "disabled": true }, { "key": "id", "value": "", "description": "Filter by id. (can suffix with wildcard *)", "disabled": true }, { "key": "username", "value": "", "description": "Filter by username. (can suffix with wildcard *)", "disabled": true }, { "key": "calling_station_id", "value": "", "description": "Filter by calling_station_id. (can suffix with wildcard *)", "disabled": true }, { "key": "sc", "value": "", "description": "Sort by Property/Column. (id, username, calling_station_id)", "disabled": true }, { "key": "sd", "value": "", "description": "Sort direction. asc for Ascending or desc for Descending", "disabled": true } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Customer, Network Operations, Staff Member, Subscriber Accounts, Subscriber Administrator, Subscriber Support, Subscriber Telemetry, Subscriber View, Support\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Tenant-ID", "value": "{{tenantId}}", "description": "Request Tenant Context. (requires X-Domain of the tenant)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": \"0001d2f0-61c7-4ab8-b4db-21118b886711\",\n \"virtual_id\": \"465be807-54f1-4bf6-b940-398ed95cdbe7\",\n \"service_id\": \"dee171f4-34a7-401b-bdef-9cd2ca6a9e8f\",\n \"profile_id\": \"bf22fc11-c0e5-4732-b8ef-58d6b319a08a\",\n \"pool_id\": null,\n \"domain\": \"example.com\",\n \"tenant_id\": null,\n \"name\": \"TEST Account\",\n \"username\": \"test@example.com\",\n \"calling_station_id\": \"\",\n \"static_ip4\": null,\n \"last_known_nas_name\": null,\n \"last_known_nas_ip4\": null,\n \"enabled\": true,\n \"creation_time\": \"2021-06-23T07:57:21.000Z\",\n \"updated_time\": \"2024-08-23T12:10:52.000Z\",\n \"expire\": \"2024-09-24T07:54:00.000Z\",\n \"purge_at\": null,\n \"timezone\": \"Africa/Johannesburg\",\n \"last_seen\": \"2021-07-05T06:57:43.000Z\",\n \"inactive_purge\": null,\n \"purge_if_seen\": false,\n \"locked_tags\": \"\",\n \"service\": \"BROADBAND PPPOE\",\n \"virtual\": \"BROADBAND AAA\",\n \"profile\": \"15 Mbps Uncapped\",\n \"uncapped_data\": true\n }\n ],\n \"metadata\": {\n \"records\": 1,\n \"page\": 1,\n \"pages\": 1,\n \"per_page\": 10\n }\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Create Subscriber Account", "request": { "method": "POST", "url": { "raw": "{{subscriberUrl}}/v1/subscriber", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "subscriber" ] }, "description": "## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Tenant-ID", "value": "{{tenantId}}", "description": "Request Tenant Context. (requires X-Domain of the tenant)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"virtual_id\": \"465be807-54f1-4bf6-b940-398ed95cdbe7\",\n \"service_id\": \"dee171f4-34a7-401b-bdef-9cd2ca6a9e8f\",\n \"profile_id\": \"bf22fc11-c0e5-4732-b8ef-58d6b319a08a\",\n \"name\": \"TEST Account\",\n \"username\": \"test@example.com\",\n \"enabled\": true,\n \"timezone\": \"Africa/Johannesburg\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"0001d2f0-61c7-4ab8-b4db-21118b886711\",\n \"virtual_id\": \"465be807-54f1-4bf6-b940-398ed95cdbe7\",\n \"service_id\": \"dee171f4-34a7-401b-bdef-9cd2ca6a9e8f\",\n \"profile_id\": \"bf22fc11-c0e5-4732-b8ef-58d6b319a08a\",\n \"pool_id\": null,\n \"domain\": \"example.com\",\n \"tenant_id\": null,\n \"name\": \"TEST Account\",\n \"username\": \"test@example.com\",\n \"calling_station_id\": \"\",\n \"static_ip4\": null,\n \"last_known_nas_name\": null,\n \"last_known_nas_ip4\": null,\n \"enabled\": true,\n \"creation_time\": \"2021-06-23T07:57:21.000Z\",\n \"updated_time\": \"2024-08-23T12:10:52.000Z\",\n \"expire\": \"2024-09-24T07:54:00.000Z\",\n \"purge_at\": null,\n \"timezone\": \"Africa/Johannesburg\",\n \"last_seen\": \"2021-07-05T06:57:43.000Z\",\n \"inactive_purge\": null,\n \"purge_if_seen\": false,\n \"locked_tags\": \"\",\n \"service\": \"BROADBAND PPPOE\",\n \"virtual\": \"BROADBAND AAA\",\n \"profile\": \"15 Mbps Uncapped\",\n \"uncapped_data\": true\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Get Subscriber Account", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/subscriber/:subscriber_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "subscriber", ":subscriber_id" ], "variable": [ { "key": "subscriber_id", "value": "", "description": "Subscriber Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Customer, Network Operations, Staff Member, Subscriber Accounts, Subscriber Administrator, Subscriber Support, Subscriber Telemetry, Subscriber View, Support\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Tenant-ID", "value": "{{tenantId}}", "description": "Request Tenant Context. (requires X-Domain of the tenant)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"0001d2f0-61c7-4ab8-b4db-21118b886711\",\n \"virtual_id\": \"465be807-54f1-4bf6-b940-398ed95cdbe7\",\n \"service_id\": \"dee171f4-34a7-401b-bdef-9cd2ca6a9e8f\",\n \"profile_id\": \"bf22fc11-c0e5-4732-b8ef-58d6b319a08a\",\n \"pool_id\": null,\n \"domain\": \"example.com\",\n \"tenant_id\": null,\n \"name\": \"TEST Account\",\n \"username\": \"test@example.com\",\n \"calling_station_id\": \"\",\n \"static_ip4\": null,\n \"last_known_nas_name\": null,\n \"last_known_nas_ip4\": null,\n \"enabled\": true,\n \"creation_time\": \"2021-06-23T07:57:21.000Z\",\n \"updated_time\": \"2024-08-23T12:10:52.000Z\",\n \"expire\": \"2024-09-24T07:54:00.000Z\",\n \"purge_at\": null,\n \"timezone\": \"Africa/Johannesburg\",\n \"last_seen\": \"2021-07-05T06:57:43.000Z\",\n \"inactive_purge\": null,\n \"purge_if_seen\": false,\n \"locked_tags\": \"\",\n \"service\": \"BROADBAND PPPOE\",\n \"virtual\": \"BROADBAND AAA\",\n \"profile\": \"15 Mbps Uncapped\",\n \"uncapped_data\": true\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Update Subscriber Account", "request": { "method": "PATCH", "url": { "raw": "{{subscriberUrl}}/v1/subscriber/:subscriber_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "subscriber", ":subscriber_id" ], "variable": [ { "key": "subscriber_id", "value": "", "description": "Subscriber Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Accounts, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Tenant-ID", "value": "{{tenantId}}", "description": "Request Tenant Context. (requires X-Domain of the tenant)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"virtual_id\": \"465be807-54f1-4bf6-b940-398ed95cdbe7\",\n \"service_id\": \"dee171f4-34a7-401b-bdef-9cd2ca6a9e8f\",\n \"profile_id\": \"bf22fc11-c0e5-4732-b8ef-58d6b319a08a\",\n \"name\": \"TEST Account\",\n \"username\": \"test@example.com\",\n \"enabled\": true,\n \"timezone\": \"Africa/Johannesburg\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"0001d2f0-61c7-4ab8-b4db-21118b886711\",\n \"virtual_id\": \"465be807-54f1-4bf6-b940-398ed95cdbe7\",\n \"service_id\": \"dee171f4-34a7-401b-bdef-9cd2ca6a9e8f\",\n \"profile_id\": \"bf22fc11-c0e5-4732-b8ef-58d6b319a08a\",\n \"pool_id\": null,\n \"domain\": \"example.com\",\n \"tenant_id\": null,\n \"name\": \"TEST Account\",\n \"username\": \"test@example.com\",\n \"calling_station_id\": \"\",\n \"static_ip4\": null,\n \"last_known_nas_name\": null,\n \"last_known_nas_ip4\": null,\n \"enabled\": true,\n \"creation_time\": \"2021-06-23T07:57:21.000Z\",\n \"updated_time\": \"2024-08-23T12:10:52.000Z\",\n \"expire\": \"2024-09-24T07:54:00.000Z\",\n \"purge_at\": null,\n \"timezone\": \"Africa/Johannesburg\",\n \"last_seen\": \"2021-07-05T06:57:43.000Z\",\n \"inactive_purge\": null,\n \"purge_if_seen\": false,\n \"locked_tags\": \"\",\n \"service\": \"BROADBAND PPPOE\",\n \"virtual\": \"BROADBAND AAA\",\n \"profile\": \"15 Mbps Uncapped\",\n \"uncapped_data\": true\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Purge Subscriber Account", "request": { "method": "DELETE", "url": { "raw": "{{subscriberUrl}}/v1/subscriber/:subscriber_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "subscriber", ":subscriber_id" ], "variable": [ { "key": "subscriber_id", "value": "", "description": "Unique Subscriber Account ID." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Accounts, Subscriber Administrator\n\n## Status Codes\n\n- **204** OK - No Content\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Tenant-ID", "value": "{{tenantId}}", "description": "Request Tenant Context. (requires X-Domain of the tenant)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] } }, { "name": "Subscriber Account Status", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v2/subscriber/status/:subscriber_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v2", "subscriber", "status", ":subscriber_id" ], "variable": [ { "key": "subscriber_id", "value": "", "description": "Subscriber Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Customer, Network Operations, Staff Member, Subscriber Accounts, Subscriber Administrator, Subscriber Support, Subscriber Telemetry, Subscriber View, Support\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Tenant-ID", "value": "{{tenantId}}", "description": "Request Tenant Context. (requires X-Domain of the tenant)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"active\": false,\n \"messages\": [\n \"Account credits depleted\"\n ],\n \"upload\": \"150.000\",\n \"download\": \"150.000\"\n}", "_postman_previewlanguage": "json" } ] } ] }, { "name": "Aliases", "item": [ { "name": "List Aliases for a subscriber", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/aliases/:subscriber_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "aliases", ":subscriber_id" ], "query": [ { "key": "page", "value": "", "description": "Page Number (default 1)", "disabled": true } ], "variable": [ { "key": "subscriber_id", "value": "", "description": "ID of the subscriber the alias of which are to be fetched" } ] }, "description": "## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": \"1692bdca-ca46-11ee-b962-ddbef08e6d9d\",\n \"subscriber_id\": \"2c621ccc-c9dd-11ee-b885-ddbef08e6d9d\",\n \"alias\": \"alias1\",\n \"inactive_purge\": 5,\n \"purge_if_seen\": false,\n \"last_seen\": null,\n \"creation_time\": \"2024-02-13T08:01:27+00:00\"\n },\n {\n \"id\": \"1ce92dda-ca46-11ee-b962-ddbef08e6d9d\",\n \"subscriber_id\": \"2c621ccc-c9dd-11ee-b885-ddbef08e6d9d\",\n \"alias\": \"alias2\",\n \"inactive_purge\": 8,\n \"purge_if_seen\": false,\n \"last_seen\": null,\n \"creation_time\": \"2024-02-13T08:01:37+00:00\"\n },\n {\n \"id\": \"230299c2-ca46-11ee-b962-ddbef08e6d9d\",\n \"subscriber_id\": \"2c621ccc-c9dd-11ee-b885-ddbef08e6d9d\",\n \"alias\": \"alias3\",\n \"inactive_purge\": 1,\n \"purge_if_seen\": true,\n \"last_seen\": null,\n \"creation_time\": \"2024-02-13T08:01:47+00:00\"\n }\n ],\n \"metadata\": {\n \"records\": 3,\n \"page\": 1,\n \"pages\": 10,\n \"per_page\": 10\n }\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Add Alias for a subscriber", "request": { "method": "POST", "url": { "raw": "{{subscriberUrl}}/v1/alias/:subscriber_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "alias", ":subscriber_id" ], "variable": [ { "key": "subscriber_id", "value": "", "description": "ID of the subscriber the alias will be created" } ] }, "description": "## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"alias\": \"alias_TEST\",\n \"inactive_purge\": 1,\n \"purge_if_seen\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"7dcf542c-ca4a-11ee-b962-ddbef08e6d9d\",\n \"subscriber_id\": \"2c621ccc-c9dd-11ee-b885-ddbef08e6d9d\",\n \"alias\": \"alias_TEST\",\n \"inactive_purge\": 1,\n \"purge_if_seen\": true,\n \"last_seen\": null,\n \"creation_time\": \"2024-02-13T08:32:58+00:00\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Get Alias by ID", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/alias/:alias_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "alias", ":alias_id" ], "variable": [ { "key": "alias_id", "value": "", "description": "ID of the alias that will be retrieved" } ] }, "description": "## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"7dcf542c-ca4a-11ee-b962-ddbef08e6d9d\",\n \"subscriber_id\": \"2c621ccc-c9dd-11ee-b885-ddbef08e6d9d\",\n \"alias\": \"alias_TEST\",\n \"inactive_purge\": 1,\n \"purge_if_seen\": true,\n \"last_seen\": null,\n \"creation_time\": \"2024-02-13T08:32:58+00:00\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Edit Alias by ID", "request": { "method": "PUT", "url": { "raw": "{{subscriberUrl}}/v1/alias/:alias_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "alias", ":alias_id" ], "variable": [ { "key": "alias_id", "value": "", "description": "ID of the alias will be updated" } ] }, "description": "## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"alias\": \"alias_UPDATED\",\n \"inactive_purge\": 1,\n \"purge_if_seen\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"7dcf542c-ca4a-11ee-b962-ddbef08e6d9d\",\n \"subscriber_id\": \"2c621ccc-c9dd-11ee-b885-ddbef08e6d9d\",\n \"alias\": \"alias_UPDATED\",\n \"inactive_purge\": 1,\n \"purge_if_seen\": true,\n \"last_seen\": null,\n \"creation_time\": \"2024-02-13T08:32:58+00:00\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Remove Alias by ID", "request": { "method": "DELETE", "url": { "raw": "{{subscriberUrl}}/v1/alias/:alias_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "alias", ":alias_id" ], "variable": [ { "key": "alias_id", "value": "", "description": "ID of the alias that will be removed" } ] }, "description": "## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"7dcf542c-ca4a-11ee-b962-ddbef08e6d9d\",\n \"subscriber_id\": \"2c621ccc-c9dd-11ee-b885-ddbef08e6d9d\",\n \"alias\": \"alias_TEST\",\n \"inactive_purge\": 1,\n \"purge_if_seen\": true,\n \"last_seen\": null,\n \"creation_time\": \"2024-02-13T08:32:58+00:00\"\n}", "_postman_previewlanguage": "json" } ] } ] }, { "name": "Boost", "item": [ { "name": "List Boost Entries", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/boosts/:subscriber_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "boosts", ":subscriber_id" ], "query": [ { "key": "p", "value": "", "description": "Paginate Current Page. (default 1)", "disabled": true }, { "key": "l", "value": "", "description": "Paginate Limit / Entities per Page. (1-50, -1 for streaming)", "disabled": true }, { "key": "boost_upload", "value": "", "description": "Filter by boost_upload.", "disabled": true }, { "key": "boost_download", "value": "", "description": "Filter by boost_download.", "disabled": true }, { "key": "sc", "value": "", "description": "Sort by Property/Column. (boost_upload, boost_download, boost_expire, creation_time)", "disabled": true }, { "key": "sd", "value": "", "description": "Sort direction. asc for Ascending or desc for Descending", "disabled": true } ], "variable": [ { "key": "subscriber_id", "value": "", "description": "Subscriber Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Customer, Network Operations, Staff Member, Subscriber Accounts, Subscriber Administrator, Subscriber Support, Subscriber Telemetry, Subscriber View, Support\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Tenant-ID", "value": "{{tenantId}}", "description": "Request Tenant Context. (requires X-Domain of the tenant)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": \"f387b478-669b-11ef-99a7-174adb24f2cd\",\n \"tenant_id\": \"0822b8a6-4f3f-4ca9-bde2-88bf84fb8ba0\",\n \"subscriber_id\": \"00034ae6-4d79-11ef-80c4-174adb24f2cd\",\n \"boost_upload\": 100,\n \"boost_download\": 100,\n \"boost_expire\": \"2024-08-31T22:00:00.000Z\",\n \"creation_time\": \"2024-08-30T06:49:06.000Z\"\n }\n ],\n \"metadata\": {\n \"records\": 1,\n \"page\": 1,\n \"pages\": 1,\n \"per_page\": 10\n }\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Create Boost Entry", "request": { "method": "POST", "url": { "raw": "{{subscriberUrl}}/v1/boost", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "boost" ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Accounts, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Tenant-ID", "value": "{{tenantId}}", "description": "Request Tenant Context. (requires X-Domain of the tenant)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"subscriber_id\": \"00034ae6-4d79-11ef-80c4-174adb24f2cd\",\n \"boost_upload\": 100,\n \"boost_download\": 100\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"f387b478-669b-11ef-99a7-174adb24f2cd\",\n \"tenant_id\": \"0822b8a6-4f3f-4ca9-bde2-88bf84fb8ba0\",\n \"subscriber_id\": \"00034ae6-4d79-11ef-80c4-174adb24f2cd\",\n \"boost_upload\": 100,\n \"boost_download\": 100,\n \"boost_expire\": \"2024-08-31T22:00:00.000Z\",\n \"creation_time\": \"2024-08-30T06:49:06.000Z\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Show Boost Entry", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/boost/:boost_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "boost", ":boost_id" ], "variable": [ { "key": "boost_id", "value": "", "description": "Boost Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Customer, Network Operations, Staff Member, Subscriber Accounts, Subscriber Administrator, Subscriber Support, Subscriber Telemetry, Subscriber View, Support\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Tenant-ID", "value": "{{tenantId}}", "description": "Request Tenant Context. (requires X-Domain of the tenant)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"f387b478-669b-11ef-99a7-174adb24f2cd\",\n \"tenant_id\": \"0822b8a6-4f3f-4ca9-bde2-88bf84fb8ba0\",\n \"subscriber_id\": \"00034ae6-4d79-11ef-80c4-174adb24f2cd\",\n \"boost_upload\": 100,\n \"boost_download\": 100,\n \"boost_expire\": \"2024-08-31T22:00:00.000Z\",\n \"creation_time\": \"2024-08-30T06:49:06.000Z\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Update Boost Entry", "request": { "method": "PATCH", "url": { "raw": "{{subscriberUrl}}/v1/boost/:boost_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "boost", ":boost_id" ], "variable": [ { "key": "boost_id", "value": "", "description": "Boost Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Accounts, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Tenant-ID", "value": "{{tenantId}}", "description": "Request Tenant Context. (requires X-Domain of the tenant)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"boost_upload\": 100,\n \"boost_download\": 100,\n \"boost_expire\": \"2024-08-31T22:00:00.000Z\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"f387b478-669b-11ef-99a7-174adb24f2cd\",\n \"tenant_id\": \"0822b8a6-4f3f-4ca9-bde2-88bf84fb8ba0\",\n \"subscriber_id\": \"00034ae6-4d79-11ef-80c4-174adb24f2cd\",\n \"boost_upload\": 100,\n \"boost_download\": 100,\n \"boost_expire\": \"2024-08-31T22:00:00.000Z\",\n \"creation_time\": \"2024-08-30T06:49:06.000Z\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Delete Boost Entry", "request": { "method": "DELETE", "url": { "raw": "{{subscriberUrl}}/v1/boost/:boost_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "boost", ":boost_id" ], "variable": [ { "key": "boost_id", "value": "", "description": "Boost Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Accounts, Subscriber Administrator\n\n## Status Codes\n\n- **204** OK - No Content\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Tenant-ID", "value": "{{tenantId}}", "description": "Request Tenant Context. (requires X-Domain of the tenant)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] } } ] }, { "name": "Client Profiles", "item": [ { "name": "List Client Profiles", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/client_profiles", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "client_profiles" ], "query": [ { "key": "p", "value": "", "description": "Paginate Current Page. (default 1)", "disabled": true }, { "key": "l", "value": "", "description": "Paginate Limit / Entities per Page. (1-50, 0 for infinite, -1 for streaming)", "disabled": true }, { "key": "id", "value": "", "description": "Filter by id. (can suffix with wildcard *)", "disabled": true }, { "key": "name", "value": "", "description": "Filter by name. (can suffix with wildcard *)", "disabled": true }, { "key": "sc", "value": "", "description": "Sort by Property/Column. (id, name)", "disabled": true }, { "key": "sd", "value": "", "description": "Sort direction. asc for Ascending or desc for Descending", "disabled": true } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": \"d3e14621-bac1-11ee-8769-525400bd8e3a\",\n \"domain\": \"interstellio.io\",\n \"name\": \"CISCO\",\n \"description\": \"CISCO\"\n },\n {\n \"id\": \"9bece11b-bc39-4672-bb8a-c94362a6b815\",\n \"domain\": \"interstellio.io\",\n \"name\": \"JUNIPER\",\n \"description\": \"JUNIPER\"\n }\n ],\n \"metadata\": {\n \"records\": 2,\n \"page\": 1,\n \"pages\": 1,\n \"per_page\": 10\n }\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Create Client Profile", "request": { "method": "POST", "url": { "raw": "{{subscriberUrl}}/v1/client_profile", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "client_profile" ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"MIKROTIK\",\n \"description\": \"MIKROTIK\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"9bece11b-bc39-4672-bb8a-c94362a6b815\",\n \"domain\": \"interstellio.io\",\n \"name\": \"MIKROTIK\",\n \"description\": \"MIKROTIK\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Show Client Profile Details", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/client_profile/:client_profile_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "client_profile", ":client_profile_id" ], "variable": [ { "key": "client_profile_id", "value": "", "description": "Client Profile Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"9bece11b-bc39-4672-bb8a-c94362a6b815\",\n \"domain\": \"interstellio.io\",\n \"name\": \"JUNIPER\",\n \"description\": \"JUNIPER\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Update Client Profile", "request": { "method": "PATCH", "url": { "raw": "{{subscriberUrl}}/v1/client_profile/:client_profile_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "client_profile", ":client_profile_id" ], "variable": [ { "key": "client_profile_id", "value": "", "description": "Client Profile Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"NEW_NAME\",\n \"description\": \"NEW DESCRIPTION\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"9bece11b-bc39-4672-bb8a-c94362a6b815\",\n \"domain\": \"interstellio.io\",\n \"name\": \"NEW_NAME\",\n \"description\": \"NEW DESCRIPTION\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Delete Client Profile", "request": { "method": "DELETE", "url": { "raw": "{{subscriberUrl}}/v1/client_profile/:client_profile_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "client_profile", ":client_profile_id" ], "variable": [ { "key": "client_profile_id", "value": "", "description": "Client Profile Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **204** OK - No Content\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] } } ] }, { "name": "Credits", "item": [ { "name": "List Credits for a subscriber", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/credits/:subscriber_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "credits", ":subscriber_id" ], "query": [ { "key": "p", "value": "", "description": "Paginate Current Page. (default 1)", "disabled": true }, { "key": "l", "value": "", "description": "Paginate Limit / Entities per Page. (1-50, -1 for streaming)", "disabled": true }, { "key": "id", "value": "", "description": "Filter by id. (can suffix with wildcard *)", "disabled": true }, { "key": "name", "value": "", "description": "Filter by name. (can suffix with wildcard *)", "disabled": true }, { "key": "volume_gb", "value": "", "description": "Filter by volume_gb.", "disabled": true }, { "key": "external_id", "value": "", "description": "Filter by external_id. (can suffix with wildcard *)", "disabled": true }, { "key": "group_id", "value": "", "description": "Filter by group_id. (can suffix with wildcard *)", "disabled": true }, { "key": "rolled_over", "value": "", "description": "Filter by rolled_over.", "disabled": true }, { "key": "sc", "value": "", "description": "Sort by Property/Column. (expire, volume_expire)", "disabled": true }, { "key": "sd", "value": "", "description": "Sort direction. asc for Ascending or desc for Descending", "disabled": true } ], "variable": [ { "key": "subscriber_id", "value": "", "description": "Subscriber Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Customer, Network Operations, Staff Member, Subscriber Accounts, Subscriber Administrator, Subscriber Support, Subscriber Telemetry, Subscriber View, Support\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Tenant-ID", "value": "{{tenantId}}", "description": "Request Tenant Context. (requires X-Domain of the tenant)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": \"4ed4495c-cbe9-11ee-9127-a5b2efd1bd16\",\n \"credit_profile_id\": \"64ea15cd-e432-4a98-bcf3-511a00182945\",\n \"subscriber_id\": \"2c621ccc-c9dd-11ee-b885-ddbef08e6d9d\",\n \"volume_gb\": 123,\n \"name\": \"TOPUP Anytime\",\n \"start_hour\": \"00:00\",\n \"end_hour\": \"23:59\",\n \"expire\": null,\n \"volume_expire\": \"2024-04-15T10:02:20+00:00\",\n \"username\": \"test@example.com\",\n \"used_bytes\": 0,\n \"used_gb\": 0.0,\n \"left_over_gb\": 123.0,\n \"credit_profile\": \"123GB TOPUP Anytime\"\n }\n ],\n \"metadata\": {\n \"records\": 1,\n \"page\": 1,\n \"pages\": 1,\n \"per_page\": 10\n }\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Add credit to subscriber", "request": { "method": "POST", "url": { "raw": "{{subscriberUrl}}/v1/credit", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "credit" ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Accounts, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Tenant-ID", "value": "{{tenantId}}", "description": "Request Tenant Context. (requires X-Domain of the tenant)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"credit_profile_id\": \"64ea15cd-e432-4a98-bcf3-511a00182945\",\n \"subscriber_id\": \"2c621ccc-c9dd-11ee-b885-ddbef08e6d9d\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"4ed4495c-cbe9-11ee-9127-a5b2efd1bd16\",\n \"credit_profile_id\": \"64ea15cd-e432-4a98-bcf3-511a00182945\",\n \"subscriber_id\": \"2c621ccc-c9dd-11ee-b885-ddbef08e6d9d\",\n \"volume_gb\": 123,\n \"name\": \"TOPUP Anytime\",\n \"start_hour\": \"00:00\",\n \"end_hour\": \"23:59\",\n \"expire\": null,\n \"volume_expire\": \"2024-04-15T10:02:20+00:00\",\n \"username\": \"test@example.com\",\n \"used_bytes\": 0,\n \"used_gb\": 0.0,\n \"left_over_gb\": 123.0,\n \"credit_profile\": \"123GB TOPUP Anytime\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Show subscriber credit by ID", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/credit/:subscriber_credit_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "credit", ":subscriber_credit_id" ], "variable": [ { "key": "subscriber_credit_id", "value": "", "description": "Subscriber Credit Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Customer, Network Operations, Staff Member, Subscriber Accounts, Subscriber Administrator, Subscriber Support, Subscriber Telemetry, Subscriber View, Support\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Tenant-ID", "value": "{{tenantId}}", "description": "Request Tenant Context. (requires X-Domain of the tenant)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"4ed4495c-cbe9-11ee-9127-a5b2efd1bd16\",\n \"credit_profile_id\": \"64ea15cd-e432-4a98-bcf3-511a00182945\",\n \"subscriber_id\": \"2c621ccc-c9dd-11ee-b885-ddbef08e6d9d\",\n \"volume_gb\": 123,\n \"name\": \"TOPUP Daytime\",\n \"start_hour\": \"00:00\",\n \"end_hour\": \"23:59\",\n \"expire\": null,\n \"volume_expire\": \"2024-04-15T10:02:20+00:00\",\n \"username\": \"test7000\",\n \"used_bytes\": 0,\n \"used_gb\": 0.0,\n \"left_over_gb\": 123.0,\n \"credit_profile\": \"123GB TOPUP Daytime\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Remove subscriber credit by ID", "request": { "method": "DELETE", "url": { "raw": "{{subscriberUrl}}/v1/credit/:subscriber_credit_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "credit", ":subscriber_credit_id" ], "variable": [ { "key": "subscriber_credit_id", "value": "", "description": "Subscriber Credit Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Accounts, Subscriber Administrator\n\n## Status Codes\n\n- **204** OK - No Content\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Tenant-ID", "value": "{{tenantId}}", "description": "Request Tenant Context. (requires X-Domain of the tenant)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] } }, { "name": "List Credit Names", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/credit/names", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "credit", "names" ], "query": [ { "key": "p", "value": "", "description": "Paginate Current Page. (default 1)", "disabled": true }, { "key": "l", "value": "", "description": "Paginate Limit / Entities per Page. (1-50, -1 for streaming)", "disabled": true }, { "key": "name", "value": "", "description": "Filter by name. (can suffix with wildcard *)", "disabled": true }, { "key": "sc", "value": "", "description": "Sort by Property/Column. (name)", "disabled": true }, { "key": "sd", "value": "", "description": "Sort direction. asc for Ascending or desc for Descending", "disabled": true } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": \"95ca692a-9ecb-4f72-b375-8024e4314d97\",\n \"name\": \"ANYTIME DATA\"\n },\n {\n \"id\": \"802adac9-4d4b-4f0e-ab95-73d8d80b7d35\",\n \"name\": \"MONTHLY ANYTIME\"\n },\n {\n \"id\": \"76a02416-bb5d-11ee-8769-525400bd8e3a\",\n \"name\": \"Monthly Daytime\"\n },\n {\n \"id\": \"9690e530-bb5c-11ee-8769-525400bd8e3a\",\n \"name\": \"TOPUP Anytime\"\n },\n {\n \"id\": \"1d00f8f3-bb5e-11ee-8769-525400bd8e3a\",\n \"name\": \"TOPUP Daytime\"\n }\n ],\n \"metadata\": {\n \"records\": 5,\n \"page\": 1,\n \"pages\": 1,\n \"per_page\": 10\n }\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Add credit name", "request": { "method": "POST", "url": { "raw": "{{subscriberUrl}}/v1/credit/name", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "credit", "name" ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"TOPUP Anytime\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"9690e530-bb5c-11ee-8769-525400bd8e3a\",\n \"name\": \"TOPUP Anytime\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Get credit name by ID", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/credit/name/:credit_group_name_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "credit", "name", ":credit_group_name_id" ], "variable": [ { "key": "credit_group_name_id", "value": "", "description": "Credit Group Name Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"9690e530-bb5c-11ee-8769-525400bd8e3a\",\n \"name\": \"TOPUP Anytime\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Update credit group name by ID", "request": { "method": "PATCH", "url": { "raw": "{{subscriberUrl}}/v1/credit/name/:credit_group_name_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "credit", "name", ":credit_group_name_id" ], "variable": [ { "key": "credit_group_name_id", "value": "", "description": "Credit Group Name Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"TOPUP Anytime\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"9690e530-bb5c-11ee-8769-525400bd8e3a\",\n \"name\": \"TOPUP Anytime\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Remove credit group name by ID", "request": { "method": "DELETE", "url": { "raw": "{{subscriberUrl}}/v1/credit/name/:credit_group_name_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "credit", "name", ":credit_group_name_id" ], "variable": [ { "key": "credit_group_name_id", "value": "", "description": "Credit Group Name Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **204** OK - No Content\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] } }, { "name": "List Credit Profiles", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/credit/profiles", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "credit", "profiles" ], "query": [ { "key": "p", "value": "", "description": "Paginate Current Page. (default 1)", "disabled": true }, { "key": "l", "value": "", "description": "Paginate Limit / Entities per Page. (1-50, -1 for streaming)", "disabled": true }, { "key": "id", "value": "", "description": "Filter by id. (can suffix with wildcard *)", "disabled": true }, { "key": "name", "value": "", "description": "Filter by name. (can suffix with wildcard *)", "disabled": true }, { "key": "volume_gb", "value": "", "description": "Filter by volume_gb. (can suffix with wildcard *)", "disabled": true }, { "key": "credit_name", "value": "", "description": "Filter by credit_name. (can suffix with wildcard *)", "disabled": true }, { "key": "sc", "value": "", "description": "Sort by Property/Column. (id, name, volume_gb, credit_name)", "disabled": true }, { "key": "sd", "value": "", "description": "Sort direction. asc for Ascending or desc for Descending", "disabled": true } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": \"7a68ba0f-0782-483b-bf39-93955b2e4852\",\n \"name\": \"123GB Monthly Anytime\",\n \"credit_name\": \"Monthly Anytime\",\n \"start_hour\": \"00:00\",\n \"end_hour\": \"23:59\",\n \"volume_gb\": 123,\n \"volume_metric\": \"months\",\n \"volume_span\": 2,\n \"renew_metric\": \"1st-of-month\",\n \"renew_span\": 1\n }\n ],\n \"metadata\": {\n \"records\": 1,\n \"page\": 1,\n \"pages\": 1,\n \"per_page\": 10\n }\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Add credit profile", "request": { "method": "POST", "url": { "raw": "{{subscriberUrl}}/v1/credit/profile", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "credit", "profile" ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"123GB Monthly Anytime\",\n \"credit_name\": \"Monthly Anytime\",\n \"start_hour\": \"00:00\",\n \"end_hour\": \"23:59\",\n \"volume_gb\": 123,\n \"volume_metric\": \"months\",\n \"volume_span\": 2,\n \"renew_metric\": \"1st-of-month\",\n \"renew_span\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"7a68ba0f-0782-483b-bf39-93955b2e4852\",\n \"name\": \"123GB Monthly Anytime\",\n \"credit_name\": \"Monthly Anytime\",\n \"start_hour\": \"00:00\",\n \"end_hour\": \"23:59\",\n \"volume_gb\": 123,\n \"volume_metric\": \"months\",\n \"volume_span\": 2,\n \"renew_metric\": \"1st-of-month\",\n \"renew_span\": 1\n}", "_postman_previewlanguage": "json" } ] }, { "name": "View credit profile by ID", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/credit/profile/:credit_profile_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "credit", "profile", ":credit_profile_id" ], "variable": [ { "key": "credit_profile_id", "value": "", "description": "Credit Profile Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"7a68ba0f-0782-483b-bf39-93955b2e4852\",\n \"name\": \"123GB Monthly Anytime\",\n \"credit_name\": \"Monthly Anytime\",\n \"start_hour\": \"00:00\",\n \"end_hour\": \"23:59\",\n \"volume_gb\": 123,\n \"volume_metric\": \"months\",\n \"volume_span\": 2,\n \"renew_metric\": \"1st-of-month\",\n \"renew_span\": 1\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Update credit profile by ID", "request": { "method": "PATCH", "url": { "raw": "{{subscriberUrl}}/v1/credit/profile/:credit_profile_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "credit", "profile", ":credit_profile_id" ], "variable": [ { "key": "credit_profile_id", "value": "", "description": "Credit Profile Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"credit_name\": \"Monthly Daytime\",\n \"volume_gb\": 123,\n \"start_hour\": \"06:00\",\n \"end_hour\": \"17:00\",\n \"volume_metric\": \"months\",\n \"volume_span\": 2,\n \"renew_metric\": \"1st-of-month\",\n \"renew_span\": 1\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"7a68ba0f-0782-483b-bf39-93955b2e4852\",\n \"credit_name\": \"Monthly Daytime\",\n \"volume_gb\": 123,\n \"start_hour\": \"06:00\",\n \"end_hour\": \"17:00\",\n \"volume_metric\": \"months\",\n \"volume_span\": 2,\n \"renew_metric\": \"1st-of-month\",\n \"renew_span\": 1\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Remove credit profile by ID", "request": { "method": "DELETE", "url": { "raw": "{{subscriberUrl}}/v1/credit/profile/:credit_profile_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "credit", "profile", ":credit_profile_id" ], "variable": [ { "key": "credit_profile_id", "value": "", "description": "Credit Profile Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **204** OK - No Content\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] } } ] }, { "name": "IP Pools", "item": [ { "name": "List IP Pools", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/pool", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "pool" ], "query": [ { "key": "page", "value": "", "description": "Page Number (default 1)", "disabled": true } ] }, "description": "## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"links\": {},\n \"payload\": [\n {\n \"id\": \"280f16cd-4bf2-45cf-8761-0f39b0262dc3\",\n \"pool_name\": \"TEST\",\n \"status\": \"Ready\",\n \"total\": 65536,\n \"used\": 0\n },\n {\n \"id\": \"4b2e21f7-4403-453f-b91b-430f353f1f23\",\n \"pool_name\": \"TEST POOL\",\n \"status\": \"Ready\",\n \"total\": 0,\n \"used\": 0\n }\n ],\n \"metadata\": {\n \"records\": 2,\n \"page\": 1,\n \"pages\": 1,\n \"per_page\": 10,\n \"sort\": null,\n \"search\": [],\n \"filters\": []\n }\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Create IP Pool", "request": { "method": "POST", "url": { "raw": "{{subscriberUrl}}/v1/pool", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "pool" ], "query": [ { "key": "page", "value": "", "description": "Page Number (default 1)", "disabled": true } ] }, "description": "## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"pool_name\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"8a101dff-e497-4930-9464-462f77d24c09\",\n \"domain\": \"interstellio.io\",\n \"pool_name\": \"API TEST POOL\",\n \"status\": \"Ready\",\n \"busy\": false\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Get one IP Pool", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/pool/:pool_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "pool", ":pool_id" ], "query": [ { "key": "page", "value": "", "description": "Page Number (default 1)", "disabled": true } ], "variable": [ { "key": "pool_id", "value": "", "description": "Pool Id." } ] }, "description": "## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"4b2e21f7-4403-453f-b91b-430f353f1f23\",\n \"domain\": \"interstellio.io\",\n \"pool_name\": \"TEST POOL\",\n \"status\": \"Ready\",\n \"busy\": false\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Update IP Pool", "request": { "method": "PATCH", "url": { "raw": "{{subscriberUrl}}/v1/pool/:pool_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "pool", ":pool_id" ], "variable": [ { "key": "pool_id", "value": "", "description": "Pool ID" } ] }, "description": "## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"8a101dff-e497-4930-9464-462f77d24c09\",\n \"domain\": \"interstellio.io\",\n \"pool_name\": \"API TEST POOL UPDATE\",\n \"status\": \"Ready\",\n \"busy\": false\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Delete IP Pool", "request": { "method": "DELETE", "url": { "raw": "{{subscriberUrl}}/v1/pool/:pool_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "pool", ":pool_id" ], "variable": [ { "key": "pool_id", "value": "", "description": "Pool ID" } ] }, "description": "## Status Codes\n\n- **204** OK - No Content\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] } }, { "name": "Get IPs for a pool", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/pool/:pool_id/ips", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "pool", ":pool_id", "ips" ], "query": [ { "key": "page", "value": "", "description": "Page Number (default 1)", "disabled": true } ], "variable": [ { "key": "pool_id", "value": "", "description": "Pool ID" } ] }, "description": "## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"links\": {},\n \"payload\": [\n {\n \"id\": \"ca96f114-6835-11ee-9e95-0052af111173\",\n \"pool_id\": \"280f16cd-4bf2-45cf-8761-0f39b0262dc3\",\n \"prefix\": \"192.168.0.0/16\",\n \"total\": 65536\n }\n ],\n \"metadata\": {\n \"records\": 1,\n \"page\": 1,\n \"pages\": 1,\n \"per_page\": 10,\n \"sort\": null,\n \"search\": [],\n \"filters\": []\n }\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Add Prefix", "request": { "method": "POST", "url": { "raw": "{{subscriberUrl}}/v1/pool/:pool_id/add_prefix", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "pool", ":pool_id", "add_prefix" ], "variable": [ { "key": "pool_id", "value": "", "description": "Pool Id." } ] }, "description": "## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Remove prefix", "request": { "method": "DELETE", "url": { "raw": "{{subscriberUrl}}/v1/pool/:pool_id/rm_prefix/:prefix_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "pool", ":pool_id", "rm_prefix", ":prefix_id" ], "query": [ { "key": "page", "value": "", "description": "Page Number (default 1)", "disabled": true } ], "variable": [ { "key": "pool_id", "value": "", "description": "Pool Id." }, { "key": "prefix_id", "value": "", "description": "Prefix Id." } ] }, "description": "## Status Codes\n\n- **204** OK - No Content\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] } }, { "name": "Resync IP Pool", "request": { "method": "DELETE", "url": { "raw": "{{subscriberUrl}}/v1/pool/:pool_id/resync", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "pool", ":pool_id", "resync" ], "variable": [ { "key": "pool_id", "value": "", "description": "Pool Id." } ] }, "description": "## Status Codes\n\n- **204** OK - No Content\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] } } ] }, { "name": "Subscriber Profiles", "item": [ { "name": "List Radius Profiles", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/profiles", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "profiles" ], "query": [ { "key": "p", "value": "", "description": "Paginate Current Page. (default 1)", "disabled": true }, { "key": "l", "value": "", "description": "Paginate Limit / Entities per Page. (1-50, -1 for streaming)", "disabled": true }, { "key": "id", "value": "", "description": "Filter by id. (can suffix with wildcard *)", "disabled": true }, { "key": "name", "value": "", "description": "Filter by name. (can suffix with wildcard *)", "disabled": true }, { "key": "sc", "value": "", "description": "Sort by Property/Column. (id, name)", "disabled": true }, { "key": "sd", "value": "", "description": "Sort direction. asc for Ascending or desc for Descending", "disabled": true } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": \"03a0a715-b93a-49b1-9ad6-f9f03053e070\",\n \"name\": \"25Mbit/s Uncapped\"\n },\n {\n \"id\": \"05a2968d-958b-47ef-880f-9b01f0aabb6b\",\n \"name\": \"50Mbit/s Uncapped\"\n }\n ],\n \"metadata\": {\n \"records\": 2,\n \"page\": 1,\n \"pages\": 1\n }\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Create a profile", "request": { "method": "POST", "url": { "raw": "{{subscriberUrl}}/v1/profile", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "profile" ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"25 Mbps Uncapped Sync edit\",\n \"uncapped_data\": true,\n \"pool_id\": null,\n \"pool_id_deactivate\": null,\n \"upload\": \"25.000\",\n \"download\": \"25.000\",\n \"session_limit\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"11a0d490-e154-4687-ab79-62d3aa0cd7c3\",\n \"domain\": \"surf4life.co.za\",\n \"name\": \"25 Mbps Uncapped Sync edit\",\n \"uncapped_data\": true,\n \"pool_id\": null,\n \"pool_id_deactivate\": null,\n \"upload\": \"25.000\",\n \"download\": \"25.000\",\n \"session_limit\": 0,\n \"creation_time\": \"2023-06-13T14:45:04.000Z\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Show profile", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/profile/:profile_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "profile", ":profile_id" ], "variable": [ { "key": "profile_id", "value": "", "description": "Profile Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"11a0d490-e154-4687-ab79-62d3aa0cd7c3\",\n \"domain\": \"surf4life.co.za\",\n \"name\": \"25 Mbps Uncapped Sync edit\",\n \"uncapped_data\": true,\n \"pool_id\": null,\n \"pool_id_deactivate\": null,\n \"upload\": \"25.000\",\n \"download\": \"25.000\",\n \"session_limit\": 0,\n \"creation_time\": \"2023-06-13T14:45:04.000Z\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Update a profile", "request": { "method": "PATCH", "url": { "raw": "{{subscriberUrl}}/v1/profile/:profile_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "profile", ":profile_id" ], "variable": [ { "key": "profile_id", "value": "", "description": "Profile Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"25 Mbps Uncapped Sync edit\",\n \"upload\": \"25.000\",\n \"download\": \"25.000\",\n \"session_limit\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"11a0d490-e154-4687-ab79-62d3aa0cd7c3\",\n \"domain\": \"surf4life.co.za\",\n \"name\": \"25 Mbps Uncapped Sync edit\",\n \"uncapped_data\": true,\n \"pool_id\": null,\n \"pool_id_deactivate\": null,\n \"upload\": \"25.000\",\n \"download\": \"25.000\",\n \"session_limit\": 0,\n \"creation_time\": \"2023-06-13T14:45:04.000Z\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Delete a profile", "request": { "method": "DELETE", "url": { "raw": "{{subscriberUrl}}/v1/profile/:profile_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "profile", ":profile_id" ], "variable": [ { "key": "profile_id", "value": "", "description": "Profile Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **204** OK - No Content\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] } } ] }, { "name": "Routes", "item": [ { "name": "List Routes for a subscriber", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/routes/:subscriber_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "routes", ":subscriber_id" ], "query": [ { "key": "page", "value": "", "description": "Page Number (default 1)", "disabled": true } ], "variable": [ { "key": "subscriber_id", "value": "", "description": "ID of the subscriber from which the routes are to be fetched" } ] }, "description": "## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": \"0140714c-cb31-11ee-9127-a5b2efd1bd16\",\n \"subscriber_id\": \"2c621ccc-c9dd-11ee-b885-ddbef08e6d9d\",\n \"ip_prefix\": \"192.168.0.1/32\",\n \"ipv\": \"4\",\n \"metric1\": 1,\n \"metric2\": 1,\n \"metric3\": 1,\n \"pref\": 1,\n \"tag\": \"tag\"\n }\n ],\n \"metadata\": {\n \"records\": 1,\n \"page\": 1,\n \"pages\": 10,\n \"per_page\": 10\n }\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Add Route for a subscriber", "request": { "method": "POST", "url": { "raw": "{{subscriberUrl}}/v1/route/:subscriber_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "route", ":subscriber_id" ], "variable": [ { "key": "subscriber_id", "value": "", "description": "ID of the subscriber the route will be created" } ] }, "description": "## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"ip_prefix\": \"192.168.0.1/32\",\n \"ipv\": \"4\",\n \"metric1\": 1,\n \"metric2\": 1,\n \"metric3\": 1,\n \"pref\": 1,\n \"tag\": \"tag\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"0140714c-cb31-11ee-9127-a5b2efd1bd16\",\n \"subscriber_id\": \"2c621ccc-c9dd-11ee-b885-ddbef08e6d9d\",\n \"ip_prefix\": \"192.168.0.1/32\",\n \"ipv\": \"4\",\n \"metric1\": 1,\n \"metric2\": 1,\n \"metric3\": 1,\n \"pref\": 1,\n \"tag\": \"tag\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Get Route by ID", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/route/:route_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "route", ":route_id" ], "variable": [ { "key": "route_id", "value": "", "description": "ID of the route that will be retrieved" } ] }, "description": "## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"0140714c-cb31-11ee-9127-a5b2efd1bd16\",\n \"subscriber_id\": \"2c621ccc-c9dd-11ee-b885-ddbef08e6d9d\",\n \"ip_prefix\": \"192.168.0.1/32\",\n \"ipv\": \"4\",\n \"metric1\": 1,\n \"metric2\": 1,\n \"metric3\": 1,\n \"pref\": 1,\n \"tag\": \"tag\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Edit Route by ID", "request": { "method": "PUT", "url": { "raw": "{{subscriberUrl}}/v1/route/:route_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "route", ":route_id" ], "variable": [ { "key": "route_id", "value": "", "description": "ID of the route will be updated" } ] }, "description": "## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"ip_prefix\": \"192.168.0.1/32\",\n \"ipv\": \"4\",\n \"metric1\": 1,\n \"metric2\": 1,\n \"metric3\": 1,\n \"pref\": 1,\n \"tag\": \"tag\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"0140714c-cb31-11ee-9127-a5b2efd1bd16\",\n \"subscriber_id\": \"2c621ccc-c9dd-11ee-b885-ddbef08e6d9d\",\n \"ip_prefix\": \"192.168.0.1/32\",\n \"ipv\": \"4\",\n \"metric1\": 1,\n \"metric2\": 1,\n \"metric3\": 1,\n \"pref\": 1,\n \"tag\": \"tag\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Remove Route by ID", "request": { "method": "DELETE", "url": { "raw": "{{subscriberUrl}}/v1/route/:route_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "route", ":route_id" ], "variable": [ { "key": "route_id", "value": "", "description": "ID of the route that will be removed" } ] }, "description": "## Status Codes\n\n- **204** OK - No Content\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] } } ] }, { "name": "Services", "item": [ { "name": "List Services", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/services", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "services" ], "query": [ { "key": "p", "value": "", "description": "Paginate Current Page. (default 1)", "disabled": true }, { "key": "l", "value": "", "description": "Paginate Limit / Entities per Page. (1-50, -1 for streaming)", "disabled": true }, { "key": "id", "value": "", "description": "Filter by id. (can suffix with wildcard *)", "disabled": true }, { "key": "name", "value": "", "description": "Filter by name. (can suffix with wildcard *)", "disabled": true }, { "key": "sc", "value": "", "description": "Sort by Property/Column. (id, name)", "disabled": true }, { "key": "sd", "value": "", "description": "Sort direction. asc for Ascending or desc for Descending", "disabled": true } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": \"a13610c7-6ea3-4f3e-afb9-e422d530473a\",\n \"name\": \"BROADBAND PPPOE\"\n }\n ],\n \"metadata\": {\n \"records\": 1,\n \"page\": 1,\n \"pages\": 1,\n \"per_page\": 10\n }\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Create Service", "request": { "method": "POST", "url": { "raw": "{{subscriberUrl}}/v1/service", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "service" ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"BROADBAND PPPOE\",\n \"authentication\": \"username+password\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a13610c7-6ea3-4f3e-afb9-e422d530473a\",\n \"domain\": \"interstellio.io\",\n \"name\": \"BROADBAND PPPOE\",\n \"pool_id\": null,\n \"pool_id_deactivate\": null,\n \"authentication\": \"username+password\",\n \"creation_time\": \"2021-04-14T12:03:15.000Z\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Show Service", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/service/:service_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "service", ":service_id" ], "variable": [ { "key": "service_id", "value": "", "description": "Service Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a13610c7-6ea3-4f3e-afb9-e422d530473a\",\n \"domain\": \"interstellio.io\",\n \"name\": \"BROADBAND PPPOE\",\n \"pool_id\": null,\n \"pool_id_deactivate\": null,\n \"authentication\": \"username+password\",\n \"creation_time\": \"2021-04-14T12:03:15.000Z\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Update Service", "request": { "method": "PATCH", "url": { "raw": "{{subscriberUrl}}/v1/service/:service_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "service", ":service_id" ], "variable": [ { "key": "service_id", "value": "", "description": "Service Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"BROADBAND PPPOE\",\n \"authentication\": \"username+password\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"a13610c7-6ea3-4f3e-afb9-e422d530473a\",\n \"domain\": \"interstellio.io\",\n \"name\": \"BROADBAND PPPOE\",\n \"pool_id\": null,\n \"pool_id_deactivate\": null,\n \"authentication\": \"username+password\",\n \"creation_time\": \"2021-04-14T12:03:15.000Z\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Delete Service", "request": { "method": "DELETE", "url": { "raw": "{{subscriberUrl}}/v1/service/:service_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "service", ":service_id" ], "variable": [ { "key": "service_id", "value": "", "description": "Service Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **204** OK - No Content\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] } }, { "name": "List Radius Atrributes", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/radius/attributes", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "radius", "attributes" ], "query": [ { "key": "p", "value": "", "description": "Paginate Current Page. (default 1)", "disabled": true }, { "key": "l", "value": "", "description": "Paginate Limit / Entities per Page. (1-50)", "disabled": true }, { "key": "id", "value": "", "description": "Filter by id. (can suffix with wildcard *)", "disabled": true }, { "key": "name", "value": "", "description": "Filter by name. (can suffix with wildcard *)", "disabled": true }, { "key": "sc", "value": "", "description": "Sort by Property/Column. (id, name)", "disabled": true }, { "key": "sd", "value": "", "description": "Sort direction. asc for Ascending or desc for Descending", "disabled": true } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": \"3com-connect_id\",\n \"name\": \"3com-connect_id\"\n },\n {\n \"id\": \"3com-encryption-type\",\n \"name\": \"3com-encryption-type\"\n },\n {\n \"id\": \"3com-end-date\",\n \"name\": \"3com-end-date\"\n },\n {\n \"id\": \"3com-ip-host-addr\",\n \"name\": \"3com-ip-host-addr\"\n },\n {\n \"id\": \"3com-mobility-profile\",\n \"name\": \"3com-mobility-profile\"\n },\n {\n \"id\": \"3com-nas-startup-timestamp\",\n \"name\": \"3com-nas-startup-timestamp\"\n },\n {\n \"id\": \"3com-product-id\",\n \"name\": \"3com-product-id\"\n },\n {\n \"id\": \"3com-ssid\",\n \"name\": \"3com-ssid\"\n },\n {\n \"id\": \"3com-time-of-day\",\n \"name\": \"3com-time-of-day\"\n },\n {\n \"id\": \"3com-url\",\n \"name\": \"3com-url\"\n }\n ],\n \"metadata\": {\n \"records\": 250,\n \"page\": 1,\n \"pages\": 25,\n \"per_page\": 10\n }\n}", "_postman_previewlanguage": "json" } ] }, { "name": "List Service Context Attributes", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/service/context_attributes/:service_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "service", "context_attributes", ":service_id" ], "query": [ { "key": "p", "value": "", "description": "Paginate Current Page. (default 1)", "disabled": true }, { "key": "l", "value": "", "description": "Paginate Limit / Entities per Page. (1-50, -1 for streaming)", "disabled": true }, { "key": "attribute", "value": "", "description": "Filter by attribute. (can suffix with wildcard *)", "disabled": true }, { "key": "ctx", "value": "", "description": "Filter by ctx. (can suffix with wildcard *)", "disabled": true }, { "key": "client_profile", "value": "", "description": "Filter by client_profile. (can suffix with wildcard *)", "disabled": true }, { "key": "sc", "value": "", "description": "Sort by Property/Column. (attribute, ctx, client_profile)", "disabled": true }, { "key": "sd", "value": "", "description": "Sort direction. asc for Ascending or desc for Descending", "disabled": true } ], "variable": [ { "key": "service_id", "value": "", "description": "Service Id." } ] }, "description": "## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": \"b0e42c98-5f82-11ef-a350-aff022b163c4\",\n \"service_id\": \"a13610c7-6ea3-4f3e-afb9-e422d530473a\",\n \"attribute\": \"mikrotik-rate-limit\",\n \"tag\": null,\n \"value\": \"{{upload}}M/{{download}}M\",\n \"ctx\": \"activate-login\",\n \"client_profile\": \"MIKROTIK\",\n \"creation_time\": \"2024-08-21T06:00:38.000Z\"\n }\n ],\n \"metadata\": {\n \"records\": 1,\n \"page\": 1,\n \"pages\": 1,\n \"per_page\": 10\n }\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Add Context Attribute to Service", "request": { "method": "POST", "url": { "raw": "{{subscriberUrl}}/v1/service/context_attribute/:service_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "service", "context_attribute", ":service_id" ], "variable": [ { "key": "service_id", "value": "", "description": "Service Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"attribute\": \"mikrotik-rate-limit\",\n \"value\": \"{{upload}}M/{{download}}M\",\n \"ctx\": \"activate-login\",\n \"client_profile\": \"MIKROTIK\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"b0e42c98-5f82-11ef-a350-aff022b163c4\",\n \"service_id\": \"a13610c7-6ea3-4f3e-afb9-e422d530473a\",\n \"attribute\": \"mikrotik-rate-limit\",\n \"tag\": null,\n \"value\": \"{{upload}}M/{{download}}M\",\n \"ctx\": \"activate-login\",\n \"client_profile\": \"MIKROTIK\",\n \"creation_time\": \"2024-08-21T06:00:38.000Z\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Show Service Context Attribute", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/service/context_attribute/:attribute_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "service", "context_attribute", ":attribute_id" ], "variable": [ { "key": "attribute_id", "value": "", "description": "Attribute Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"b0e42c98-5f82-11ef-a350-aff022b163c4\",\n \"service_id\": \"a13610c7-6ea3-4f3e-afb9-e422d530473a\",\n \"attribute\": \"mikrotik-rate-limit\",\n \"tag\": null,\n \"value\": \"{{upload}}M/{{download}}M\",\n \"ctx\": \"activate-login\",\n \"client_profile\": \"MIKROTIK\",\n \"creation_time\": \"2024-08-21T06:00:38.000Z\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Update Context Attribute", "request": { "method": "PATCH", "url": { "raw": "{{subscriberUrl}}/v1/service/context_attribute/:attribute_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "service", "context_attribute", ":attribute_id" ], "variable": [ { "key": "attribute_id", "value": "", "description": "Attribute Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"attribute\": \"mikrotik-rate-limit\",\n \"value\": \"{{upload}}M/{{download}}M\",\n \"ctx\": \"activate-login\",\n \"client_profile\": \"MIKROTIK\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"b0e42c98-5f82-11ef-a350-aff022b163c4\",\n \"service_id\": \"a13610c7-6ea3-4f3e-afb9-e422d530473a\",\n \"attribute\": \"mikrotik-rate-limit\",\n \"tag\": null,\n \"value\": \"{{upload}}M/{{download}}M\",\n \"ctx\": \"activate-login\",\n \"client_profile\": \"MIKROTIK\",\n \"creation_time\": \"2024-08-21T06:00:38.000Z\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Delete Context Attribute of Service", "request": { "method": "DELETE", "url": { "raw": "{{subscriberUrl}}/v1/service/context_attribute/:attribute_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "service", "context_attribute", ":attribute_id" ], "variable": [ { "key": "attribute_id", "value": "", "description": "Attribute Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **204** OK - No Content\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] } }, { "name": "List Service Other Attributes", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/service/other_attributes/:service_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "service", "other_attributes", ":service_id" ], "query": [ { "key": "p", "value": "", "description": "Paginate Current Page. (default 1)", "disabled": true }, { "key": "l", "value": "", "description": "Paginate Limit / Entities per Page. (1-50, -1 for streaming)", "disabled": true }, { "key": "attribute", "value": "", "description": "Filter by attribute. (can suffix with wildcard *)", "disabled": true }, { "key": "ctx", "value": "", "description": "Filter by ctx. (can suffix with wildcard *)", "disabled": true }, { "key": "client_profile", "value": "", "description": "Filter by client_profile. (can suffix with wildcard *)", "disabled": true }, { "key": "sc", "value": "", "description": "Sort by Property/Column. (attribute, ctx, client_profile)", "disabled": true }, { "key": "sd", "value": "", "description": "Sort direction. asc for Ascending or desc for Descending", "disabled": true } ], "variable": [ { "key": "service_id", "value": "", "description": "Service Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": \"7fde9bf0-65c3-11ef-8c16-cfca366fc35d\",\n \"service_id\": \"a13610c7-6ea3-4f3e-afb9-e422d530473a\",\n \"attribute\": \"framed-ip-address\",\n \"tag\": null,\n \"value\": \"{{ ip_address }}\",\n \"ctx\": \"ipv4-address\",\n \"client_profile\": \"MIKROTIK\",\n \"creation_time\": \"2024-08-29T04:59:41.000Z\"\n },\n {\n \"id\": \"639bcf8a-65c3-11ef-8c0d-cfca366fc35d\",\n \"service_id\": \"a13610c7-6ea3-4f3e-afb9-e422d530473a\",\n \"attribute\": \"framed-route\",\n \"tag\": null,\n \"value\": \"{{ ip_prefix }}\",\n \"ctx\": \"ipv4-route\",\n \"client_profile\": \"MIKROTIK\",\n \"creation_time\": \"2024-08-29T04:58:53.000Z\"\n }\n ],\n \"metadata\": {\n \"records\": 2,\n \"page\": 1,\n \"pages\": 1,\n \"per_page\": 10\n }\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Add Other Attribute to Service", "request": { "method": "POST", "url": { "raw": "{{subscriberUrl}}/v1/service/other_attribute/:service_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "service", "other_attribute", ":service_id" ], "variable": [ { "key": "service_id", "value": "", "description": "Service Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"attribute\": \"framed-route\",\n \"tag\": null,\n \"value\": \"{{ ip_prefix }}\",\n \"ctx\": \"ipv4-route\",\n \"client_profile\": \"MIKROTIK\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"639bcf8a-65c3-11ef-8c0d-cfca366fc35d\",\n \"service_id\": \"a13610c7-6ea3-4f3e-afb9-e422d530473a\",\n \"attribute\": \"framed-route\",\n \"tag\": null,\n \"value\": \"{{ ip_prefix }}\",\n \"ctx\": \"ipv4-route\",\n \"client_profile\": \"MIKROTIK\",\n \"creation_time\": \"2024-08-29T04:58:53.000Z\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Show Service Other Attribute", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/service/other_attribute/:attribute_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "service", "other_attribute", ":attribute_id" ], "variable": [ { "key": "attribute_id", "value": "", "description": "Attribute Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"639bcf8a-65c3-11ef-8c0d-cfca366fc35d\",\n \"service_id\": \"a13610c7-6ea3-4f3e-afb9-e422d530473a\",\n \"attribute\": \"framed-route\",\n \"tag\": null,\n \"value\": \"{{ ip_prefix }}\",\n \"ctx\": \"ipv4-route\",\n \"client_profile\": \"MIKROTIK\",\n \"creation_time\": \"2024-08-29T04:58:53.000Z\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Update Other Attribute", "request": { "method": "PATCH", "url": { "raw": "{{subscriberUrl}}/v1/service/other_attribute/:attribute_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "service", "other_attribute", ":attribute_id" ], "variable": [ { "key": "attribute_id", "value": "", "description": "Attribute Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"attribute\": \"framed-route\",\n \"value\": \"{{ ip_prefix }}\",\n \"ctx\": \"ipv4-route\",\n \"client_profile\": \"MIKROTIK\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"639bcf8a-65c3-11ef-8c0d-cfca366fc35d\",\n \"service_id\": \"a13610c7-6ea3-4f3e-afb9-e422d530473a\",\n \"attribute\": \"framed-route\",\n \"tag\": null,\n \"value\": \"{{ ip_prefix }}\",\n \"ctx\": \"ipv4-route\",\n \"client_profile\": \"MIKROTIK\",\n \"creation_time\": \"2024-08-29T04:58:53.000Z\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Delete Other Attribute of Service", "request": { "method": "DELETE", "url": { "raw": "{{subscriberUrl}}/v1/service/other_attribute/:attribute_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "service", "other_attribute", ":attribute_id" ], "variable": [ { "key": "attribute_id", "value": "", "description": "Attribute Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **204** OK - No Content\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] } } ] }, { "name": "Sessions", "item": [ { "name": "Sessions for subscriber", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v2/sessions/:subscriber_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v2", "sessions", ":subscriber_id" ], "query": [ { "key": "p", "value": "", "description": "Paginate Current Page. (default 1)", "disabled": true }, { "key": "l", "value": "", "description": "Paginate Limit / Entities per Page. (1-50, -1 for streaming)", "disabled": true }, { "key": "username", "value": "", "description": "Filter by username. (can suffix with wildcard *)", "disabled": true }, { "key": "calling_station_id", "value": "", "description": "Filter by calling_station_id. (can suffix with wildcard *)", "disabled": true }, { "key": "realm", "value": "", "description": "Filter by realm. (can suffix with wildcard *)", "disabled": true }, { "key": "framed_ip_address", "value": "", "description": "Filter by framed_ip_address. (can suffix with wildcard *)", "disabled": true }, { "key": "ctx", "value": "", "description": "Filter by ctx. (can suffix with wildcard *)", "disabled": true }, { "key": "sc", "value": "", "description": "Sort by Property/Column. (username, calling_station_id, realm, start_time, updated_time, ctx, framed_ip_address)", "disabled": true }, { "key": "sd", "value": "", "description": "Sort direction. asc for Ascending or desc for Descending", "disabled": true } ], "variable": [ { "key": "subscriber_id", "value": "", "description": "Subscriber Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Customer, Network Operations, Staff Member, Subscriber Accounts, Subscriber Administrator, Subscriber Support, Subscriber Telemetry, Subscriber View, Support\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Tenant-ID", "value": "{{tenantId}}", "description": "Request Tenant Context. (requires X-Domain of the tenant)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": \"520d4872-66ac-11ef-abed-ef0503fe37cf\",\n \"calling_station_id\": \"\",\n \"acct_unique_id\": \"a2b3ec16-5996-4add-963d-e5fd46641d95\",\n \"start_time\": \"2024-08-26T04:46:16.000Z\",\n \"updated_time\": \"2024-08-30T08:46:17.000Z\",\n \"user_id\": \"2c79f1c6-c9dd-11ee-b885-ddbef08e6d9d\",\n \"username\": \"test@example.com\",\n \"framed_ip_address\": \"205.25.1.1\",\n \"nas_ip_address\": \"192.168.0.1\",\n \"ctx\": \"activate-login\"\n }\n ],\n \"metadata\": {\n \"records\": 1,\n \"page\": 1,\n \"pages\": 1,\n \"per_page\": 10\n }\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Show subscriber session", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v2/session/:session_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v2", "session", ":session_id" ], "variable": [ { "key": "session_id", "value": "", "description": "Session Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Customer, Network Operations, Staff Member, Subscriber Accounts, Subscriber Administrator, Subscriber Support, Subscriber Telemetry, Subscriber View, Support\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Tenant-ID", "value": "{{tenantId}}", "description": "Request Tenant Context. (requires X-Domain of the tenant)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"0a9685a8-1540-45ae-91bb-de990041008e\",\n \"virtual_id\": \"465be807-54f1-4bf6-b940-398ed95cdbe7\",\n \"domain\": \"example.com\",\n \"user_id\": \"c5ddf963-cbb6-4019-b20a-0bbcfd51b49b\",\n \"profile_id\": \"87dae83d-2b26-4673-a86d-eff1ad30667b\",\n \"service_id\": \"dee171f4-34a7-401b-bdef-9cd2ca6a9e8f\",\n \"ctx\": \"activate-login\",\n \"username\": \"test@example.com\",\n \"calling_station_id\": \"\",\n \"called_station_id\": \"\",\n \"realm\": \"example.com\",\n \"acct_session_id\": \"47815835\",\n \"start_time\": \"2023-12-13T13:54:32+00:00\",\n \"updated_time\": \"2023-12-13T14:04:32+00:00\",\n \"stop_time\": null,\n \"arrival_time\": \"2023-12-13T14:04:32+00:00\",\n \"expire_time\": \"2023-12-13T14:36:32+00:00\",\n \"arrival_interval\": 600,\n \"nas_ip_address\": \"192.168.0.1\",\n \"client_ip_address\": \"192.168.0.1\",\n \"server_ip_address\": \"10.0.0.4\",\n \"framed_ip_address\": \"100.66.47.215\",\n \"pool_id\": \"\",\n \"metadata\": {\n \"user-name\": [\n \"test@example.com\"\n ],\n \"nas-ip-address\": [\n \"192.168.0.1\"\n ],\n ...\n },\n \"input_octets\": 0,\n \"output_octets\": 0,\n \"acct_type\": \"interim-update\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Disconnect session", "request": { "method": "DELETE", "url": { "raw": "{{subscriberUrl}}/v1/disconnect/:session_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "disconnect", ":session_id" ], "variable": [ { "key": "session_id", "value": "", "description": "Session Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Accounts, Subscriber Administrator, Subscriber Support, Support\n\n## Status Codes\n\n- **204** OK - No Content\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Tenant-ID", "value": "{{tenantId}}", "description": "Request Tenant Context. (requires X-Domain of the tenant)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] } }, { "name": "Disconnect all sessions for subscriber", "request": { "method": "DELETE", "url": { "raw": "{{subscriberUrl}}/v1/disconnect/subscriber/:subscriber_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "disconnect", "subscriber", ":subscriber_id" ], "variable": [ { "key": "subscriber_id", "value": "", "description": "Subscriber Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Accounts, Subscriber Administrator, Subscriber Support, Support\n\n## Status Codes\n\n- **204** OK - No Content\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Tenant-ID", "value": "{{tenantId}}", "description": "Request Tenant Context. (requires X-Domain of the tenant)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] } } ] }, { "name": "Usage Meter", "item": [ { "name": "Get Current Usage Meter", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/usage-meter/:subscriber_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "usage-meter", ":subscriber_id" ], "variable": [ { "key": "subscriber_id", "value": "", "description": "Unique subscriber ID." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Tenant-ID", "value": "{{tenantId}}", "description": "Request Tenant Context. (requires X-Domain of the tenant)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"subscriber_id\": \"00034ae6-4d79-11ef-80c4-174adb24f2cd\",\n \"monthly_combined_kb\": 524288,\n \"monthly_month\": \"2025-01\",\n \"monthly_combined_trigger_kb\": 1048576,\n \"monthly_combined_triggered\": false\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Set Usage Meter Threshold", "request": { "method": "POST", "url": { "raw": "{{subscriberUrl}}/v1/usage-meter/:subscriber_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "usage-meter", ":subscriber_id" ], "variable": [ { "key": "subscriber_id", "value": "", "description": "Unique subscriber ID." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Tenant-ID", "value": "{{tenantId}}", "description": "Request Tenant Context. (requires X-Domain of the tenant)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"monthly_combined_trigger_kb\": 1048576\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"subscriber_id\": \"00034ae6-4d79-11ef-80c4-174adb24f2cd\",\n \"monthly_combined_kb\": 524288,\n \"monthly_month\": \"2025-01\",\n \"monthly_combined_trigger_kb\": 1048576,\n \"monthly_combined_triggered\": false\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Reset Usage Meter Trigger State", "request": { "method": "DELETE", "url": { "raw": "{{subscriberUrl}}/v1/usage-meter/:subscriber_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "usage-meter", ":subscriber_id" ], "variable": [ { "key": "subscriber_id", "value": "", "description": "Unique subscriber ID." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Tenant-ID", "value": "{{tenantId}}", "description": "Request Tenant Context. (requires X-Domain of the tenant)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "No Content", "_postman_previewlanguage": "json" } ] } ] }, { "name": "Virtual Servers", "item": [ { "name": "List Virtual Servers", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/virtuals", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "virtuals" ], "query": [ { "key": "p", "value": "", "description": "Paginate Current Page. (default 1)", "disabled": true }, { "key": "l", "value": "", "description": "Paginate Limit / Entities per Page. (1-50, 0 for infinite, -1 for streaming)", "disabled": true }, { "key": "id", "value": "", "description": "Filter by id. (can suffix with wildcard *)", "disabled": true }, { "key": "name", "value": "", "description": "Filter by name. (can suffix with wildcard *)", "disabled": true }, { "key": "sc", "value": "", "description": "Sort by Property/Column. (id, name)", "disabled": true }, { "key": "sd", "value": "", "description": "Sort direction. asc for Ascending or desc for Descending", "disabled": true } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Accounts, Subscriber Administrator, Subscriber Telemetry\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": \"0ba81d12-3202-4019-95b7-7d7e14f98703\",\n \"domain\": \"interstellio.io\",\n \"name\": \"TEST\"\n }\n ],\n \"metadata\": {\n \"records\": 1,\n \"page\": 1,\n \"pages\": 1,\n \"per_page\": 10\n }\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Show Virtual Server Details", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/virtual/:virtual_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "virtual", ":virtual_id" ], "variable": [ { "key": "virtual_id", "value": "", "description": "Virtual Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"0ba81d12-3202-4019-95b7-7d7e14f98703\",\n \"domain\": \"interstellio.io\",\n \"name\": \"TEST\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "List Clients for Virtual Server", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/virtual/:virtual_id/clients", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "virtual", ":virtual_id", "clients" ], "query": [ { "key": "p", "value": "", "description": "Paginate Current Page. (default 1)", "disabled": true }, { "key": "l", "value": "", "description": "Paginate Limit / Entities per Page. (1-50, 0 for infinite, -1 for streaming)", "disabled": true }, { "key": "id", "value": "", "description": "Filter by id. (can suffix with wildcard *)", "disabled": true }, { "key": "name", "value": "", "description": "Filter by name. (can suffix with wildcard *)", "disabled": true }, { "key": "sc", "value": "", "description": "Sort by Property/Column. (id, name)", "disabled": true }, { "key": "sd", "value": "", "description": "Sort direction. asc for Ascending or desc for Descending", "disabled": true } ], "variable": [ { "key": "virtual_id", "value": "", "description": "Virtual Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": \"e27627f8-3a13-4154-a19b-dc516de37577\",\n \"name\": \"TEST-BNG.INTERSTELLIO.IO\",\n \"type\": \"nas\",\n \"tags\": \"\",\n \"profile\": \"JUNIPER\",\n \"secret\": \"testing123\",\n \"ip4_address\": \"102.220.62.19\",\n \"coa_port\": 3799,\n \"pool_id\": null,\n \"pool_id_deactivate\": null,\n \"creation_time\": \"2024-01-19T05:37:46.000Z\"\n }\n ],\n \"metadata\": {\n \"records\": 1,\n \"page\": 1,\n \"pages\": 1,\n \"per_page\": 10\n }\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Create Client for Virtual Server", "request": { "method": "POST", "url": { "raw": "{{subscriberUrl}}/v1/virtual/:virtual_id/client", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "virtual", ":virtual_id", "client" ], "variable": [ { "key": "virtual_id", "value": "", "description": "Virtual Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"TEST-BNG.INTERSTELLIO.IO\",\n \"type\": \"nas\",\n \"tags\": \"\",\n \"profile\": \"JUNIPER\",\n \"secret\": \"testing123\",\n \"ip4_address\": \"102.220.62.19\",\n \"coa_port\": 3799,\n \"pool_id\": null,\n \"pool_id_deactivate\": null\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"e27627f8-3a13-4154-a19b-dc516de37577\",\n \"name\": \"TEST-BNG.INTERSTELLIO.IO\",\n \"type\": \"nas\",\n \"tags\": \"\",\n \"profile\": \"JUNIPER\",\n \"secret\": \"testing123\",\n \"ip4_address\": \"102.220.62.19\",\n \"coa_port\": 3799,\n \"pool_id\": null,\n \"pool_id_deactivate\": null,\n \"creation_time\": \"2024-01-19T05:37:46.000Z\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Show Client for Virtual Server", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/virtual/client/:client_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "virtual", "client", ":client_id" ], "variable": [ { "key": "client_id", "value": "", "description": "Client Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"e27627f8-3a13-4154-a19b-dc516de37577\",\n \"name\": \"TEST-BNG.INTERSTELLIO.IO\",\n \"type\": \"nas\",\n \"tags\": \"\",\n \"profile\": \"JUNIPER\",\n \"secret\": \"testing123\",\n \"ip4_address\": \"102.220.62.19\",\n \"coa_port\": 3799,\n \"pool_id\": null,\n \"pool_id_deactivate\": null,\n \"creation_time\": \"2024-01-19T05:37:46.000Z\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Update Client for Virtual Server", "request": { "method": "PATCH", "url": { "raw": "{{subscriberUrl}}/v1/virtual/client/:client_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "virtual", "client", ":client_id" ], "variable": [ { "key": "client_id", "value": "", "description": "Client Id." } ] }, "description": "## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"TEST-BNG.INTERSTELLIO.IO\",\n \"type\": \"nas\",\n \"tags\": \"\",\n \"profile\": \"JUNIPER\",\n \"secret\": \"testing123\",\n \"ip4_address\": \"102.220.62.19\",\n \"coa_port\": 3799,\n \"pool_id\": null,\n \"pool_id_deactivate\": null\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"e27627f8-3a13-4154-a19b-dc516de37577\",\n \"name\": \"TEST-BNG.INTERSTELLIO.IO\",\n \"type\": \"nas\",\n \"tags\": \"\",\n \"profile\": \"JUNIPER\",\n \"secret\": \"testing123\",\n \"ip4_address\": \"102.220.62.19\",\n \"coa_port\": 3799,\n \"pool_id\": null,\n \"pool_id_deactivate\": null,\n \"creation_time\": \"2024-01-19T05:37:46.000Z\"\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Delete Client for Virtual Server", "request": { "method": "DELETE", "url": { "raw": "{{subscriberUrl}}/v1/virtual/client/:client_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "virtual", "client", ":client_id" ], "variable": [ { "key": "client_id", "value": "", "description": "Client Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **204** OK - No Content\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] } } ] }, { "name": "Webhooks", "item": [ { "name": "List Webhooks", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/webhooks", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "webhooks" ], "query": [ { "key": "p", "value": "", "description": "Paginate Current Page. (default 1)", "disabled": true }, { "key": "l", "value": "", "description": "Paginate Limit / Entities per Page. (1-50, -1 for streaming)", "disabled": true } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": \"6962a8c8-d3df-11ef-aa98-79d85e6cbbe2\",\n \"domain\": \"interstellio.io\",\n \"url\": \"https://webhooks.example.com/radius/usage-meter\",\n \"method\": \"post\",\n \"ssl_verify\": true,\n \"context\": \"radius-accounting\",\n \"wh_trigger\": \"subscriber-usage-meter-triggered\",\n \"auth\": \"NONE\",\n \"basic_auth_username\": null,\n \"basic_auth_password\": null,\n \"bearer_token\": null\n }\n ],\n \"metadata\": {\n \"records\": 1,\n \"page\": 1,\n \"pages\": 1,\n \"per_page\": 10\n }\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Create Webhook", "request": { "method": "POST", "url": { "raw": "{{subscriberUrl}}/v1/webhooks", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "webhooks" ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://webhooks.example.com/radius/usage-meter\",\n \"method\": \"post\",\n \"ssl_verify\": true,\n \"context\": \"radius-accounting\",\n \"wh_trigger\": \"subscriber-usage-meter-triggered\",\n \"auth\": \"NONE\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"6962a8c8-d3df-11ef-aa98-79d85e6cbbe2\",\n \"domain\": \"interstellio.io\",\n \"url\": \"https://webhooks.example.com/radius/usage-meter\",\n \"method\": \"post\",\n \"ssl_verify\": true,\n \"context\": \"radius-accounting\",\n \"wh_trigger\": \"subscriber-usage-meter-triggered\",\n \"auth\": \"NONE\",\n \"basic_auth_username\": null,\n \"basic_auth_password\": null,\n \"bearer_token\": null\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Get Webhook", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/webhooks/:webhook_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "webhooks", ":webhook_id" ], "variable": [ { "key": "webhook_id", "value": "", "description": "Unique webhook ID to retrieve." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"6962a8c8-d3df-11ef-aa98-79d85e6cbbe2\",\n \"domain\": \"interstellio.io\",\n \"url\": \"https://webhooks.example.com/radius/usage-meter\",\n \"method\": \"post\",\n \"ssl_verify\": true,\n \"context\": \"radius-accounting\",\n \"wh_trigger\": \"subscriber-usage-meter-triggered\",\n \"auth\": \"NONE\",\n \"basic_auth_username\": null,\n \"basic_auth_password\": null,\n \"bearer_token\": null\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Edit Webhook", "request": { "method": "POST", "url": { "raw": "{{subscriberUrl}}/v1/webhooks/:webhook_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "webhooks", ":webhook_id" ], "variable": [ { "key": "webhook_id", "value": "", "description": "Unique webhook ID to update." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"https://webhooks.example.com/radius/usage-meter\",\n \"method\": \"post\",\n \"ssl_verify\": true,\n \"context\": \"radius-accounting\",\n \"wh_trigger\": \"subscriber-usage-meter-triggered\",\n \"auth\": \"NONE\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"6962a8c8-d3df-11ef-aa98-79d85e6cbbe2\",\n \"domain\": \"interstellio.io\",\n \"url\": \"https://webhooks.example.com/radius/usage-meter\",\n \"method\": \"post\",\n \"ssl_verify\": true,\n \"context\": \"radius-accounting\",\n \"wh_trigger\": \"subscriber-usage-meter-triggered\",\n \"auth\": \"NONE\",\n \"basic_auth_username\": null,\n \"basic_auth_password\": null,\n \"bearer_token\": null\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Delete Webhook", "request": { "method": "DELETE", "url": { "raw": "{{subscriberUrl}}/v1/webhooks/:webhook_id", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "webhooks", ":webhook_id" ], "variable": [ { "key": "webhook_id", "value": "", "description": "Webhook Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **204** OK - No Content\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] } }, { "name": "Get Webhook Contexts", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/webhooks/contexts", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "webhooks", "contexts" ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": \"radius-authentication\",\n \"name\": \"radius-authentication\"\n },\n {\n \"id\": \"radius-accounting\",\n \"name\": \"radius-accounting\"\n }\n ],\n \"metadata\": {\n \"records\": 2,\n \"page\": 1,\n \"pages\": 1,\n \"per_page\": 2\n }\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Get Webhook Triggers", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/webhooks/triggers", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "webhooks", "triggers" ], "query": [ { "key": "context", "value": "", "description": "Context to return triggers for, e.g. radius-authentication. Retrieve valid values from GET /v1/webhooks/contexts. When omitted, the triggers for every context are returned.", "disabled": true } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"payload\": [\n {\n \"id\": \"subscriber-nas-updated\",\n \"name\": \"subscriber-nas-updated\"\n },\n {\n \"id\": \"subscriber-authenticated\",\n \"name\": \"subscriber-authenticated\"\n }\n ],\n \"metadata\": {\n \"records\": 2,\n \"page\": 1,\n \"pages\": 1,\n \"per_page\": 2\n }\n}", "_postman_previewlanguage": "json" } ] } ] }, { "name": "Telemetry - Counts", "item": [ { "name": "Subscriber Current Total Count", "request": { "method": "GET", "url": { "raw": "{{subscriberUrl}}/v1/subscribers/count", "host": [ "{{subscriberUrl}}" ], "path": [ "v1", "subscribers", "count" ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Accounts, Subscriber Administrator, Subscriber Support, Subscriber Telemetry, Subscriber View\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"count\": 9999\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Subscriber Active/Inactive Count", "request": { "method": "POST", "url": { "raw": "{{telemetryUrl}}/v1/subscriber/count", "host": [ "{{telemetryUrl}}" ], "path": [ "v1", "subscriber", "count" ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Accounts, Subscriber Administrator, Subscriber Support, Subscriber Telemetry, Subscriber View\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"active\": 100,\n \"total\": 150,\n \"inactive\": 50,\n \"time\": \"2025-01 (January)\"\n },\n {\n \"active\": 100,\n \"total\": 150,\n \"inactive\": 50,\n \"time\": \"2025-02 (February)\"\n },\n {\n \"active\": 100,\n \"total\": 150,\n \"inactive\": 50,\n \"time\": \"2025-03 (March)\"\n }\n]", "_postman_previewlanguage": "json" } ] } ] }, { "name": "Telemetry - Data Usage", "item": [ { "name": "Subscriber Account data usage", "request": { "method": "POST", "url": { "raw": "{{telemetryUrl}}/v1/subscriber/:subscriber_id/data/:aggregation", "host": [ "{{telemetryUrl}}" ], "path": [ "v1", "subscriber", ":subscriber_id", "data", ":aggregation" ], "variable": [ { "key": "subscriber_id", "value": "", "description": "Unique Subscriber ID." }, { "key": "aggregation", "value": "", "description": "hourly, daily, weekly, monthly or yearly." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Customer, Network Operations, Staff Member, Subscriber Accounts, Subscriber Administrator, Subscriber Support, Subscriber Telemetry, Subscriber View, Support\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"start\": \"2024-05-01T00:00:00+02:00\",\n \"end\": \"2024-08-13T12:16:43+02:00\",\n \"pretty_date\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"download_kb\": 0.0,\n \"upload_kb\": 0.0,\n \"combined_kb\": 0.0,\n \"upload_kbps\": 0.0,\n \"download_kbps\": 0.0,\n \"min_download_kbps\": 0.0,\n \"min_upload_kbps\": 0.0,\n \"max_download_kbps\": 0.0,\n \"max_upload_kbps\": 0.0,\n \"time\": \"2024-05 (May)\"\n },\n {\n \"download_kb\": 0.0,\n \"upload_kb\": 0.0,\n \"combined_kb\": 0.0,\n \"upload_kbps\": 0.0,\n \"download_kbps\": 0.0,\n \"min_download_kbps\": 0.0,\n \"min_upload_kbps\": 0.0,\n \"max_download_kbps\": 0.0,\n \"max_upload_kbps\": 0.0,\n \"time\": \"2024-06 (June)\"\n },\n {\n \"download_kb\": 0.0,\n \"upload_kb\": 0.0,\n \"combined_kb\": 0.0,\n \"upload_kbps\": 0.0,\n \"download_kbps\": 0.0,\n \"min_download_kbps\": 0.0,\n \"min_upload_kbps\": 0.0,\n \"max_download_kbps\": 0.0,\n \"max_upload_kbps\": 0.0,\n \"time\": \"2024-07 (July)\"\n },\n {\n \"download_kb\": 0.0,\n \"upload_kb\": 0.0,\n \"combined_kb\": 0.0,\n \"upload_kbps\": 0.0,\n \"download_kbps\": 0.0,\n \"min_download_kbps\": 0.0,\n \"min_upload_kbps\": 0.0,\n \"max_download_kbps\": 0.0,\n \"max_upload_kbps\": 0.0,\n \"time\": \"2024-08 (August)\"\n }\n]", "_postman_previewlanguage": "json" } ] }, { "name": "Virtual Server data usage", "request": { "method": "POST", "url": { "raw": "{{telemetryUrl}}/v1/subscriber/virtual/:virtual_id/data/:aggregation", "host": [ "{{telemetryUrl}}" ], "path": [ "v1", "subscriber", "virtual", ":virtual_id", "data", ":aggregation" ], "variable": [ { "key": "virtual_id", "value": "", "description": "Unique Virtual ID." }, { "key": "aggregation", "value": "", "description": "hourly, daily, weekly, monthly or yearly." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator, Subscriber Telemetry\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"start\": \"2024-05-01T00:00:00+02:00\",\n \"end\": \"2024-08-13T12:16:43+02:00\",\n \"pretty_date\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"download_kb\": 0.0,\n \"upload_kb\": 0.0,\n \"combined_kb\": 0.0,\n \"download_kbps\": 0.0,\n \"upload_kbps\": 0.0,\n \"min_download_kbps\": 0.0,\n \"min_upload_kbps\": 0.0,\n \"max_download_kbps\": 0.0,\n \"max_upload_kbps\": 0.0,\n \"time\": \"2024-05 (May)\"\n },\n {\n \"download_kb\": 0.0,\n \"upload_kb\": 0.0,\n \"combined_kb\": 0.0,\n \"download_kbps\": 0.0,\n \"upload_kbps\": 0.0,\n \"min_download_kbps\": 0.0,\n \"min_upload_kbps\": 0.0,\n \"max_download_kbps\": 0.0,\n \"max_upload_kbps\": 0.0,\n \"time\": \"2024-06 (June)\"\n },\n {\n \"download_kb\": 0.0,\n \"upload_kb\": 0.0,\n \"combined_kb\": 0.0,\n \"download_kbps\": 0.0,\n \"upload_kbps\": 0.0,\n \"min_download_kbps\": 0.0,\n \"min_upload_kbps\": 0.0,\n \"max_download_kbps\": 0.0,\n \"max_upload_kbps\": 0.0,\n \"time\": \"2024-07 (July)\"\n },\n {\n \"download_kb\": 0.0,\n \"upload_kb\": 0.0,\n \"combined_kb\": 0.0,\n \"download_kbps\": 0.0,\n \"upload_kbps\": 0.0,\n \"min_download_kbps\": 0.0,\n \"min_upload_kbps\": 0.0,\n \"max_download_kbps\": 0.0,\n \"max_upload_kbps\": 0.0,\n \"time\": \"2024-08 (August)\"\n }\n ],\n \"metadata\": {\n \"interpolate_interval\": NULL,\n \"per_second_avg_interval\": 3600\n }\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Virtual Server Client data usage", "request": { "method": "POST", "url": { "raw": "{{telemetryUrl}}/v1/subscriber/client/:client_id/data/:aggregation", "host": [ "{{telemetryUrl}}" ], "path": [ "v1", "subscriber", "client", ":client_id", "data", ":aggregation" ], "variable": [ { "key": "client_id", "value": "", "description": "Unique Virtual Client ID." }, { "key": "aggregation", "value": "", "description": "hourly, daily, weekly, monthly or yearly." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator, Subscriber Telemetry\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"start\": \"2024-05-01T00:00:00+02:00\",\n \"end\": \"2024-08-13T12:16:43+02:00\",\n \"pretty_date\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"download_kb\": 0.0,\n \"upload_kb\": 0.0,\n \"combined_kb\": 0.0,\n \"download_kbps\": 0.0,\n \"upload_kbps\": 0.0,\n \"min_download_kbps\": 0.0,\n \"min_upload_kbps\": 0.0,\n \"max_download_kbps\": 0.0,\n \"max_upload_kbps\": 0.0,\n \"time\": \"2024-05 (May)\"\n },\n {\n \"download_kb\": 0.0,\n \"upload_kb\": 0.0,\n \"combined_kb\": 0.0,\n \"download_kbps\": 0.0,\n \"upload_kbps\": 0.0,\n \"min_download_kbps\": 0.0,\n \"min_upload_kbps\": 0.0,\n \"max_download_kbps\": 0.0,\n \"max_upload_kbps\": 0.0,\n \"time\": \"2024-06 (June)\"\n },\n {\n \"download_kb\": 0.0,\n \"upload_kb\": 0.0,\n \"combined_kb\": 0.0,\n \"download_kbps\": 0.0,\n \"upload_kbps\": 0.0,\n \"min_download_kbps\": 0.0,\n \"min_upload_kbps\": 0.0,\n \"max_download_kbps\": 0.0,\n \"max_upload_kbps\": 0.0,\n \"time\": \"2024-07 (July)\"\n },\n {\n \"download_kb\": 0.0,\n \"upload_kb\": 0.0,\n \"combined_kb\": 0.0,\n \"download_kbps\": 0.0,\n \"upload_kbps\": 0.0,\n \"min_download_kbps\": 0.0,\n \"min_upload_kbps\": 0.0,\n \"max_download_kbps\": 0.0,\n \"max_upload_kbps\": 0.0,\n \"time\": \"2024-08 (August)\"\n }\n ],\n \"metadata\": {\n \"interpolate_interval\": NULL,\n \"per_second_avg_interval\": 3600\n }\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Service Profile data usage", "request": { "method": "POST", "url": { "raw": "{{telemetryUrl}}/v1/subscriber/service/:service_id/data/:aggregation", "host": [ "{{telemetryUrl}}" ], "path": [ "v1", "subscriber", "service", ":service_id", "data", ":aggregation" ], "variable": [ { "key": "service_id", "value": "", "description": "Unique Service ID." }, { "key": "aggregation", "value": "", "description": "hourly, daily, weekly, monthly or yearly." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator, Subscriber Telemetry\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"start\": \"2024-05-01T00:00:00+02:00\",\n \"end\": \"2024-08-13T12:16:43+02:00\",\n \"pretty_date\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"download_kb\": 0.0,\n \"upload_kb\": 0.0,\n \"combined_kb\": 0.0,\n \"download_kbps\": 0.0,\n \"upload_kbps\": 0.0,\n \"min_download_kbps\": 0.0,\n \"min_upload_kbps\": 0.0,\n \"max_download_kbps\": 0.0,\n \"max_upload_kbps\": 0.0,\n \"time\": \"2024-05 (May)\"\n },\n {\n \"download_kb\": 0.0,\n \"upload_kb\": 0.0,\n \"combined_kb\": 0.0,\n \"download_kbps\": 0.0,\n \"upload_kbps\": 0.0,\n \"min_download_kbps\": 0.0,\n \"min_upload_kbps\": 0.0,\n \"max_download_kbps\": 0.0,\n \"max_upload_kbps\": 0.0,\n \"time\": \"2024-06 (June)\"\n },\n {\n \"download_kb\": 0.0,\n \"upload_kb\": 0.0,\n \"combined_kb\": 0.0,\n \"download_kbps\": 0.0,\n \"upload_kbps\": 0.0,\n \"min_download_kbps\": 0.0,\n \"min_upload_kbps\": 0.0,\n \"max_download_kbps\": 0.0,\n \"max_upload_kbps\": 0.0,\n \"time\": \"2024-07 (July)\"\n },\n {\n \"download_kb\": 0.0,\n \"upload_kb\": 0.0,\n \"combined_kb\": 0.0,\n \"download_kbps\": 0.0,\n \"upload_kbps\": 0.0,\n \"min_download_kbps\": 0.0,\n \"min_upload_kbps\": 0.0,\n \"max_download_kbps\": 0.0,\n \"max_upload_kbps\": 0.0,\n \"time\": \"2024-08 (August)\"\n }\n ],\n \"metadata\": {\n \"interpolate_interval\": NULL,\n \"per_second_avg_interval\": 3600\n }\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Subscriber Profile data usage", "request": { "method": "POST", "url": { "raw": "{{telemetryUrl}}/v1/subscriber/profile/:profile_id/data/:aggregation", "host": [ "{{telemetryUrl}}" ], "path": [ "v1", "subscriber", "profile", ":profile_id", "data", ":aggregation" ], "variable": [ { "key": "profile_id", "value": "", "description": "Unique Subscriber Profile ID." }, { "key": "aggregation", "value": "", "description": "hourly, daily, weekly, monthly or yearly." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator, Subscriber Telemetry\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"start\": \"2024-05-01T00:00:00+02:00\",\n \"end\": \"2024-08-13T12:16:43+02:00\",\n \"pretty_date\": true\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"download_kb\": 0.0,\n \"upload_kb\": 0.0,\n \"combined_kb\": 0.0,\n \"download_kbps\": 0.0,\n \"upload_kbps\": 0.0,\n \"min_download_kbps\": 0.0,\n \"min_upload_kbps\": 0.0,\n \"max_download_kbps\": 0.0,\n \"max_upload_kbps\": 0.0,\n \"time\": \"2024-05 (May)\"\n },\n {\n \"download_kb\": 0.0,\n \"upload_kb\": 0.0,\n \"combined_kb\": 0.0,\n \"download_kbps\": 0.0,\n \"upload_kbps\": 0.0,\n \"min_download_kbps\": 0.0,\n \"min_upload_kbps\": 0.0,\n \"max_download_kbps\": 0.0,\n \"max_upload_kbps\": 0.0,\n \"time\": \"2024-06 (June)\"\n },\n {\n \"download_kb\": 0.0,\n \"upload_kb\": 0.0,\n \"combined_kb\": 0.0,\n \"download_kbps\": 0.0,\n \"upload_kbps\": 0.0,\n \"min_download_kbps\": 0.0,\n \"min_upload_kbps\": 0.0,\n \"max_download_kbps\": 0.0,\n \"max_upload_kbps\": 0.0,\n \"time\": \"2024-07 (July)\"\n },\n {\n \"download_kb\": 0.0,\n \"upload_kb\": 0.0,\n \"combined_kb\": 0.0,\n \"download_kbps\": 0.0,\n \"upload_kbps\": 0.0,\n \"min_download_kbps\": 0.0,\n \"min_upload_kbps\": 0.0,\n \"max_download_kbps\": 0.0,\n \"max_upload_kbps\": 0.0,\n \"time\": \"2024-08 (August)\"\n }\n ],\n \"metadata\": {\n \"interpolate_interval\": NULL,\n \"per_second_avg_interval\": 3600\n }\n}", "_postman_previewlanguage": "json" } ] }, { "name": "List Top Subscribers by Usage", "request": { "method": "POST", "url": { "raw": "{{telemetryUrl}}/v1/subscriber/topusers", "host": [ "{{telemetryUrl}}" ], "path": [ "v1", "subscriber", "topusers" ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Administrator, Subscriber Telemetry\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"timezone\":\"Africa/Johannesburg\",\n \"start\":\"2025-01-01 00:00\",\n \"end\":\"2025-02-01 00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"subscriber_id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"usage_kb\": \"2168513382\",\n \"usage_pretty\": \"2.17TB\",\n \"username\": \"XXXXXXXXXXXXXXXXX\",\n \"name\": \"XXXXX\",\n \"virtual\": \"XXX\",\n \"service\": \"XXX\",\n \"profile\": \"XXX\"\n },\n {\n \"subscriber_id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"usage_kb\": \"2148323355\",\n \"usage_pretty\": \"2.15TB\",\n \"username\": \"XXXXXXXXXXXXXXXXX\",\n \"name\": \"XXXXX\",\n \"virtual\": \"XXX\",\n \"service\": \"XXX\",\n \"profile\": \"XXX\"\n },\n {\n \"subscriber_id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"usage_kb\": \"1577329845\",\n \"usage_pretty\": \"1.58TB\",\n \"username\": \"XXXXXXXXXXXXXXXXX\",\n \"name\": \"XXXXX\",\n \"virtual\": \"XXX\",\n \"service\": \"XXX\",\n \"profile\": \"XXX\"\n }\n]", "_postman_previewlanguage": "json" } ] }, { "name": "Subscriber Report", "request": { "method": "POST", "url": { "raw": "{{telemetryUrl}}/v1/subscriber/report", "host": [ "{{telemetryUrl}}" ], "path": [ "v1", "subscriber", "report" ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Customer, Network Operations, Staff Member, Subscriber Accounts, Subscriber Administrator, Subscriber Support, Subscriber Telemetry, Subscriber View, Support\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "format", "value": "", "description": "The format in which to report the report. Accepted values - \"csv\", \"json\"", "type": "text", "disabled": true }, { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"USAGE\",\n \"timezone\": \"Africa/Johannesburg\",\n \"month\": \"2024-11\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"subscriber_id\": \"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\",\n \"subscriber_name\": \"XXX\",\n \"subscriber_username\": \"user@domain.co.za\",\n \"subscriber_service\": \"XXX\",\n \"subscriber_package\": \"XXX\",\n \"download_gb\": 999.99,\n \"upload_gb\": 999.99,\n \"combined_gb\": 999.99,\n \"download_kb\": 9999999,\n \"upload_kb\": 9999999,\n \"combined_kb\": 9999999\n}", "_postman_previewlanguage": "json" } ] }, { "name": "Subscriber Current Credits Usage", "request": { "method": "GET", "url": { "raw": "{{telemetryUrl}}/v1/subscriber/:subscriber_id/credit/status", "host": [ "{{telemetryUrl}}" ], "path": [ "v1", "subscriber", ":subscriber_id", "credit", "status" ], "variable": [ { "key": "subscriber_id", "value": "", "description": "Subscriber Id." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Customer, Network Operations, Staff Member, Subscriber Accounts, Subscriber Administrator, Subscriber Support, Subscriber Telemetry, Subscriber View, Support\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"credit_name\": \"Monthly Anytime\",\n \"total_credit\": 10000000,\n \"total_used\": 10000000,\n \"rollover\": 0,\n \"free\": 0\n }\n]", "_postman_previewlanguage": "json" } ] } ] }, { "name": "Telemetry - Event Logs", "item": [ { "name": "List of Events", "request": { "method": "GET", "url": { "raw": "{{telemetryUrl}}/v1/subscriber/:subscriber_id/events", "host": [ "{{telemetryUrl}}" ], "path": [ "v1", "subscriber", ":subscriber_id", "events" ], "query": [ { "key": "facility", "value": "", "description": "Match facility. Authentication, Accounting and more.", "disabled": true }, { "key": "severity", "value": "", "description": "Match severity precisely. (info, warning, error, critical)", "disabled": true } ], "variable": [ { "key": "subscriber_id", "value": "", "description": "Unique Subscriber ID." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Accounts, Subscriber Administrator, Subscriber Support, Subscriber Telemetry, Subscriber View\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"time\": \"2024-08-07T11:33:17+00:00\",\n \"facility\": \"authentication\",\n \"severity\": \"info\",\n \"message\": \"Authentication: Authentication login success\",\n \"event_id\": \"1723028400::d7268c5d-54b0-11ef-aefc-174adb24f2cd\"\n },\n {\n \"time\": \"2024-08-05T12:46:32+00:00\",\n \"facility\": \"authentication\",\n \"severity\": \"info\",\n \"message\": \"Authentication: Authentication login success\",\n \"event_id\": \"1722859200::bd44210d-5328-11ef-bf64-cfca366fc35d\"\n },\n {\n \"time\": \"2024-07-31T05:57:34+00:00\",\n \"facility\": \"authentication\",\n \"severity\": \"info\",\n \"message\": \"Authentication: Authentication login success\",\n \"event_id\": \"1722402000::c85b25d4-4f01-11ef-9648-cfca366fc35d\"\n },\n {\n \"time\": \"2024-07-30T16:26:59+00:00\",\n \"facility\": \"authentication\",\n \"severity\": \"info\",\n \"message\": \"Authentication: Authentication login success\",\n \"event_id\": \"1722355200::8bcf84f0-4e90-11ef-b265-aff022b163c4\"\n },\n {\n \"time\": \"2024-07-29T07:06:02+00:00\",\n \"facility\": \"authentication\",\n \"severity\": \"info\",\n \"message\": \"Authentication: Authentication login success\",\n \"event_id\": \"1722236400::03d9363a-4d79-11ef-80c4-174adb24f2cd\"\n },\n {\n \"time\": \"2024-07-29T07:05:56+00:00\",\n \"facility\": \"disconnect\",\n \"severity\": \"error\",\n \"message\": \"disconnect: Error (server http://10.0.0.33)\",\n \"event_id\": \"1722236400::0020393a-4d79-11ef-8c67-cfca366fc35d\"\n }\n]", "_postman_previewlanguage": "json" } ] }, { "name": "Get Event", "request": { "method": "GET", "url": { "raw": "{{telemetryUrl}}/v1/subscriber/:subscriber_id/event/:event_id", "host": [ "{{telemetryUrl}}" ], "path": [ "v1", "subscriber", ":subscriber_id", "event", ":event_id" ], "variable": [ { "key": "subscriber_id", "value": "", "description": "Unique Subscriber ID." }, { "key": "event_id", "value": "", "description": "Unique Event ID." } ] }, "description": "## Accepted Roles (RBAC)\n\nAdministrator, Network Operations, Subscriber Accounts, Subscriber Administrator, Subscriber Support, Subscriber Telemetry, Subscriber View\n\n## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"time\": \"2024-08-05T12:46:32+00:00\",\n \"domain\": \"isp.com\",\n \"subscriber_id\": \"00034ae6-4d79-11ef-80c4-174adb24f2cd\",\n \"virtual_id\": \"465be807-54f1-4bf6-b940-398ed95cdbe7\",\n \"username\": \"test@isp.com\",\n \"facility\": \"Authentication\",\n \"severity\": \"info\",\n \"message\": \"Authentication: Authentication login success\\nUsername: test@isp.com\\nVirtual-Router-ID: 465be807-54f1-4bf6-b940-398ed95cdbe7\\nRequest:\\nuser-name: test@isp.com\\nchap-password: 0x661112163bf93a571d5f924c7ef868aba9\\nnas-ip-address: 172.16.123.5\\nnas-port: 100\\nservice-type: Framed-User\\nframed-protocol: PPP\\nnas-identifier: mx204\\nchap-challenge: 0xdf206be846a226de8b61b741f2d703606499b1db80\\nnas-port-type: Ethernet\\nacct-session-id: 89195146\\nnas-port-id: ae2:114-100\\nchargeable-user-identity: 0x00\\nerx-pppoe-description: pppoe 70:a7:41:38:ed:f9\\nerx-dhcp-mac-addr: 70a7.4138.edf9\\nerx-qos-set-name: ae2-114\\nerx-client-profile-name: PPPOE:\\ncalabiyau-client-ip-address: 172.16.123.5\\ncalabiyau-nas-profile: JUNIPER\\ncalabiyau-nas-id: 19b88f68-0e9b-423f-82c8-2d4a5f83d4e3\\ncalabiyau-user-id: 00034ae6-4d79-11ef-80c4-174adb24f2cd\",\n \"region\": \"South Africa\",\n \"event_id\": \"1722859200::bd44210d-5328-11ef-bf64-cfca366fc35d\"\n}", "_postman_previewlanguage": "json" } ] } ] }, { "name": "Telemetry - Caller Data Records", "item": [ { "name": "CDR List for one subscriber (last 5 days)", "request": { "method": "GET", "url": { "raw": "{{telemetryUrl}}/v1/subscriber/:subscriber_id/cdr/records", "host": [ "{{telemetryUrl}}" ], "path": [ "v1", "subscriber", ":subscriber_id", "cdr", "records" ], "variable": [ { "key": "subscriber_id", "value": "", "description": "Unique ID of subscriber for which CDR records are to be retrieved" } ] }, "description": "## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"89e88982-cc01-11ee-9127-a5b2efd1bd16::2024-02-01\"\n \"start_time\": \"2024-02-15T12:55:47+00:00\",\n \"update_time\": \"2024-02-15T12:55:47+00:00\",\n \"acct_unique_id\": \"89e88982-cc01-11ee-9127-a5b2efd1bd16\",\n \"username\": \"user@example.com\",\n \"calling_station_id\": \"00:11:22:33:44:55\",\n \"called_station_id\": \"PPPOE SERVER\",\n \"nas_ip_address\": \"192.0.2.20\",\n \"client_ip_address\": \"198.51.100.10\",\n \"duration\": 0,\n \"terminate_cause\": null,\n },\n {\n \"id\": \"36d81884-cc01-11ee-9127-a5b2efd1bd16::2024-02-01\"\n \"start_time\": \"2024-02-15T12:53:28+00:00\",\n \"update_time\": \"2024-02-15T12:53:29+00:00\",\n \"acct_unique_id\": \"36d81884-cc01-11ee-9127-a5b2efd1bd16\",\n \"username\": \"user@example.com\",\n \"calling_station_id\": \"00:11:22:33:44:66\",\n \"called_station_id\": \"PPPOE SERVER\",\n \"nas_ip_address\": \"192.0.2.20\",\n \"client_ip_address\": \"198.51.100.11\",\n \"duration\": 0,\n \"terminate_cause\": \"User-Request\",\n }\n]", "_postman_previewlanguage": "json" } ] }, { "name": "CDR List for one subscriber (date range)", "request": { "method": "POST", "url": { "raw": "{{telemetryUrl}}/v1/subscriber/:subscriber_id/cdr/records", "host": [ "{{telemetryUrl}}" ], "path": [ "v1", "subscriber", ":subscriber_id", "cdr", "records" ], "variable": [ { "key": "subscriber_id", "value": "", "description": "Unique ID of subscriber for which CDR records are to be retrieved." } ] }, "description": "## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Timezone", "value": "{{timezone}}", "description": "Timezone for response datetime property values. (default UTC)", "type": "text" }, { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"start_time\": \"2024-02-01T00:00:00+00:00\",\n \"end_time\": \"2024-02-15T00:00:00+00:00\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"89e88982-cc01-11ee-9127-a5b2efd1bd16::2024-02-01\"\n \"start_time\": \"2024-02-15T12:55:47+00:00\",\n \"update_time\": \"2024-02-15T12:55:47+00:00\",\n \"acct_unique_id\": \"89e88982-cc01-11ee-9127-a5b2efd1bd16\",\n \"username\": \"user@example.com\",\n \"calling_station_id\": \"00:11:22:33:44:55\",\n \"called_station_id\": \"PPPOE SERVER\",\n \"nas_ip_address\": \"192.0.2.20\",\n \"client_ip_address\": \"198.51.100.10\",\n \"duration\": 0,\n \"terminate_cause\": null,\n }\n]", "_postman_previewlanguage": "json" } ] }, { "name": "CDR record", "request": { "method": "GET", "url": { "raw": "{{telemetryUrl}}/v1/subscriber/cdr/record/:cdr_id", "host": [ "{{telemetryUrl}}" ], "path": [ "v1", "subscriber", "cdr", "record", ":cdr_id" ], "variable": [ { "key": "cdr_id", "value": "", "description": "Unique ID of the CDR record, in the form \"acct_unique_id::month\" (e.g. as returned by the IP Query endpoint)." } ] }, "description": "## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **404** Not Found\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ] }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"89e88982-cc01-11ee-9127-a5b2efd1bd16::2024-02-01\",\n \"start_time\": \"2024-02-15T12:55:47+00:00\",\n \"update_time\": \"2024-02-15T12:55:47+00:00\",\n \"acct_session_id\": \"9f2c1a10\",\n \"acct_unique_id\": \"89e88982-cc01-11ee-9127-a5b2efd1bd16\",\n \"name\": \"Example Subscriber\",\n \"username\": \"user@example.com\",\n \"calling_station_id\": \"00:11:22:33:44:55\",\n \"called_station_id\": \"PPPOE SERVER\",\n \"nas_ip_address\": \"192.0.2.20\",\n \"nas_identifier\": \"NAS-1\",\n \"nas_port\": \"0\",\n \"nas_port_type\": \"Ethernet\",\n \"nas_port_id\": \"eth0\",\n \"client_ip_address\": \"198.51.100.10\",\n \"realm\": \"example.com\",\n \"realm_id\": null,\n \"duration\": 3600,\n \"upload\": 1,\n \"download\": 5,\n \"framed_protocol\": \"PPP\",\n \"vrf\": null,\n \"client_mac_address\": \"00:11:22:33:44:55\",\n \"policy_in\": null,\n \"policy_out\": null,\n \"imsi\": null,\n \"msisdn\": null,\n \"charging_id\": null,\n \"sgsn_address\": null,\n \"ggsn_address\": null,\n \"terminate_cause\": \"User-Request\",\n \"profile\": \"Premium-100\",\n \"service\": \"subscriber_cdr\",\n \"virtual\": \"ExampleAAA\",\n \"iplog\": [\n {\n \"prefix_type\": \"framed-ip-address\",\n \"prefix\": \"198.51.100.10\"\n }\n ]\n}", "_postman_previewlanguage": "json" } ] } ] }, { "name": "Telemetry - IP Query", "item": [ { "name": "IP Query", "request": { "method": "POST", "url": { "raw": "{{telemetryUrl}}/v1/subscriber/ip_query", "host": [ "{{telemetryUrl}}" ], "path": [ "v1", "subscriber", "ip_query" ] }, "description": "## Status Codes\n\n- **200** OK\n- **400** Bad Request\n- **401** Unauthorized / Require Authentication\n- **403** Forbidden / Access Denied\n- **409** Conflict\n- **429** Too Many Requests / Your Rate Limited\n- **5xx** Service Unavailable", "header": [ { "key": "X-Domain", "value": "{{domain}}", "description": "Optional domain context for the request. (default: the token domain)", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"time\": \"2024-02-16T10:00:00+00:00\",\n \"ip\": \"198.51.100.10\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"33b934f0-cc81-11ee-a3ca-9d2f10704be2::2024-02-01\",\n \"start_time\": \"2024-02-16T04:09:38+00:00\",\n \"update_time\": \"2024-02-16T10:09:39+00:00\",\n \"acct_unique_id\": \"33b934f0-cc81-11ee-a3ca-9d2f10704be2\",\n \"prefix_type\": \"framed-ip-address\",\n \"prefix\": \"198.51.100.10\",\n \"username\": \"user@example.com\",\n \"calling_station_id\": \"00:11:22:33:44:55\",\n \"nas_ip_address\": \"192.0.2.20\",\n \"nas_identifier\": \"NAS-1\",\n \"service\": \"Premium-100\",\n \"virtual\": \"ExampleAAA\"\n }\n]", "_postman_previewlanguage": "json" } ] } ] } ] }