Retrieves a paginated list of subscribers.
Name Located in Description Required Type Username query Optional. Filter subscribers by username. No string Email query Optional. Filter subscribers by email address. No string AccessToken query Optional. Filter subscribers by access token. No string StatusId query Optional. Filter subscribers by status. No integer Expired query Optional. Filter subscribers by expiration status. Set to true to only include subscribers whose subscriptions have expired. No boolean SortBy query Optional. Specifies the sort order of the subscribers. Supports sorting by 'username', 'username_desc', 'expiresAt', and 'expiresAt_desc'. Defaults to ascending order by subscriber ID if not specified. No string Page query Page number to retrieve. Default is 1. No integer PageSize query Number of records per page. Default is 25. No integer
Code Description 200 Success
Creates a new subscriber with the specified details.
{
"username" : "string" ,
"email" : "string" ,
"expiresAt" : "2024-03-20T16:28:54.442Z" ,
"maxConnections" : 0 ,
"isTrial" : true ,
"note" : "string" ,
"hls" : true ,
"mpegTs" : true ,
"bundles" : [
0
],
"ipAddresses" : [
"string"
],
"userAgents" : [
"string"
],
"countries" : [
"string"
]
}
Copy to clipboard Code Description 200 Success 422 Validation error if the input parameters are incorrect.
Retrieves a subscriber by ID.
Name Located in Description Required Type id path The ID of the subscriber to retrieve. Yes integer include query The related data to include. Possible values are bundles, ipAddresses, userAgents, and countries. No string
Code Description 200 Success 422 Validation error if the input parameters are incorrect.
Updates an existing subscriber with the specified details.
Name Located in Description Required Type id path The ID of the subscriber to update. Yes integer
{
"username" : "string" ,
"email" : "string" ,
"expiresAt" : "2024-03-22T15:01:50.107Z" ,
"maxConnections" : 0 ,
"isTrial" : true ,
"note" : "string" ,
"hls" : true ,
"mpegTs" : true ,
"bundles" : [
0
],
"ipAddresses" : [
"string"
],
"userAgents" : [
"string"
],
"countries" : [
"string"
]
}
Copy to clipboard Code Description 200 If the subscriber was successfully updated. 422 Validation error if the input parameters are incorrect.
Deletes an existing subscriber.
Name Located in Description Required Type id path The ID of the subscriber to delete. Yes integer
Code Description 200 If the subscriber was successfully deleted. 422 Validation error if the input parameters are incorrect.
Retrieves a subscriber by access token.
Name Located in Description Required Type accessToken path The access token of the subscriber to retrieve. Yes string include query The related data to include. Possible values are bundles, ipAddresses, userAgents, and countries. No string
Code Description 200 Success 422 Validation error if the input parameters are incorrect.
Regenerates the access token for a specific subscriber, revoking any current access.
Name Located in Description Required Type id path The ID of the subscriber whose access token is to be regenerated. Yes integer
{
"id" : 0 ,
"accessToken" : "string" ,
"username" : "string" ,
"email" : "string" ,
"expiresAt" : "2024-03-20T16:34:46.618Z" ,
"maxConnections" : 0 ,
"isTrial" : true ,
"note" : "string" ,
"status" : 0 ,
"hls" : true ,
"mpegTs" : true
}
Copy to clipboard Code Description 200 Success
Retrieves a list of subscriber statues.
Code Description 200 Success
