# Create Proxy

POST https://api.bctrl.ai/v1/proxies
Content-Type: application/json

Reference: https://platform.bctrl.ai/api/api-reference/proxies/create

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: bctrl API
  version: 1.0.0
paths:
  /v1/proxies:
    post:
      operationId: create
      summary: Create a saved proxy
      tags:
        - subpackage_proxies
      parameters:
        - name: Authorization
          in: header
          description: Use Bearer <api-key>.
          required: true
          schema:
            type: string
      responses:
        '201':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/proxies_create_Response_201'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/proxies_create_Request'
servers:
  - url: https://api.bctrl.ai
  - url: http://localhost:8787
components:
  schemas:
    V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf0ConnectionProtocol:
      type: string
      enum:
        - http
        - socks5
      title: >-
        V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf0ConnectionProtocol
    V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf0Connection:
      type: object
      properties:
        host:
          type: string
        password:
          type: string
        port:
          type: integer
        protocol:
          $ref: >-
            #/components/schemas/V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf0ConnectionProtocol
        username:
          type: string
      required:
        - host
        - port
        - protocol
      title: V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf0Connection
    V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf0Kind:
      type: string
      enum:
        - custom
      title: V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf0Kind
    ProxiesCreateRequest0:
      type: object
      properties:
        connection:
          $ref: >-
            #/components/schemas/V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf0Connection
        kind:
          $ref: >-
            #/components/schemas/V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf0Kind
        name:
          type: string
      required:
        - connection
        - kind
        - name
      title: ProxiesCreateRequest0
    V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1DefaultsGeo:
      type: object
      properties:
        city:
          type: string
        country:
          type: string
        isp:
          type: string
        region:
          type: string
      title: V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1DefaultsGeo
    V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1DefaultsIpFamily:
      type: string
      enum:
        - dual-stack
        - ipv4-only
      title: >-
        V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1DefaultsIpFamily
    V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1DefaultsPoolPreference:
      type: string
      enum:
        - quality
        - quality-speed
        - speed
        - max-pool
      title: >-
        V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1DefaultsPoolPreference
    V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1DefaultsProtocol:
      type: string
      enum:
        - http
        - socks5
      title: >-
        V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1DefaultsProtocol
    V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1DefaultsSessionOneOf0Strategy:
      type: string
      enum:
        - rotate
      title: >-
        V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1DefaultsSessionOneOf0Strategy
    V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1DefaultsSession0:
      type: object
      properties:
        strategy:
          $ref: >-
            #/components/schemas/V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1DefaultsSessionOneOf0Strategy
      required:
        - strategy
      title: >-
        V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1DefaultsSession0
    V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1DefaultsSessionOneOf1Strategy:
      type: string
      enum:
        - sticky
      title: >-
        V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1DefaultsSessionOneOf1Strategy
    V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1DefaultsSession1:
      type: object
      properties:
        key:
          type: string
        strategy:
          $ref: >-
            #/components/schemas/V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1DefaultsSessionOneOf1Strategy
      required:
        - strategy
      title: >-
        V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1DefaultsSession1
    V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1DefaultsSession:
      oneOf:
        - $ref: >-
            #/components/schemas/V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1DefaultsSession0
        - $ref: >-
            #/components/schemas/V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1DefaultsSession1
      title: >-
        V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1DefaultsSession
    V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1Defaults:
      type: object
      properties:
        geo:
          $ref: >-
            #/components/schemas/V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1DefaultsGeo
        ipFamily:
          $ref: >-
            #/components/schemas/V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1DefaultsIpFamily
        poolPreference:
          $ref: >-
            #/components/schemas/V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1DefaultsPoolPreference
        protocol:
          $ref: >-
            #/components/schemas/V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1DefaultsProtocol
        session:
          $ref: >-
            #/components/schemas/V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1DefaultsSession
      title: V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1Defaults
    V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1Kind:
      type: string
      enum:
        - managed-rotating
      title: V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1Kind
    ProxiesCreateRequest1:
      type: object
      properties:
        defaults:
          $ref: >-
            #/components/schemas/V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1Defaults
        kind:
          $ref: >-
            #/components/schemas/V1ProxiesPostRequestBodyContentApplicationJsonSchemaOneOf1Kind
        name:
          type: string
      required:
        - kind
        - name
      title: ProxiesCreateRequest1
    proxies_create_Request:
      oneOf:
        - $ref: '#/components/schemas/ProxiesCreateRequest0'
        - $ref: '#/components/schemas/ProxiesCreateRequest1'
      title: proxies_create_Request
    V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf0ConnectionProtocol:
      type: string
      enum:
        - http
        - socks5
      title: >-
        V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf0ConnectionProtocol
    V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf0Connection:
      type: object
      properties:
        hasPassword:
          type: boolean
        host:
          type: string
        port:
          type: integer
        protocol:
          $ref: >-
            #/components/schemas/V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf0ConnectionProtocol
        username:
          type:
            - string
            - 'null'
      required:
        - hasPassword
        - host
        - port
        - protocol
      title: V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf0Connection
    V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf0Kind:
      type: string
      enum:
        - custom
      title: V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf0Kind
    ProxiesCreateResponse2010:
      type: object
      properties:
        connection:
          $ref: >-
            #/components/schemas/V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf0Connection
        createdAt:
          type: string
        id:
          type: string
          format: uuid
        kind:
          $ref: >-
            #/components/schemas/V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf0Kind
        name:
          type: string
        updatedAt:
          type: string
      required:
        - connection
        - createdAt
        - id
        - kind
        - name
        - updatedAt
      title: ProxiesCreateResponse2010
    V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1DefaultsGeo:
      type: object
      properties:
        city:
          type: string
        country:
          type: string
        isp:
          type: string
        region:
          type: string
      title: V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1DefaultsGeo
    V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1DefaultsIpFamily:
      type: string
      enum:
        - dual-stack
        - ipv4-only
      title: V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1DefaultsIpFamily
    V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1DefaultsPoolPreference:
      type: string
      enum:
        - quality
        - quality-speed
        - speed
        - max-pool
      title: >-
        V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1DefaultsPoolPreference
    V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1DefaultsProtocol:
      type: string
      enum:
        - http
        - socks5
      title: V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1DefaultsProtocol
    V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1DefaultsSessionOneOf0Strategy:
      type: string
      enum:
        - rotate
      title: >-
        V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1DefaultsSessionOneOf0Strategy
    V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1DefaultsSession0:
      type: object
      properties:
        strategy:
          $ref: >-
            #/components/schemas/V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1DefaultsSessionOneOf0Strategy
      required:
        - strategy
      title: V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1DefaultsSession0
    V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1DefaultsSessionOneOf1Strategy:
      type: string
      enum:
        - sticky
      title: >-
        V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1DefaultsSessionOneOf1Strategy
    V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1DefaultsSession1:
      type: object
      properties:
        key:
          type: string
        strategy:
          $ref: >-
            #/components/schemas/V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1DefaultsSessionOneOf1Strategy
      required:
        - strategy
      title: V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1DefaultsSession1
    V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1DefaultsSession:
      oneOf:
        - $ref: >-
            #/components/schemas/V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1DefaultsSession0
        - $ref: >-
            #/components/schemas/V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1DefaultsSession1
      title: V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1DefaultsSession
    V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1Defaults:
      type: object
      properties:
        geo:
          $ref: >-
            #/components/schemas/V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1DefaultsGeo
        ipFamily:
          $ref: >-
            #/components/schemas/V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1DefaultsIpFamily
        poolPreference:
          $ref: >-
            #/components/schemas/V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1DefaultsPoolPreference
        protocol:
          $ref: >-
            #/components/schemas/V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1DefaultsProtocol
        session:
          $ref: >-
            #/components/schemas/V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1DefaultsSession
      title: V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1Defaults
    V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1Kind:
      type: string
      enum:
        - managed-rotating
      title: V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1Kind
    ProxiesCreateResponse2011:
      type: object
      properties:
        createdAt:
          type: string
        defaults:
          $ref: >-
            #/components/schemas/V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1Defaults
        id:
          type: string
          format: uuid
        kind:
          $ref: >-
            #/components/schemas/V1ProxiesPostResponsesContentApplicationJsonSchemaOneOf1Kind
        name:
          type: string
        updatedAt:
          type: string
      required:
        - createdAt
        - defaults
        - id
        - kind
        - name
        - updatedAt
      title: ProxiesCreateResponse2011
    proxies_create_Response_201:
      oneOf:
        - $ref: '#/components/schemas/ProxiesCreateResponse2010'
        - $ref: '#/components/schemas/ProxiesCreateResponse2011'
      title: proxies_create_Response_201
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Use Bearer <api-key>.

```

## SDK Code Examples

```python
import requests

url = "https://api.bctrl.ai/v1/proxies"

payload = {
    "connection": {
        "host": "proxy.example.com",
        "port": 8080,
        "protocol": "http"
    },
    "kind": "custom",
    "name": "Office Proxy Server"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.bctrl.ai/v1/proxies';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"connection":{"host":"proxy.example.com","port":8080,"protocol":"http"},"kind":"custom","name":"Office Proxy Server"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bctrl.ai/v1/proxies"

	payload := strings.NewReader("{\n  \"connection\": {\n    \"host\": \"proxy.example.com\",\n    \"port\": 8080,\n    \"protocol\": \"http\"\n  },\n  \"kind\": \"custom\",\n  \"name\": \"Office Proxy Server\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.bctrl.ai/v1/proxies")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"connection\": {\n    \"host\": \"proxy.example.com\",\n    \"port\": 8080,\n    \"protocol\": \"http\"\n  },\n  \"kind\": \"custom\",\n  \"name\": \"Office Proxy Server\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.bctrl.ai/v1/proxies")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"connection\": {\n    \"host\": \"proxy.example.com\",\n    \"port\": 8080,\n    \"protocol\": \"http\"\n  },\n  \"kind\": \"custom\",\n  \"name\": \"Office Proxy Server\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.bctrl.ai/v1/proxies', [
  'body' => '{
  "connection": {
    "host": "proxy.example.com",
    "port": 8080,
    "protocol": "http"
  },
  "kind": "custom",
  "name": "Office Proxy Server"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.bctrl.ai/v1/proxies");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"connection\": {\n    \"host\": \"proxy.example.com\",\n    \"port\": 8080,\n    \"protocol\": \"http\"\n  },\n  \"kind\": \"custom\",\n  \"name\": \"Office Proxy Server\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "connection": [
    "host": "proxy.example.com",
    "port": 8080,
    "protocol": "http"
  ],
  "kind": "custom",
  "name": "Office Proxy Server"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.bctrl.ai/v1/proxies")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```