> ## Documentation Index
> Fetch the complete documentation index at: https://tbd-6fc993ce-hypeship-changelog-august-13.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a proxy

> Create a new proxy configuration in the resolved project.



## OpenAPI

````yaml https://api.onkernel.com/spec.json post /proxies
openapi: 3.1.0
info:
  description: Developer tools and cloud infrastructure for AI agents to use web browsers
  title: Kernel API
  version: 0.1.0
servers:
  - description: API Server
    url: https://api.onkernel.com
security:
  - bearerAuth: []
tags:
  - description: Create and manage browser sessions.
    name: Browsers
  - description: Control mouse, keyboard, and screen on the browser instance.
    name: Browser Computer Controls
  - description: Execute Playwright code against the browser instance.
    name: Browser Playwright
  - description: Read, write, and manage files on the browser instance.
    name: Browser Filesystem
  - description: Execute and manage processes on the browser instance.
    name: Browser Processes
  - description: Record and manage browser session video replays.
    name: Browser Replays
  - description: Stream logs from the browser instance.
    name: Browser Logs
  - description: Stream live telemetry events from a browser session.
    name: Browser Telemetry
  - description: Create, list, retrieve, and delete browser profiles.
    name: Profiles
  - description: Create and manage proxy configurations for routing browser traffic.
    name: Proxies
  - description: Create, list, retrieve, and delete browser extensions.
    name: Extensions
  - description: Create and manage browser pools for acquiring and releasing browsers.
    name: Browser Pools
  - description: Inspect the identity and authorization context for the current request.
    name: Authentication
  - description: >-
      Create and manage auth connections for automated credential capture and
      login.
    name: Managed Auth
  - description: Create and manage credentials for authentication.
    name: Credentials
  - description: Configure external credential providers like 1Password.
    name: Credential Providers
  - description: List applications and versions.
    name: Apps
  - description: Create and manage app deployments and stream deployment events.
    name: Deployments
  - description: Invoke actions and stream or query invocation status and events.
    name: Invocations
  - description: Read and manage organization-level limits.
    name: Organization
  - description: |
      Create and manage projects for resource isolation within an organization.
      When projects are disabled for the organization, project operations return
      `404` with code `projects_disabled`.
    name: Projects
  - description: Create and manage API keys for organization and project-scoped access.
    name: API Keys
  - description: Read audit log records for the authenticated organization.
    name: Audit Logs
  - description: Resolve browser and proxy recommendations for bot-protected sites.
    name: Site Configs
paths:
  /proxies:
    post:
      tags:
        - Proxies
      summary: Create a proxy
      description: Create a new proxy configuration in the resolved project.
      operationId: postProxies
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProxyCreateRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Proxy'
          description: Proxy created successfully
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - bearerAuth: []
components:
  schemas:
    ProxyCreateRequest:
      description: Configuration for routing traffic through a proxy.
      discriminator:
        mapping:
          custom:
            $ref: '#/components/schemas/CustomProxyConfig'
          datacenter:
            $ref: '#/components/schemas/DatacenterProxyConfig'
          isp:
            $ref: '#/components/schemas/IspProxyConfig'
          mobile:
            $ref: '#/components/schemas/MobileProxyConfig'
          residential:
            $ref: '#/components/schemas/ResidentialProxyConfig'
        propertyName: type
      properties:
        bypass_hosts:
          description: Hostnames that should bypass the parent proxy and connect directly.
          items:
            type: string
          type: array
        config:
          description: Configuration specific to the selected proxy `type`.
          oneOf:
            - $ref: '#/components/schemas/DatacenterProxyConfig'
            - $ref: '#/components/schemas/IspProxyConfig'
            - $ref: '#/components/schemas/ResidentialProxyConfig'
            - $ref: '#/components/schemas/MobileProxyConfig'
            - $ref: '#/components/schemas/CreateCustomProxyConfig'
        name:
          description: Readable name of the proxy.
          type: string
        protocol:
          default: https
          description: Protocol to use for the proxy connection.
          enum:
            - http
            - https
          type: string
        type:
          description: >
            Proxy type to use. In terms of quality for avoiding bot-detection,
            from best to worst: `mobile` > `residential` > `isp` > `datacenter`.
          enum:
            - datacenter
            - isp
            - residential
            - mobile
            - custom
          type: string
      required:
        - type
      type: object
    Proxy:
      description: Configuration for routing traffic through a proxy.
      discriminator:
        mapping:
          custom:
            $ref: '#/components/schemas/CustomProxyConfig'
          datacenter:
            $ref: '#/components/schemas/DatacenterProxyConfig'
          isp:
            $ref: '#/components/schemas/IspProxyConfig'
          mobile:
            $ref: '#/components/schemas/MobileProxyConfig'
          residential:
            $ref: '#/components/schemas/ResidentialProxyConfig'
        propertyName: type
      properties:
        bypass_hosts:
          description: Hostnames that should bypass the parent proxy and connect directly.
          items:
            type: string
          type: array
        config:
          description: Configuration specific to the selected proxy `type`.
          oneOf:
            - $ref: '#/components/schemas/DatacenterProxyConfig'
            - $ref: '#/components/schemas/IspProxyConfig'
            - $ref: '#/components/schemas/ResidentialProxyConfig'
            - $ref: '#/components/schemas/MobileProxyConfig'
            - $ref: '#/components/schemas/CustomProxyConfig'
        id:
          type: string
        ip_address:
          description: IP address that the proxy uses when making requests.
          example: 192.168.1.1
          type: string
        last_checked:
          description: Timestamp of the last health check performed on this proxy.
          format: date-time
          type: string
        name:
          description: Readable name of the proxy.
          type: string
        protocol:
          default: https
          description: Protocol to use for the proxy connection.
          enum:
            - http
            - https
          type: string
        status:
          description: Current health status of the proxy.
          enum:
            - available
            - unavailable
          type: string
        type:
          description: >
            Proxy type to use. In terms of quality for avoiding bot-detection,
            from best to worst: `mobile` > `residential` > `isp` > `datacenter`.
          enum:
            - datacenter
            - isp
            - residential
            - mobile
            - custom
          type: string
      required:
        - type
      type: object
    CustomProxyConfig:
      description: Configuration for a custom proxy (e.g., private proxy server).
      properties:
        has_ca_bundle:
          description: Whether the proxy has a custom CA bundle configured.
          example: true
          type: boolean
        has_password:
          description: Whether the proxy has a password.
          example: true
          type: boolean
        host:
          description: Proxy host address or IP.
          example: 127.0.0.1
          type: string
        port:
          description: Proxy port.
          example: 8080
          type: integer
        username:
          description: Username for proxy authentication.
          example: user123
          type: string
      required:
        - host
        - port
      title: Custom
      type: object
    DatacenterProxyConfig:
      description: Configuration for a datacenter proxy.
      properties:
        country:
          description: ISO 3166 country code. Defaults to US if not provided.
          example: US
          type: string
      title: Datacenter
      type: object
    IspProxyConfig:
      description: Configuration for an ISP proxy.
      properties:
        country:
          description: ISO 3166 country code. Defaults to US if not provided.
          example: US
          type: string
      title: ISP
      type: object
    MobileProxyConfig:
      description: Configuration for mobile proxies.
      properties:
        city:
          description: >-
            Provider city alias. Mobile carrier routing can make observed geo
            vary.
          example: brooklyn
          type: string
        country:
          description: ISO 3166 country code
          example: US
          type: string
        state:
          description: >-
            US-only state code. Mobile carrier routing can make observed geo
            vary.
          example: NY
          type: string
      title: Mobile
      type: object
    ResidentialProxyConfig:
      description: Configuration for residential proxies.
      properties:
        asn:
          description: >-
            Autonomous system number. See
            https://bgp.potaroo.net/cidr/autnums.html
          example: AS15169
          type: string
        city:
          description: >-
            City name (no spaces, e.g. `sanfrancisco`). If provided, `country`
            must also be provided.
          example: sanfrancisco
          type: string
        country:
          description: ISO 3166 country code.
          example: US
          type: string
        os:
          deprecated: true
          description: Operating system of the residential device.
          enum:
            - windows
            - macos
            - android
          type: string
          x-deprecated-reason: os selection not supported by proxy provider
        state:
          description: Two-letter state code.
          example: CA
          type: string
        zip:
          description: US ZIP code.
          example: '94107'
          type: string
      title: Residential
      type: object
    CreateCustomProxyConfig:
      description: Configuration for a custom proxy (e.g., private proxy server).
      properties:
        ca_bundle:
          description: >-
            PEM-encoded CA certificate bundle the proxy re-signs upstream TLS
            with. Provide when the proxy terminates TLS (MITM) so the browser
            trusts its certificates. May contain multiple concatenated
            certificates.
          example: |
            -----BEGIN CERTIFICATE-----
            MIIB...
            -----END CERTIFICATE-----
          maxLength: 65536
          type: string
        host:
          description: Proxy host address or IP.
          example: 127.0.0.1
          type: string
        password:
          description: Password for proxy authentication.
          example: secret
          maxLength: 4096
          type: string
        port:
          description: Proxy port.
          example: 8080
          type: integer
        username:
          description: Username for proxy authentication.
          example: user123
          type: string
      required:
        - host
        - port
      title: Custom
      type: object
    Error:
      properties:
        code:
          description: Application-specific error code (machine-readable)
          example: bad_request
          type: string
        details:
          description: Additional error details (for multiple errors)
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
        inner_error:
          $ref: '#/components/schemas/ErrorDetail'
        message:
          description: Human-readable error description for debugging
          example: 'Missing required field: app_name'
          type: string
      required:
        - code
        - message
      type: object
    ErrorDetail:
      properties:
        code:
          description: Lower-level error code providing more specific detail
          example: invalid_input
          type: string
        message:
          description: Further detail about the error
          example: Provided version string is not semver compliant
          type: string
      type: object
  responses:
    BadRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Bad Request – invalid input
    Unauthorized:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Unauthorized – missing or invalid authorization token
    Forbidden:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Forbidden – insufficient permissions or plan
    InternalError:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Internal Server Error
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http

````