# Unlimited Proxy Settings

Manage port, domain, and URL whitelisting for unlimited residential proxies

## Get proxy settings for unlimited account

> Returns approved proxy settings (ports, domains, URLs), pending requests, and KYC verification status for an unlimited residential account.

```json
{"openapi":"3.0.0","info":{"title":"PlainProxies API v2","version":"2.0.0"},"tags":[{"name":"Unlimited Proxy Settings","description":"Manage port, domain, and URL whitelisting for unlimited 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"}},"responses":{"Unauthorized":{"description":"Authentication failed. Ensure your API key is valid and included in the X-API-KEY header.","headers":{"WWW-Authenticate":{"description":"Authentication scheme hint","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"},"error":{"properties":{"code":{"type":"string","enum":["API_KEY_MISSING","INVALID_API_KEY","USER_NOT_FOUND"]},"message":{"type":"string"}},"type":"object"}},"type":"object"}}}},"NotFound":{"description":"The requested resource does not exist or you do not have access to it.","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"},"error":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"}},"type":"object"}}}}}},"paths":{"/unlimited/{uuid}/proxy-settings":{"get":{"tags":["Unlimited Proxy Settings"],"summary":"Get proxy settings for unlimited account","description":"Returns approved proxy settings (ports, domains, URLs), pending requests, and KYC verification status for an unlimited residential account.","operationId":"ea1107f605d0c9d2958a2a6ceca3b3b7","parameters":[{"name":"uuid","in":"path","description":"Account 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":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
```

## Create proxy settings request for unlimited account

> Creates a new whitelist request for a port, domain, or URL on an unlimited residential account. 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":"Unlimited Proxy Settings","description":"Manage port, domain, and URL whitelisting for unlimited 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"}},"responses":{"Unauthorized":{"description":"Authentication failed. Ensure your API key is valid and included in the X-API-KEY header.","headers":{"WWW-Authenticate":{"description":"Authentication scheme hint","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"},"error":{"properties":{"code":{"type":"string","enum":["API_KEY_MISSING","INVALID_API_KEY","USER_NOT_FOUND"]},"message":{"type":"string"}},"type":"object"}},"type":"object"}}}},"NotFound":{"description":"The requested resource does not exist or you do not have access to it.","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"},"error":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"}},"type":"object"}}}},"ValidationError":{"description":"Request validation failed. Check the details field for specific field errors.","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"},"error":{"properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object"}},"type":"object"}},"type":"object"}}}}}},"paths":{"/unlimited/{uuid}/proxy-settings":{"post":{"tags":["Unlimited Proxy Settings"],"summary":"Create proxy settings request for unlimited account","description":"Creates a new whitelist request for a port, domain, or URL on an unlimited residential account. 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":"aff37b9bea210e4d0d79e9e68ddff86d","parameters":[{"name":"uuid","in":"path","description":"Account 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"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"description":"KYC verification required"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/ValidationError"}}}}}}
```

## List proxy settings requests for unlimited account

> Returns all proxy settings requests (pending, approved, denied) for an unlimited residential account, ordered by newest first.

```json
{"openapi":"3.0.0","info":{"title":"PlainProxies API v2","version":"2.0.0"},"tags":[{"name":"Unlimited Proxy Settings","description":"Manage port, domain, and URL whitelisting for unlimited 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"}},"responses":{"Unauthorized":{"description":"Authentication failed. Ensure your API key is valid and included in the X-API-KEY header.","headers":{"WWW-Authenticate":{"description":"Authentication scheme hint","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"},"error":{"properties":{"code":{"type":"string","enum":["API_KEY_MISSING","INVALID_API_KEY","USER_NOT_FOUND"]},"message":{"type":"string"}},"type":"object"}},"type":"object"}}}},"NotFound":{"description":"The requested resource does not exist or you do not have access to it.","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"},"error":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"}},"type":"object"}}}}}},"paths":{"/unlimited/{uuid}/proxy-settings/requests":{"get":{"tags":["Unlimited Proxy Settings"],"summary":"List proxy settings requests for unlimited account","description":"Returns all proxy settings requests (pending, approved, denied) for an unlimited residential account, ordered by newest first.","operationId":"78f3a44846428bd9ebbf5539f93f403b","parameters":[{"name":"uuid","in":"path","description":"Account 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":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
```

## Cancel a pending request for unlimited account

> Cancels a pending proxy settings request for an unlimited residential account. Only pending requests can be cancelled.

```json
{"openapi":"3.0.0","info":{"title":"PlainProxies API v2","version":"2.0.0"},"tags":[{"name":"Unlimited Proxy Settings","description":"Manage port, domain, and URL whitelisting for unlimited 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"}},"responses":{"Unauthorized":{"description":"Authentication failed. Ensure your API key is valid and included in the X-API-KEY header.","headers":{"WWW-Authenticate":{"description":"Authentication scheme hint","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"},"error":{"properties":{"code":{"type":"string","enum":["API_KEY_MISSING","INVALID_API_KEY","USER_NOT_FOUND"]},"message":{"type":"string"}},"type":"object"}},"type":"object"}}}},"NotFound":{"description":"The requested resource does not exist or you do not have access to it.","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean"},"error":{"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"}},"type":"object"}}}}}},"paths":{"/unlimited/{uuid}/proxy-settings/{requestId}":{"delete":{"tags":["Unlimited Proxy Settings"],"summary":"Cancel a pending request for unlimited account","description":"Cancels a pending proxy settings request for an unlimited residential account. Only pending requests can be cancelled.","operationId":"0b9d7bf2f3530482e1939fa58f52af08","parameters":[{"name":"uuid","in":"path","description":"Account 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":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
```


---

# 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/unlimited-residential-plans/unlimited-proxy-settings.md?ask=<question>
```

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.