This section provides an overview of the OkeyProxy Agent API, designed for managing sec-user accounts, assigning rotating proxy plans, and generating authenticated proxy endpoints.
Overview
The OkeyProxy Agent API allows agents to programmatically manage their sec-user accounts, assign traffic-based rotating proxy plans, and generate authenticated proxy endpoints for their users. It supports operations such as:- Creating, editing, enabling/disabling sec-user accounts
- Assigning or querying proxy plans and usage
- Generating proxy endpoints by location, session type, and protocol
- Viewing historical and real-time usage logs
Authentication
All API requests require anapiKey which is unique to each agent account. This API key must be provided either:
- In the request body for
POSTendpoints, or - As a query parameter for
GETendpoints
Bearer or OAuth scheme. Example usage:
How to Obtain Your Agent API Key
To access and use the OkeyProxy Agent API, you need a validapiKey. Follow the steps below to obtain one:
- Register an account on OkeyProxy
- Contact @OkeyProxy_support to apply for Agent access
- Once your application is approved, your account will be upgraded with Agent-level permissions and access to the Agent Dashboard
- Log in to the Dashboard and navigate to the Agent API section to generate your Agent API Key
Proxy Type Reference
Each rotating proxy plan is categorized into three types:| Proxy Type | Plan Name | Description |
|---|---|---|
| 1 | Starter | Rotating datacenter proxies |
| 2 | Advanced | Rotating residential proxies |
| 3 | Premium | Rotating residential proxies with best-performing IPs |
proxyType when assigning plans or generating proxy endpoints.
Example Use Cases
-
💼 Onboard new sub-users
Use/api/v2/secUser/addto create a new sec-user account and receive proxy credentials. -
📦 Assign proxy traffic
Use/api/v2/secUser/addPlanor/api/v2/secUser/addPlan/detailsto allocate GB-based traffic to a sec-user. -
🌍 Custom proxy routing
Use/api/v2/proxy/endpoints/customto generate geo-targeted, sticky or rotating proxy endpoints with specified session times and protocols. -
📊 Monitor usage and history
Use/api/v2/logsto track API activity and/api/v2/plan/listto monitor active plans and traffic consumption.