Subscriber Profiles API

Reference material for usage on Subscriber Management > Subscriber Profiles.

GET

/v1/profiles

(subscriber)

List Radius Profiles.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
id	query	string	Filter by id. (can suffix with wildcard )*
l	query	integer	Paginate Limit / Entities per Page. (1-50, -1 for streaming)
name	query	string	Filter by name. (can suffix with wildcard )*
p	query	integer	Paginate Current Page. (default 1)
sc	query	string	Sort by Property/Column. (id, name)
sd	query	string	Sort direction. asc for Ascending or desc for Descending

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
id	body	string	Unique ID of profile.
metadata.page	body	integer	Current Page. (always 1 for infinite)
metadata.pages	body	integer	Total Pages. (always 1 for infinite)
metadata.per_page	body	integer	Equeal to the entities per page limit or always equal to total records for infinite queries.
metadata.records	body	integer	Total entities found. (always max 250 unless infinite is accepted query parameter)
name	body	string	Name given to profile.

Response Example

{
    "payload": [
        {
            "id": "03a0a715-b93a-49b1-9ad6-f9f03053e070",
            "name": "25Mbit/s Uncapped"
        },
        {
            "id": "05a2968d-958b-47ef-880f-9b01f0aabb6b",
            "name": "50Mbit/s Uncapped"
        }
    ],
    "metadata": {
        "records": 2,
        "page": 1,
        "pages": 1
    }
}

GET

/v1/profile/{profile_id}

(subscriber)

Show profile.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
profile_id	url	string	Profile Id.	X

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
creation_time	body	integer	Creation Time.
domain	body	string	Entity Domain.
download	body	string	Download.
id	body	string	Unique Entity ID.
name	body	string	Name of Entity.
pool_id	body	string	Pool Id.
pool_id_deactivate	body	string	Pool Id Deactivate.
session_limit	body	integer	Session Limit.
uncapped_data	body	boolean	Uncapped Data.
upload	body	string	Upload.

Response Example

{
    "id": "11a0d490-e154-4687-ab79-62d3aa0cd7c3",
    "domain": "surf4life.co.za",
    "name": "25 Mbps Uncapped Sync edit",
    "uncapped_data": true,
    "pool_id": null,
    "pool_id_deactivate": null,
    "upload": "25.000",
    "download": "25.000",
    "session_limit": 0,
    "creation_time": "2023-06-13T14:45:04.000Z"
}

POST

/v1/profile

(subscriber)

Create a profile.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
download	body	string	Download.
name	body	string	Name of Entity.	X
pool_id	body	string	Pool Id.	X
pool_id_deactivate	body	string	Pool Id Deactivate.	X
session_limit	body	integer	Session Limit.	X
uncapped_data	body	boolean	Uncapped Data.	X
upload	body	string	Upload.

Request Example

{
    "name": "25 Mbps Uncapped Sync edit",
    "uncapped_data": true,
    "pool_id": null,
    "pool_id_deactivate": null,
    "upload": "25.000",
    "download": "25.000",
    "session_limit": 0
}

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
creation_time	body	integer	Creation Time.
domain	body	string	Entity Domain.
download	body	string	Download.
id	body	string	Unique Entity ID.
name	body	string	Name of Entity.
pool_id	body	string	Pool Id.
pool_id_deactivate	body	string	Pool Id Deactivate.
session_limit	body	integer	Session Limit.
uncapped_data	body	boolean	Uncapped Data.
upload	body	string	Upload.

Response Example

{
    "id": "11a0d490-e154-4687-ab79-62d3aa0cd7c3",
    "domain": "surf4life.co.za",
    "name": "25 Mbps Uncapped Sync edit",
    "uncapped_data": true,
    "pool_id": null,
    "pool_id_deactivate": null,
    "upload": "25.000",
    "download": "25.000",
    "session_limit": 0,
    "creation_time": "2023-06-13T14:45:04.000Z"
}

PATCH

/v1/profile/{profile_id}

(subscriber)

Update a profile.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
profile_id	url	string	Profile Id.	X
download	body	string	Download.
name	body	string	Name of Entity.
pool_id	body	string	Pool Id.
pool_id_deactivate	body	string	Pool Id Deactivate.
session_limit	body	integer	Session Limit.
uncapped_data	body	boolean	Uncapped Data.
upload	body	string	Upload.

Request Example

{
    "name": "25 Mbps Uncapped Sync edit",
    "upload": "25.000",
    "download": "25.000",
    "session_limit": 0
}

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
creation_time	body	integer	Creation Time.
domain	body	string	Entity Domain.
download	body	string	Download.
id	body	string	Unique Entity ID.
name	body	string	Name of Entity.
pool_id	body	string	Pool Id.
pool_id_deactivate	body	string	Pool Id Deactivate.
session_limit	body	integer	Session Limit.
uncapped_data	body	boolean	Uncapped Data.
upload	body	string	Upload.

Response Example

{
    "id": "11a0d490-e154-4687-ab79-62d3aa0cd7c3",
    "domain": "surf4life.co.za",
    "name": "25 Mbps Uncapped Sync edit",
    "uncapped_data": true,
    "pool_id": null,
    "pool_id_deactivate": null,
    "upload": "25.000",
    "download": "25.000",
    "session_limit": 0,
    "creation_time": "2023-06-13T14:45:04.000Z"
}

DELETE

/v1/profile/{profile_id}

(subscriber)

Delete a profile.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
profile_id	url	string	Profile Id.	X

Response Status Codes

Code	Meaning
204	OK - No Content
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Navigation

Subscriber Profiles API