Subscriber BOOST API

Reference material for usage on Subscriber Management > Subscriber Boost.

GET

/v1/boosts/{subscriber_id}

(subscriber)

List Boost Entries.

Service
subscriber

Accepted Roles (RBAC)

AdministratorCustomerNetwork OperationsStaff MemberSubscriber AccountsSubscriber AdministratorSubscriber SupportSupport

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Tenant-ID	header	string	Request Tenant Context.
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
subscriber_id	url	string	Subscriber Id.	X
boost_download	query	integer	Filter by boost_download.
boost_upload	query	integer	Filter by boost_upload.
l	query	integer	Paginate Limit / Entities per Page. (1-50, -1 for streaming)
p	query	integer	Paginate Current Page. (default 1)
sc	query	string	Sort by Property/Column. (boost_upload, boost_download, boost_expire, creation_time)
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
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
boost_download	body	integer	Download bandwidth MegaBytes.
boost_expire	body	string	Datetime when boost expires.
boost_upload	body	integer	Upload bandwidth MegaBytes.
id	body	string	Unique Entity ID.
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)
subscriber_id	body	string	Subscriber Id.
tenant_id	body	string	Entity Tenant.

Response Example

{
    "payload": [
        {
            "id": "f387b478-669b-11ef-99a7-174adb24f2cd",
            "tenant_id": "0822b8a6-4f3f-4ca9-bde2-88bf84fb8ba0",
            "subscriber_id": "00034ae6-4d79-11ef-80c4-174adb24f2cd",
            "boost_upload": 100,
            "boost_download": 100,
            "boost_expire": "2024-08-31T22:00:00.000Z",
            "creation_time": "2024-08-30T06:49:06.000Z"
        }
    ],
    "metadata": {
        "records": 1,
        "page": 1,
        "pages": 1,
        "per_page": 10
    }
}

GET

/v1/boost/{boost_id}

(subscriber)

Show Boost Entry.

Service
subscriber

Accepted Roles (RBAC)

AdministratorCustomerNetwork OperationsStaff MemberSubscriber AccountsSubscriber AdministratorSubscriber SupportSupport

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Tenant-ID	header	string	Request Tenant Context.
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
boost_id	url	string	Boost 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
boost_download	body	integer	Download bandwidth MegaBytes.
boost_expire	body	string	Datetime when boost expires.
boost_upload	body	integer	Upload bandwidth MegaBytes.
id	body	string	Unique Entity ID.
subscriber_id	body	string	Subscriber Id.
tenant_id	body	string	Entity Tenant.

Response Example

{
    "id": "f387b478-669b-11ef-99a7-174adb24f2cd",
    "tenant_id": "0822b8a6-4f3f-4ca9-bde2-88bf84fb8ba0",
    "subscriber_id": "00034ae6-4d79-11ef-80c4-174adb24f2cd",
    "boost_upload": 100,
    "boost_download": 100,
    "boost_expire": "2024-08-31T22:00:00.000Z",
    "creation_time": "2024-08-30T06:49:06.000Z"
}

POST

/v1/boost

(subscriber)

Create Boost Entry.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber AccountsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Tenant-ID	header	string	Request Tenant Context.
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
boost_download	body	integer	Download bandwidth MegaBytes.	X
boost_expire	body	string	Datetime when boost expires.	X
boost_upload	body	integer	Upload bandwidth MegaBytes.	X
subscriber_id	body	string	Subscriber Id.	X

Request Example

{
    "subscriber_id": "00034ae6-4d79-11ef-80c4-174adb24f2cd",
    "boost_upload": 100,
    "boost_download": 100
}

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
boost_download	body	integer	Download bandwidth MegaBytes.
boost_expire	body	string	Datetime when boost expires.
boost_upload	body	integer	Upload bandwidth MegaBytes.
id	body	string	Unique Entity ID.
subscriber_id	body	string	Subscriber Id.
tenant_id	body	string	Entity Tenant.

Response Example

{
    "id": "f387b478-669b-11ef-99a7-174adb24f2cd",
    "tenant_id": "0822b8a6-4f3f-4ca9-bde2-88bf84fb8ba0",
    "subscriber_id": "00034ae6-4d79-11ef-80c4-174adb24f2cd",
    "boost_upload": 100,
    "boost_download": 100,
    "boost_expire": "2024-08-31T22:00:00.000Z",
    "creation_time": "2024-08-30T06:49:06.000Z"
}

PATCH

/v1/boost/{boost_id}

(subscriber)

Update Boost Entry.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber AccountsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Tenant-ID	header	string	Request Tenant Context.
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
boost_id	url	string	Boost Id.	X
boost_download	body	integer	Download bandwidth MegaBytes.
boost_expire	body	string	Datetime when boost expires.
boost_upload	body	integer	Upload bandwidth MegaBytes.

Request Example

{
    "boost_upload": 100,
    "boost_download": 100,
    "boost_expire": "2024-08-31T22:00:00.000Z"
}

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
boost_download	body	integer	Download bandwidth MegaBytes.
boost_expire	body	string	Datetime when boost expires.
boost_upload	body	integer	Upload bandwidth MegaBytes.
id	body	string	Unique Entity ID.
subscriber_id	body	string	Subscriber Id.
tenant_id	body	string	Entity Tenant.

Response Example

{
    "id": "f387b478-669b-11ef-99a7-174adb24f2cd",
    "tenant_id": "0822b8a6-4f3f-4ca9-bde2-88bf84fb8ba0",
    "subscriber_id": "00034ae6-4d79-11ef-80c4-174adb24f2cd",
    "boost_upload": 100,
    "boost_download": 100,
    "boost_expire": "2024-08-31T22:00:00.000Z",
    "creation_time": "2024-08-30T06:49:06.000Z"
}

DELETE

/v1/boost/{boost_id}

(subscriber)

Delete Boost Entry.

Service
subscriber

Accepted Roles (RBAC)

AdministratorNetwork OperationsSubscriber AccountsSubscriber Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Tenant-ID	header	string	Request Tenant Context.
boost_id	url	string	Boost 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 BOOST API