Resellers

List subusers

get

Get a list of all subusers. Optionally filter by name to select a username.

Authorizations
AuthorizationstringRequired

Bearer authentication with sentinel token for users.

You can use the following command to get the bearer token:

curl -d '{"username":"<username>", "password":"<password>"}' -H "Content-Type: application/json" -X POST -s https://api.goproxies.com/api/v1/login | jq -r '.token'

Substitute <username> and <password> with your credentials.

Query parameters
usernamestringOptional

Filter by username

limitintegerOptional

Limit the number of results

Default: 1000
offsetintegerOptional

Offset the results

Default: 0
Responses
200

OK

application/json
get
/api/v1/reseller/subusers

Create a new subuser

post

Create a subuser with optional limits. If limits are set the period starts at the time of the call.

Authorizations
AuthorizationstringRequired

Bearer authentication with sentinel token for users.

You can use the following command to get the bearer token:

curl -d '{"username":"<username>", "password":"<password>"}' -H "Content-Type: application/json" -X POST -s https://api.goproxies.com/api/v1/login | jq -r '.token'

Substitute <username> and <password> with your credentials.

Body
usernamestringRequired
enabledbooleanOptional
traffic_limit_amountnumberOptional

Traffic limit amount in GB

traffic_limit_unitstringOptionalDeprecated

Traffic limit unit

period_secondsintegerOptional

Traffic limit period in seconds

recurringbooleanOptional

Whether the traffic limit is recurring

Responses
200

OK

application/json
post
/api/v1/reseller/subusers

Get details for a subuser

get

Get a details of a subuser e.g. statistics of traffic usage.

Authorizations
AuthorizationstringRequired

Bearer authentication with sentinel token for users.

You can use the following command to get the bearer token:

curl -d '{"username":"<username>", "password":"<password>"}' -H "Content-Type: application/json" -X POST -s https://api.goproxies.com/api/v1/login | jq -r '.token'

Substitute <username> and <password> with your credentials.

Path parameters
usernamestringRequired

Subuser's username

Responses
200

OK

application/json
get
/api/v1/reseller/subusers/{username}

Update a subuser

put

Update a subuser limits. Set all to 0 to remove them. If the user already has limits set, the period start time stays the same, otherwise it is set to the time of the call.

Authorizations
AuthorizationstringRequired

Bearer authentication with sentinel token for users.

You can use the following command to get the bearer token:

curl -d '{"username":"<username>", "password":"<password>"}' -H "Content-Type: application/json" -X POST -s https://api.goproxies.com/api/v1/login | jq -r '.token'

Substitute <username> and <password> with your credentials.

Path parameters
usernamestringRequired

Subuser's username

Body
traffic_limit_amountnumberOptional

Traffic limit amount in GB

traffic_limit_unitstringOptionalDeprecated

Traffic limit unit

period_secondsintegerOptional

Traffic limit period in seconds

recurringbooleanOptional

Whether the traffic limit is recurring

Responses
200

OK

application/json
put
/api/v1/reseller/subusers/{username}

Delete a subuser

delete
Authorizations
AuthorizationstringRequired

Bearer authentication with sentinel token for users.

You can use the following command to get the bearer token:

curl -d '{"username":"<username>", "password":"<password>"}' -H "Content-Type: application/json" -X POST -s https://api.goproxies.com/api/v1/login | jq -r '.token'

Substitute <username> and <password> with your credentials.

Path parameters
usernamestringRequired

Subuser's username

Responses
200

OK

No content

delete
/api/v1/reseller/subusers/{username}

No content

Reset a subuser's limits

put

Resets the current limit for an subuser, starting a new period. If a subuser has no limit this call will fail.

Authorizations
AuthorizationstringRequired

Bearer authentication with sentinel token for users.

You can use the following command to get the bearer token:

curl -d '{"username":"<username>", "password":"<password>"}' -H "Content-Type: application/json" -X POST -s https://api.goproxies.com/api/v1/login | jq -r '.token'

Substitute <username> and <password> with your credentials.

Path parameters
usernamestringRequired

Subuser's username

Responses
200

OK

application/json
put
/api/v1/reseller/subusers/{username}/reset-limits

Reset a subuser's secret

put

Reset a subuser's secret with a randomly generated password.

Authorizations
AuthorizationstringRequired

Bearer authentication with sentinel token for users.

You can use the following command to get the bearer token:

curl -d '{"username":"<username>", "password":"<password>"}' -H "Content-Type: application/json" -X POST -s https://api.goproxies.com/api/v1/login | jq -r '.token'

Substitute <username> and <password> with your credentials.

Path parameters
usernamestringRequired

Subuser's username

Responses
200

OK

application/json
put
/api/v1/reseller/subusers/{username}/reset-secret

Enable a subuser

put
Authorizations
AuthorizationstringRequired

Bearer authentication with sentinel token for users.

You can use the following command to get the bearer token:

curl -d '{"username":"<username>", "password":"<password>"}' -H "Content-Type: application/json" -X POST -s https://api.goproxies.com/api/v1/login | jq -r '.token'

Substitute <username> and <password> with your credentials.

Path parameters
usernamestringRequired

Subuser's username

Responses
200

OK

application/json
put
/api/v1/reseller/subusers/{username}/enable

Disable a subuser

put
Authorizations
AuthorizationstringRequired

Bearer authentication with sentinel token for users.

You can use the following command to get the bearer token:

curl -d '{"username":"<username>", "password":"<password>"}' -H "Content-Type: application/json" -X POST -s https://api.goproxies.com/api/v1/login | jq -r '.token'

Substitute <username> and <password> with your credentials.

Path parameters
usernamestringRequired

Subuser's username

Responses
200

OK

application/json
put
/api/v1/reseller/subusers/{username}/disable

Last updated

Was this helpful?