# Proxy Settings Manage port, domain, and URL whitelisting for residential proxies ## Get proxy settings > Returns approved proxy settings (ports, domains, URLs), pending requests, and KYC verification status for a residential sub-user. ```json {"openapi":"3.0.0","info":{"title":"PlainProxies API v2","version":"2.0.0"},"tags":[{"name":"Proxy Settings","description":"Manage port, domain, and URL whitelisting for residential proxies"}],"servers":[{"url":"https://dashboard.plainproxies.com/api/v2","description":"Production API Server"},{"url":"https://plainproxies-sandbox.com/api/v2","description":"Sandbox API Server"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","description":"API Key authentication. Get your key from the Dashboard Settings page. Include in all requests as: `X-API-KEY: PlainProxies_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`","name":"X-API-KEY","in":"header"}}},"paths":{"/sub-users/{uuid}/proxy-settings":{"get":{"tags":["Proxy Settings"],"summary":"Get proxy settings","description":"Returns approved proxy settings (ports, domains, URLs), pending requests, and KYC verification status for a residential sub-user.","operationId":"46177bd5e73d166fe92bce8efdaf6a0f","parameters":[{"name":"uuid","in":"path","description":"Sub-user UUID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"},"data":{"properties":{"is_verified":{"type":"boolean"},"approved_settings":{"properties":{"ports":{"type":"array","items":{"type":"integer"}},"domains":{"type":"array","items":{"type":"string"}},"urls":{"type":"array","items":{"type":"string"}}},"type":"object"},"pending_requests":{"type":"array","items":{"type":"object"}},"auto_approved_ports":{"type":"array","items":{"type":"integer"}}},"type":"object"}},"type":"object"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Sub-user not found"}}}}}} ``` ## Create proxy settings request > Creates a new whitelist request for a port, domain, or URL. Mail ports (110, 143, 993, 995) are auto-approved. Other requests require manual approval. Supports bulk requests via the \`requests\` array. Requires KYC verification. ```json {"openapi":"3.0.0","info":{"title":"PlainProxies API v2","version":"2.0.0"},"tags":[{"name":"Proxy Settings","description":"Manage port, domain, and URL whitelisting for residential proxies"}],"servers":[{"url":"https://dashboard.plainproxies.com/api/v2","description":"Production API Server"},{"url":"https://plainproxies-sandbox.com/api/v2","description":"Sandbox API Server"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","description":"API Key authentication. Get your key from the Dashboard Settings page. Include in all requests as: `X-API-KEY: PlainProxies_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`","name":"X-API-KEY","in":"header"}}},"paths":{"/sub-users/{uuid}/proxy-settings":{"post":{"tags":["Proxy Settings"],"summary":"Create proxy settings request","description":"Creates a new whitelist request for a port, domain, or URL. Mail ports (110, 143, 993, 995) are auto-approved. Other requests require manual approval. Supports bulk requests via the `requests` array. Requires KYC verification.","operationId":"3b208aa648eb20b4ecf87d6c888d57d8","parameters":[{"name":"uuid","in":"path","description":"Sub-user UUID","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"title":"Single Request","required":["request_type","value"],"properties":{"request_type":{"type":"string","enum":["port","domain","url"]},"value":{"type":"string"},"reason":{"type":"string","nullable":true}},"type":"object"},{"title":"Bulk Request","required":["requests"],"properties":{"requests":{"type":"array","items":{"required":["request_type","value"],"properties":{"request_type":{"type":"string","enum":["port","domain","url"]},"value":{"type":"string"}},"type":"object"},"maxItems":50},"reason":{"type":"string","nullable":true}},"type":"object"}]}}}},"responses":{"201":{"description":"Request created successfully"},"400":{"description":"Invalid request (non-residential product)"},"401":{"description":"Unauthorized"},"403":{"description":"KYC verification required"},"404":{"description":"Sub-user not found"},"422":{"description":"Validation error or duplicate request"},"429":{"description":"Rate limit exceeded"}}}}}} ``` ## List proxy settings requests > Returns all proxy settings requests (pending, approved, denied) for a sub-user, ordered by newest first. ```json {"openapi":"3.0.0","info":{"title":"PlainProxies API v2","version":"2.0.0"},"tags":[{"name":"Proxy Settings","description":"Manage port, domain, and URL whitelisting for residential proxies"}],"servers":[{"url":"https://dashboard.plainproxies.com/api/v2","description":"Production API Server"},{"url":"https://plainproxies-sandbox.com/api/v2","description":"Sandbox API Server"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","description":"API Key authentication. Get your key from the Dashboard Settings page. Include in all requests as: `X-API-KEY: PlainProxies_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`","name":"X-API-KEY","in":"header"}}},"paths":{"/sub-users/{uuid}/proxy-settings/requests":{"get":{"tags":["Proxy Settings"],"summary":"List proxy settings requests","description":"Returns all proxy settings requests (pending, approved, denied) for a sub-user, ordered by newest first.","operationId":"d3171d47a3ac1896c045c169724c508b","parameters":[{"name":"uuid","in":"path","description":"Sub-user UUID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"},"data":{"type":"array","items":{"type":"object"}}},"type":"object"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Sub-user not found"}}}}}} ``` ## Cancel a pending request > Cancels a pending proxy settings request. Only pending requests can be cancelled. ```json {"openapi":"3.0.0","info":{"title":"PlainProxies API v2","version":"2.0.0"},"tags":[{"name":"Proxy Settings","description":"Manage port, domain, and URL whitelisting for residential proxies"}],"servers":[{"url":"https://dashboard.plainproxies.com/api/v2","description":"Production API Server"},{"url":"https://plainproxies-sandbox.com/api/v2","description":"Sandbox API Server"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","description":"API Key authentication. Get your key from the Dashboard Settings page. Include in all requests as: `X-API-KEY: PlainProxies_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`","name":"X-API-KEY","in":"header"}}},"paths":{"/sub-users/{uuid}/proxy-settings/{requestId}":{"delete":{"tags":["Proxy Settings"],"summary":"Cancel a pending request","description":"Cancels a pending proxy settings request. Only pending requests can be cancelled.","operationId":"85b1ed809340d236867c49cf795e74a0","parameters":[{"name":"uuid","in":"path","description":"Sub-user UUID","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"requestId","in":"path","description":"Proxy settings request ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Request cancelled successfully","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"},"message":{"type":"string"}},"type":"object"}}}},"400":{"description":"Request is not pending"},"401":{"description":"Unauthorized"},"404":{"description":"Sub-user or request not found"},"429":{"description":"Rate limit exceeded"}}}}}} ``` ## Check if manual approval is required > Checks if a given type and value combination would require manual approval before being whitelisted. ```json {"openapi":"3.0.0","info":{"title":"PlainProxies API v2","version":"2.0.0"},"tags":[{"name":"Proxy Settings","description":"Manage port, domain, and URL whitelisting for residential proxies"}],"servers":[{"url":"https://dashboard.plainproxies.com/api/v2","description":"Production API Server"},{"url":"https://plainproxies-sandbox.com/api/v2","description":"Sandbox API Server"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","description":"API Key authentication. Get your key from the Dashboard Settings page. Include in all requests as: `X-API-KEY: PlainProxies_xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx`","name":"X-API-KEY","in":"header"}}},"paths":{"/proxy-settings/check-approval":{"post":{"tags":["Proxy Settings"],"summary":"Check if manual approval is required","description":"Checks if a given type and value combination would require manual approval before being whitelisted.","operationId":"a3e46b01c580aa287b0381ffa4f2cb39","requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["type","value"],"properties":{"type":{"type":"string","enum":["port","domain","url"]},"value":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"},"data":{"properties":{"requires_manual_approval":{"type":"boolean"},"reason":{"type":"string","nullable":true}},"type":"object"}},"type":"object"}}}},"401":{"description":"Unauthorized"}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.plainproxies.com/resller-api-documentation/proxy-management/proxy-settings.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.