> For the complete documentation index, see [llms.txt](https://docs.9proxy.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.9proxy.com/developers/public-api/api-for-proxy-connect-config.md).

# API For Proxy Connect Config

## List connection configs

> Returns a paginated list of proxy connection configurations for the authenticated account, with support for sorting and ordering.

```json
{"openapi":"3.1.1","info":{"title":"Proxy Connect Traffic","version":"1.0"},"servers":[{"url":"https://sandbox.9proxy.com"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"api-key","in":"query"}},"schemas":{"ResponseListConfig":{"type":"object","description":"Connection configurations list response payload.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Human-readable response message."},"result":{"type":"object","description":"Paginated response data.","properties":{"items":{"type":"array","description":"List of connection configurations.","items":{"$ref":"#/components/schemas/Config"}},"total_items":{"type":"integer","description":"Total number of items."},"total_pages":{"type":"integer","description":"Total number of pages."}}}}},"Config":{"type":"object","description":"Proxy connection configuration, including targeting filters, allocated port range, and session behavior.","properties":{"id":{"type":"integer","description":"Configuration ID."},"user_id":{"type":"integer","description":"Owner user ID."},"server_id":{"type":"integer","description":"Server ID assigned to the configuration."},"proxy_type":{"type":"integer","description":"Proxy type identifier."},"country_code":{"type":["string","null"],"description":"Country targeting filter."},"city_code":{"type":["string","null"],"description":"City targeting filter."},"state_code":{"type":["string","null"],"description":"State/region targeting filter."},"isp_code":{"type":["string","null"],"description":"ISP targeting filter."},"start_port":{"type":"integer","description":"Start port of the allocated range."},"end_port":{"type":"integer","description":"End port of the allocated range."},"is_keep":{"type":"integer","description":"Indicates sticky session behavior (keep session)."},"is_random_ip":{"type":"integer","description":"Indicates rotation behavior (randomize IP)."},"session_time":{"type":"string","description":"Sticky session duration used for refresh when sticky mode is enabled."},"created_at":{"type":"integer","description":"Configuration creation timestamp."},"updated_at":{"type":"integer","description":"Configuration last updated timestamp."}}},"ResponseBadRequestError":{"type":"object","description":"Response payload returned when the request is invalid.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Human-readable response message."},"errors":{"type":"array","description":"List of error messages.","items":{"type":"string"}}}},"ResponseForbiddenError":{"type":"object","description":"Response payload returned when access is forbidden.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Human-readable response message."},"errors":{"type":"array","description":"List of error messages.","items":{"type":"string"}}}}}},"paths":{"/client/v1/proxy-connection/get-list":{"get":{"summary":"List connection configs","description":"Returns a paginated list of proxy connection configurations for the authenticated account, with support for sorting and ordering.","parameters":[{"schema":{"type":"integer"},"name":"limit","in":"query","required":false,"description":"Maximum number of items to return per page."},{"schema":{"type":"integer"},"name":"page","in":"query","required":false,"description":"Requested page number (1-based). Default: 1"},{"schema":{"type":"string"},"name":"sort_by","in":"query","required":false,"description":"Field to sort by: 'id', 'start_port', 'end_port', 'created_at', 'updated_at'. Default: start_port"},{"schema":{"type":"string"},"name":"order_by","in":"query","required":false,"description":"Sort order: desc or asc. Default: desc"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseListConfig"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseBadRequestError"}}}},"403":{"description":"Authentication error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseForbiddenError"}}}}}}}}}
```

## Create connection config

> Creates a new proxy connection configuration by allocating a port range based on the requested quantity and applying optional targeting filters and session settings.

```json
{"openapi":"3.1.1","info":{"title":"Proxy Connect Traffic","version":"1.0"},"servers":[{"url":"https://sandbox.9proxy.com"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"api-key","in":"query"}},"schemas":{"ResponseGenerateConfig":{"type":"object","description":"Connection configuration creation response payload.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Human-readable response message."},"result":{"type":"object","description":"Created connection configuration details.","$ref":"#/components/schemas/Config"}}},"Config":{"type":"object","description":"Proxy connection configuration, including targeting filters, allocated port range, and session behavior.","properties":{"id":{"type":"integer","description":"Configuration ID."},"user_id":{"type":"integer","description":"Owner user ID."},"server_id":{"type":"integer","description":"Server ID assigned to the configuration."},"proxy_type":{"type":"integer","description":"Proxy type identifier."},"country_code":{"type":["string","null"],"description":"Country targeting filter."},"city_code":{"type":["string","null"],"description":"City targeting filter."},"state_code":{"type":["string","null"],"description":"State/region targeting filter."},"isp_code":{"type":["string","null"],"description":"ISP targeting filter."},"start_port":{"type":"integer","description":"Start port of the allocated range."},"end_port":{"type":"integer","description":"End port of the allocated range."},"is_keep":{"type":"integer","description":"Indicates sticky session behavior (keep session)."},"is_random_ip":{"type":"integer","description":"Indicates rotation behavior (randomize IP)."},"session_time":{"type":"string","description":"Sticky session duration used for refresh when sticky mode is enabled."},"created_at":{"type":"integer","description":"Configuration creation timestamp."},"updated_at":{"type":"integer","description":"Configuration last updated timestamp."}}},"ResponseBadRequestError":{"type":"object","description":"Response payload returned when the request is invalid.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Human-readable response message."},"errors":{"type":"array","description":"List of error messages.","items":{"type":"string"}}}},"ResponseForbiddenError":{"type":"object","description":"Response payload returned when access is forbidden.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Human-readable response message."},"errors":{"type":"array","description":"List of error messages.","items":{"type":"string"}}}}}},"paths":{"/client/v1/proxy-connection/create":{"post":{"summary":"Create connection config","description":"Creates a new proxy connection configuration by allocating a port range based on the requested quantity and applying optional targeting filters and session settings.","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGenerateConfig"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseBadRequestError"}}}},"403":{"description":"Authentication error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseForbiddenError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"proxy_type":{"type":"integer","description":"Proxy type identifier."},"country_code":{"type":"string","description":"Country code used to target proxies."},"city_code":{"type":"string","description":"City code used to target proxies."},"state_code":{"type":"string","description":"State/region code used to target proxies."},"isp_code":{"type":"string","description":"ISP code used to target proxies."},"quantity":{"type":"integer","description":"Number of ports to allocate for this configuration."},"session_type":{"type":"integer","description":"Session mode. 1: Rotation, 2: Sticky"},"session_time":{"type":"integer","description":"Sticky session duration (minutes)."}},"required":["session_type","quantity"]}}}}}}}}
```

## Update connection config

> Updates an existing proxy connection configuration identified by start\_port, including targeting filters and session settings.

```json
{"openapi":"3.1.1","info":{"title":"Proxy Connect Traffic","version":"1.0"},"servers":[{"url":"https://sandbox.9proxy.com"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"api-key","in":"query"}},"schemas":{"ResponseUpdateConfig":{"type":"object","description":"Connection configuration update response payload.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Human-readable response message."},"result":{"type":"object","description":"Updated connection configuration details.","$ref":"#/components/schemas/Config"}}},"Config":{"type":"object","description":"Proxy connection configuration, including targeting filters, allocated port range, and session behavior.","properties":{"id":{"type":"integer","description":"Configuration ID."},"user_id":{"type":"integer","description":"Owner user ID."},"server_id":{"type":"integer","description":"Server ID assigned to the configuration."},"proxy_type":{"type":"integer","description":"Proxy type identifier."},"country_code":{"type":["string","null"],"description":"Country targeting filter."},"city_code":{"type":["string","null"],"description":"City targeting filter."},"state_code":{"type":["string","null"],"description":"State/region targeting filter."},"isp_code":{"type":["string","null"],"description":"ISP targeting filter."},"start_port":{"type":"integer","description":"Start port of the allocated range."},"end_port":{"type":"integer","description":"End port of the allocated range."},"is_keep":{"type":"integer","description":"Indicates sticky session behavior (keep session)."},"is_random_ip":{"type":"integer","description":"Indicates rotation behavior (randomize IP)."},"session_time":{"type":"string","description":"Sticky session duration used for refresh when sticky mode is enabled."},"created_at":{"type":"integer","description":"Configuration creation timestamp."},"updated_at":{"type":"integer","description":"Configuration last updated timestamp."}}},"ResponseBadRequestError":{"type":"object","description":"Response payload returned when the request is invalid.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Human-readable response message."},"errors":{"type":"array","description":"List of error messages.","items":{"type":"string"}}}},"ResponseForbiddenError":{"type":"object","description":"Response payload returned when access is forbidden.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Human-readable response message."},"errors":{"type":"array","description":"List of error messages.","items":{"type":"string"}}}}}},"paths":{"/client/v1/proxy-connection/update":{"put":{"summary":"Update connection config","description":"Updates an existing proxy connection configuration identified by start_port, including targeting filters and session settings.","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseUpdateConfig"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseBadRequestError"}}}},"403":{"description":"Authentication error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseForbiddenError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"start_port":{"type":"integer","description":"Start port of the configuration to update."},"country_code":{"type":"string","description":"Country code used to target proxies."},"city_code":{"type":"string","description":"City code used to target proxies."},"state_code":{"type":"string","description":"State/region code used to target proxies."},"isp_code":{"type":"string","description":"ISP code used to target proxies."},"session_type":{"type":"integer","description":"Session mode. 1: Rotation, 2: Sticky"},"session_time":{"type":"integer","description":"Sticky session duration (minutes)."}},"required":["start_port","session_type"]}}}}}}}}
```

## Delete connection configs

> Deletes one or more proxy connection configurations identified by their start\_port values.

```json
{"openapi":"3.1.1","info":{"title":"Proxy Connect Traffic","version":"1.0"},"servers":[{"url":"https://sandbox.9proxy.com"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","name":"api-key","in":"query"}},"schemas":{"ResponseDeleteConfig":{"type":"object","description":"Connection configuration deletion response payload.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Human-readable response message."},"result":{"type":"object","description":"Deletion result.","properties":{"deleted":{"type":"boolean"}}}}},"ResponseBadRequestError":{"type":"object","description":"Response payload returned when the request is invalid.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Human-readable response message."},"errors":{"type":"array","description":"List of error messages.","items":{"type":"string"}}}},"ResponseForbiddenError":{"type":"object","description":"Response payload returned when access is forbidden.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Human-readable response message."},"errors":{"type":"array","description":"List of error messages.","items":{"type":"string"}}}}}},"paths":{"/client/v1/proxy-connection/delete":{"delete":{"summary":"Delete connection configs","description":"Deletes one or more proxy connection configurations identified by their start_port values.","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseDeleteConfig"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseBadRequestError"}}}},"403":{"description":"Authentication error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseForbiddenError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"start_ports":{"type":"array","items":{"type":"integer"},"description":"List of start_port values to delete."}},"required":["start_ports"]}}}}}}}}
```

## The Config object

```json
{"openapi":"3.1.1","info":{"title":"Proxy Connect Traffic","version":"1.0"},"components":{"schemas":{"Config":{"type":"object","description":"Proxy connection configuration, including targeting filters, allocated port range, and session behavior.","properties":{"id":{"type":"integer","description":"Configuration ID."},"user_id":{"type":"integer","description":"Owner user ID."},"server_id":{"type":"integer","description":"Server ID assigned to the configuration."},"proxy_type":{"type":"integer","description":"Proxy type identifier."},"country_code":{"type":["string","null"],"description":"Country targeting filter."},"city_code":{"type":["string","null"],"description":"City targeting filter."},"state_code":{"type":["string","null"],"description":"State/region targeting filter."},"isp_code":{"type":["string","null"],"description":"ISP targeting filter."},"start_port":{"type":"integer","description":"Start port of the allocated range."},"end_port":{"type":"integer","description":"End port of the allocated range."},"is_keep":{"type":"integer","description":"Indicates sticky session behavior (keep session)."},"is_random_ip":{"type":"integer","description":"Indicates rotation behavior (randomize IP)."},"session_time":{"type":"string","description":"Sticky session duration used for refresh when sticky mode is enabled."},"created_at":{"type":"integer","description":"Configuration creation timestamp."},"updated_at":{"type":"integer","description":"Configuration last updated timestamp."}}}}}}
```

## The ResponseListConfig object

```json
{"openapi":"3.1.1","info":{"title":"Proxy Connect Traffic","version":"1.0"},"components":{"schemas":{"ResponseListConfig":{"type":"object","description":"Connection configurations list response payload.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Human-readable response message."},"result":{"type":"object","description":"Paginated response data.","properties":{"items":{"type":"array","description":"List of connection configurations.","items":{"$ref":"#/components/schemas/Config"}},"total_items":{"type":"integer","description":"Total number of items."},"total_pages":{"type":"integer","description":"Total number of pages."}}}}},"Config":{"type":"object","description":"Proxy connection configuration, including targeting filters, allocated port range, and session behavior.","properties":{"id":{"type":"integer","description":"Configuration ID."},"user_id":{"type":"integer","description":"Owner user ID."},"server_id":{"type":"integer","description":"Server ID assigned to the configuration."},"proxy_type":{"type":"integer","description":"Proxy type identifier."},"country_code":{"type":["string","null"],"description":"Country targeting filter."},"city_code":{"type":["string","null"],"description":"City targeting filter."},"state_code":{"type":["string","null"],"description":"State/region targeting filter."},"isp_code":{"type":["string","null"],"description":"ISP targeting filter."},"start_port":{"type":"integer","description":"Start port of the allocated range."},"end_port":{"type":"integer","description":"End port of the allocated range."},"is_keep":{"type":"integer","description":"Indicates sticky session behavior (keep session)."},"is_random_ip":{"type":"integer","description":"Indicates rotation behavior (randomize IP)."},"session_time":{"type":"string","description":"Sticky session duration used for refresh when sticky mode is enabled."},"created_at":{"type":"integer","description":"Configuration creation timestamp."},"updated_at":{"type":"integer","description":"Configuration last updated timestamp."}}}}}}
```

## The ResponseGenerateConfig object

```json
{"openapi":"3.1.1","info":{"title":"Proxy Connect Traffic","version":"1.0"},"components":{"schemas":{"ResponseGenerateConfig":{"type":"object","description":"Connection configuration creation response payload.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Human-readable response message."},"result":{"type":"object","description":"Created connection configuration details.","$ref":"#/components/schemas/Config"}}},"Config":{"type":"object","description":"Proxy connection configuration, including targeting filters, allocated port range, and session behavior.","properties":{"id":{"type":"integer","description":"Configuration ID."},"user_id":{"type":"integer","description":"Owner user ID."},"server_id":{"type":"integer","description":"Server ID assigned to the configuration."},"proxy_type":{"type":"integer","description":"Proxy type identifier."},"country_code":{"type":["string","null"],"description":"Country targeting filter."},"city_code":{"type":["string","null"],"description":"City targeting filter."},"state_code":{"type":["string","null"],"description":"State/region targeting filter."},"isp_code":{"type":["string","null"],"description":"ISP targeting filter."},"start_port":{"type":"integer","description":"Start port of the allocated range."},"end_port":{"type":"integer","description":"End port of the allocated range."},"is_keep":{"type":"integer","description":"Indicates sticky session behavior (keep session)."},"is_random_ip":{"type":"integer","description":"Indicates rotation behavior (randomize IP)."},"session_time":{"type":"string","description":"Sticky session duration used for refresh when sticky mode is enabled."},"created_at":{"type":"integer","description":"Configuration creation timestamp."},"updated_at":{"type":"integer","description":"Configuration last updated timestamp."}}}}}}
```

## The ResponseUpdateConfig object

```json
{"openapi":"3.1.1","info":{"title":"Proxy Connect Traffic","version":"1.0"},"components":{"schemas":{"ResponseUpdateConfig":{"type":"object","description":"Connection configuration update response payload.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Human-readable response message."},"result":{"type":"object","description":"Updated connection configuration details.","$ref":"#/components/schemas/Config"}}},"Config":{"type":"object","description":"Proxy connection configuration, including targeting filters, allocated port range, and session behavior.","properties":{"id":{"type":"integer","description":"Configuration ID."},"user_id":{"type":"integer","description":"Owner user ID."},"server_id":{"type":"integer","description":"Server ID assigned to the configuration."},"proxy_type":{"type":"integer","description":"Proxy type identifier."},"country_code":{"type":["string","null"],"description":"Country targeting filter."},"city_code":{"type":["string","null"],"description":"City targeting filter."},"state_code":{"type":["string","null"],"description":"State/region targeting filter."},"isp_code":{"type":["string","null"],"description":"ISP targeting filter."},"start_port":{"type":"integer","description":"Start port of the allocated range."},"end_port":{"type":"integer","description":"End port of the allocated range."},"is_keep":{"type":"integer","description":"Indicates sticky session behavior (keep session)."},"is_random_ip":{"type":"integer","description":"Indicates rotation behavior (randomize IP)."},"session_time":{"type":"string","description":"Sticky session duration used for refresh when sticky mode is enabled."},"created_at":{"type":"integer","description":"Configuration creation timestamp."},"updated_at":{"type":"integer","description":"Configuration last updated timestamp."}}}}}}
```

## The ResponseDeleteConfig object

```json
{"openapi":"3.1.1","info":{"title":"Proxy Connect Traffic","version":"1.0"},"components":{"schemas":{"ResponseDeleteConfig":{"type":"object","description":"Connection configuration deletion response payload.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Human-readable response message."},"result":{"type":"object","description":"Deletion result.","properties":{"deleted":{"type":"boolean"}}}}}}}}
```

## The ResponseForbiddenError object

```json
{"openapi":"3.1.1","info":{"title":"Proxy Connect Traffic","version":"1.0"},"components":{"schemas":{"ResponseForbiddenError":{"type":"object","description":"Response payload returned when access is forbidden.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Human-readable response message."},"errors":{"type":"array","description":"List of error messages.","items":{"type":"string"}}}}}}}
```

## The ResponseBadRequestError object

```json
{"openapi":"3.1.1","info":{"title":"Proxy Connect Traffic","version":"1.0"},"components":{"schemas":{"ResponseBadRequestError":{"type":"object","description":"Response payload returned when the request is invalid.","properties":{"success":{"type":"boolean","description":"Indicates whether the request was successful."},"message":{"type":"string","description":"Human-readable response message."},"errors":{"type":"array","description":"List of error messages.","items":{"type":"string"}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.9proxy.com/developers/public-api/api-for-proxy-connect-config.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.