Improved, well-documented Postman collection for the Reseller API.
\nr-api-key header.reseller_api_key: Your reseller API key.
reseller_sub_user_id: A sub-user ID you own.
Unless otherwise specified, responses follow:
\n{\n \"data\": any,\n \"metadata\": any | undefined,\n \"message\": string | undefined\n}\n\nUse one of:
\nRESIDENTIAL-PREMIUM
\nROTATING-DATACENTER
\nCreate a sub-user.
\nAuth:
\nr-api-key: Body (CreateSubUserDto):
\nemail: string (email)
\nusername: string (alphanumeric + underscore)
\npassword: string (exactly 36 chars)
\ntraffic_limit: number (MB)
\nserviceType: enum [RESIDENTIAL-PREMIUM, SHARED-DATACENTER, HTML-SCRAPPER]
\ncurrent_period_end: string (ISO 8601, optional)
\nNotes:
\nRequires your reseller subscription to be active.
\nValidates username uniqueness and password length.
\nResponse:
\n200: { data: ResellerSubUser, message: 'createSubUser' }
\n409: No active service | Access denied | Email already exist
\nGet a sub-user by ID. Adds authorization credentials to the response.
\nResponse:
\nUpdate sub-user. All fields optional.
\nBody (UpdateSubUserDto):
\nResponse:
\nDelete sub-user by ID.
\nResponse:
\nGet current bandwidth usage and limit for a sub-user.
\nResponse:
\nusageBandwidth - In bytes.
trafficLimitInBytes - In bytes.
List sub-users with pagination and optional filters.
\nQuery (GetResellerSubUsersDto + BaseQueryDTO):
\nperPage: number (1-100)
\npageNumber: number (>=1)
\nserviceType: enum [RESIDENTIAL-PREMIUM, SHARED-DATACENTER, HTML-SCRAPPER] (optional)
\nsortBy: string (optional)
\nsortOrder: 'desc' | 'asc' (optional)
\ncontains: base64 string (optional)
\nsearchKey: string (optional)
\nfilters: string (optional)
\nResponse:
\n1-100 items per page
\n","type":"text/plain"},"key":"perPage","value":"25"},{"description":{"content":"Page number (>=1)
\n","type":"text/plain"},"key":"pageNumber","value":"1"},{"description":{"content":"Optional filter
\n","type":"text/plain"},"key":"serviceType","value":"RESIDENTIAL-PREMIUM"},{"description":{"content":"Optional field to sort by
\n","type":"text/plain"},"key":"sortBy","value":""},{"description":{"content":"desc|asc
\n","type":"text/plain"},"key":"sortOrder","value":"desc"},{"description":{"content":"Optional search (base64-encoded)
\n","type":"text/plain"},"key":"contains","value":""},{"description":{"content":"Optional field to search against
\n","type":"text/plain"},"key":"searchKey","value":""},{"description":{"content":"Optional structured filters string
\n","type":"text/plain"},"key":"filters","value":""}],"variable":[]}},"response":[{"id":"4a1ae4a9-42e2-4d33-a70e-73aad23284bc","name":"200 OK","originalRequest":{"header":[]},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n { \"id\": \"{{reseller_sub_user_id}}\", \"email\": \"sub.user@example.com\", \"serviceType\": \"RESIDENTIAL-PREMIUM\", \"username\": \"d23284d2Xdasd\",\n\t\t\t\"apiKey\": \"c14c82ac-7ab6-4b01-9b90-77065e57bf12\",\n\t\t\t\"trafficLimitInBytes\": 1000000000,\n\t\t\t\"usageBandwidth\": 10240230}\n ],\n \"metadata\": { \"count\": 1, \"perPage\": 25, \"pageNumber\": 1 }\n}"}],"_postman_id":"02a3a6cc-1596-4d38-8f0a-1dbd304a7343"},{"name":"/reseller/sub-users/allocated-traffic","id":"e46daceb-594b-4aa3-a156-f4e5bd4f285a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"r-api-key","value":"","type":"text"}],"url":"https://app-api.geonode.com/api/reseller/sub-users/allocated-traffic","description":"Get total allocated bandwidth (MB) and count of active sub-users.
\nResponse:
\nGet whitelisted IPs for a sub-user.
\nResponse:
\nAdd IPs to whitelist for a sub-user.
\nBody (WhitelistIpsDto):
\nResponse:
\nRemove IPs from whitelist for a sub-user.
\nBody (DeleteWhiteListedIpsDTO):
\nResponse:
\nReseller API key
\n","type":"text"}],"url":"https://monitor.geonode.com/statistics/:serviceType/per-period?granularity={{granularity}}&dateFrom={{dateFrom}}&dateTo={{dateTo}}&subUserFilter={{subUserFilter}}","description":"Returns aggregate statistics grouped by time period defined by granularity.
\nUse case:
\nPath parameter:
\nserviceType (enum)
\nRESIDENTIAL-PREMIUM
\nROTATING-DATACENTER
\nConstraints:
\nMaximum 720 units between dateFrom and dateTo based on granularity
\ndate range is inclusive
\nRequired headers:
\nAggregation unit, minute | hour | day
\n","type":"text/plain"},"key":"granularity","value":"{{granularity}}"},{"description":{"content":"Inclusive ISO date string, example 2026-01-01T00:00:00Z
\n","type":"text/plain"},"key":"dateFrom","value":"{{dateFrom}}"},{"description":{"content":"Inclusive ISO date string, example 2026-01-02T00:00:00Z
\n","type":"text/plain"},"key":"dateTo","value":"{{dateTo}}"},{"description":{"content":".all | .master | specific subuser id
\n","type":"text/plain"},"key":"subUserFilter","value":"{{subUserFilter}}"}],"variable":[{"type":"any","value":"","key":"serviceType"}]}},"response":[],"_postman_id":"ecc6da93-ca19-4317-88fc-44229f15d93d"},{"name":"Statistics - Aggregate by target host and target country (paginated table)","id":"4261f4a1-d885-4cc5-bc00-fead05de8eb5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"r-api-key","value":"{{r-api-key}}","description":"Reseller API key
\n","type":"text"}],"url":"https://monitor.geonode.com/statistics/:serviceType/per-subuser-host-country?granularity={{granularity}}&dateFrom={{dateFrom}}&dateTo={{dateTo}}&subUserFilter={{subUserFilter}}&limit={{limit}}&offset={{offset}}","description":"Returns aggregate statistics grouped by target country and target host.
\nUse case:
\nPath parameter:
\nserviceType (enum)
\nRESIDENTIAL-PREMIUM
\nROTATING-DATACENTER
\nConstraints:
\nMaximum 720 units between dateFrom and dateTo based on granularity
\ndate range is inclusive
\nRequired headers:
\nAggregation unit, minute | hour | day
\n","type":"text/plain"},"key":"granularity","value":"{{granularity}}"},{"description":{"content":"Inclusive ISO date string, example 2026-01-01T00:00:00Z
\n","type":"text/plain"},"key":"dateFrom","value":"{{dateFrom}}"},{"description":{"content":"Inclusive ISO date string, example 2026-01-02T00:00:00Z
\n","type":"text/plain"},"key":"dateTo","value":"{{dateTo}}"},{"description":{"content":".all | .master | specific subuser id
\n","type":"text/plain"},"key":"subUserFilter","value":"{{subUserFilter}}"},{"description":{"content":"Pagination size, integer from 1 to 5000
\n","type":"text/plain"},"key":"limit","value":"{{limit}}"},{"description":{"content":"Pagination offset
\n","type":"text/plain"},"key":"offset","value":"{{offset}}"}],"variable":[{"type":"any","value":"","key":"serviceType"}]}},"response":[],"_postman_id":"4261f4a1-d885-4cc5-bc00-fead05de8eb5"}],"event":[{"listen":"prerequest","script":{"id":"346e71cb-2f87-41f9-9e18-64dc52729863","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"081575ea-612e-4340-827c-dd939661a93a","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"variable":[{"key":"reseller_api_key","value":""},{"key":"serviceType","value":"RESIDENTIAL-PREMIUM","description":"The proxy service type. Allowed values: RESIDENTIAL-PREMIUM, ROTATING-DATACENTER"}]}