> ## Documentation Index
> Fetch the complete documentation index at: https://doubledata.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Create proxy credential

> Create a credential for residential, datacenter, or mobile traffic. Your organization needs a GB package for that product or a positive balance.



## OpenAPI

````yaml /openapi.json post /proxies
openapi: 3.1.0
info:
  title: DoubleData Proxy API
  version: 1.2.0
  description: >-
    Manage proxy usage, wallet balance, orders, subscriptions, rotations, and IP
    authorization. Your API key selects the workspace; do not send an
    organization ID.
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://app.proxy.doubledata.com/api/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Stats & usage
    description: >-
      Date-range bandwidth, request counts, and actual wallet usage charges for
      your proxy credentials.
  - name: Balance
    description: The organization USD balance shared with the DoubleData website.
  - name: Catalog
    description: Static ISP tiers and cached country availability.
  - name: Orders
    description: Server-priced wallet orders and asynchronous provisioning.
  - name: Subscriptions
    description: Active Static ISP subscriptions and their connection records.
  - name: Rotations
    description: Asynchronous selected-IP rotation batches.
  - name: IP authorization
    description: The source IP authorized for a subscription.
  - name: Credentials
    description: >-
      Residential, datacenter, and mobile proxy credentials and their traffic
      limits.
  - name: Invoices
    description: Organization invoices and invoice PDF downloads.
paths:
  /proxies:
    post:
      tags:
        - Credentials
      summary: Create proxy credential
      description: >-
        Create a credential for residential, datacenter, or mobile traffic. Your
        organization needs a GB package for that product or a positive balance.
      operationId: createProxyCredential
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCredentialRequest'
            examples:
              residential:
                value:
                  name: Price monitor
                  proxy_type: residential
      responses:
        '201':
          description: Created credential with its password
          headers:
            X-Request-ID:
              $ref: '#/components/headers/RequestID'
            Cache-Control:
              $ref: '#/components/headers/CacheControl'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialSecret'
              examples:
                example:
                  value:
                    id: 8b0d3c1e-52f4-4a8e-9d1a-6f2b7c9e0a14
                    username: resi_3f9a1c2b7d4e8f60
                    display_name: Price monitor
                    proxy_type: residential
                    enabled: true
                    funding_source: workspace_balance
                    traffic_used_mb: 1834.5
                    limits_mb:
                      total: 0
                      daily: 0
                      weekly: 0
                      monthly: 50000
                    created_at: '2026-11-02T09:14:00Z'
                    password: <proxy password>
                    connection:
                      gateways:
                        - region: eu
                          host: proxy.doubledata.com
                          default: true
                        - region: us
                          host: us.proxy.doubledata.com
                          default: false
                      ports:
                        http: 7777
                        https: 9999
                        socks5: 8888
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  schemas:
    CreateCredentialRequest:
      type: object
      additionalProperties: false
      required:
        - name
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 24
          description: Display name shown in the dashboard.
        proxy_type:
          type: string
          enum:
            - residential
            - datacenter
            - mobile
          default: residential
    CredentialSecret:
      allOf:
        - $ref: '#/components/schemas/Credential'
        - type: object
          required:
            - password
            - connection
          properties:
            password:
              type: string
              description: Proxy password. Treat it as a secret.
            connection:
              $ref: '#/components/schemas/ProxyConnection'
    Credential:
      type: object
      additionalProperties: false
      required:
        - id
        - username
        - display_name
        - proxy_type
        - enabled
        - funding_source
        - traffic_used_mb
        - limits_mb
        - created_at
      properties:
        id:
          type: string
          format: uuid
        username:
          type: string
          description: Base proxy username. Append targeting parameters when you connect.
        display_name:
          type: string
        proxy_type:
          type: string
          enum:
            - residential
            - datacenter
            - mobile
        enabled:
          type: boolean
        funding_source:
          type:
            - string
            - 'null'
          enum:
            - package_bytes
            - workspace_balance
            - null
          description: 'What pays for traffic: a GB package or the organization balance.'
        traffic_used_mb:
          type: number
          minimum: 0
        limits_mb:
          type: object
          additionalProperties: false
          required:
            - total
            - daily
            - weekly
            - monthly
          description: Traffic limits in MB. `0` means no limit.
          properties:
            total:
              type: integer
              minimum: 0
            daily:
              type: integer
              minimum: 0
            weekly:
              type: integer
              minimum: 0
            monthly:
              type: integer
              minimum: 0
        created_at:
          type: string
          format: date-time
    ProxyConnection:
      type: object
      additionalProperties: false
      required:
        - gateways
        - ports
      properties:
        gateways:
          type: array
          items:
            type: object
            additionalProperties: false
            required:
              - region
              - host
              - default
            properties:
              region:
                type: string
                enum:
                  - eu
                  - us
                  - default
                description: >-
                  eu and us on the public service; default for a single-gateway
                  deployment.
              host:
                type: string
              default:
                type: boolean
        ports:
          type: object
          additionalProperties: false
          required:
            - http
            - https
            - socks5
          properties:
            http:
              type: integer
              example: 7777
            https:
              type:
                - integer
                - 'null'
              example: 9999
              description: Null when the deployment does not serve HTTPS proxy connections.
            socks5:
              type: integer
              example: 8888
    ErrorResponse:
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/Error'
    Error:
      type: object
      additionalProperties: false
      required:
        - code
        - message
        - request_id
      properties:
        code:
          type: string
          enum:
            - invalid_request
            - invalid_ip_address
            - invalid_proxy_ip
            - duplicate_proxy_ip
            - unknown_proxy_ip
            - invalid_package
            - insufficient_balance
            - quote_expired
            - request_conflict
            - kyc_required
            - rotation_allowance_exhausted
            - rotation_in_progress
            - unauthorized
            - forbidden
            - not_found
            - not_available
            - rate_limit_exceeded
            - temporarily_unavailable
            - internal_error
        message:
          type: string
          minLength: 1
        details:
          $ref: '#/components/schemas/ErrorDetails'
        request_id:
          type: string
          format: uuid
    ErrorDetails:
      type: object
      additionalProperties: false
      properties:
        ips:
          type: array
          maxItems: 100
          items:
            type: string
            format: ipv4
  headers:
    RequestID:
      description: A request UUID to include when contacting support.
      schema:
        type: string
        format: uuid
    CacheControl:
      description: Responses are not stored in shared or browser caches.
      schema:
        type: string
        const: no-store
    RateLimitRetryAfter:
      description: When present, wait at least this many seconds before retrying.
      schema:
        type: integer
        minimum: 1
  responses:
    BadRequest:
      description: Invalid ID, request body, or selected IPs.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestID'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            unknownIP:
              value:
                error:
                  code: unknown_proxy_ip
                  message: One or more IPs are not active in this subscription.
                  details:
                    ips:
                      - 198.51.100.10
                  request_id: ad2f824c-46bc-47c6-b276-2bb51a3083b1
    Unauthorized:
      description: The API key is missing, invalid, or revoked.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestID'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            unauthorized:
              value:
                error:
                  code: unauthorized
                  message: A valid API key is required.
                  request_id: ad2f824c-46bc-47c6-b276-2bb51a3083b1
    PaymentRequired:
      description: The organization balance cannot cover the order.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestID'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            insufficientBalance:
              value:
                error:
                  code: insufficient_balance
                  message: >-
                    The organization balance cannot cover this order. Add funds
                    on the website and try again.
                  request_id: ad2f824c-46bc-47c6-b276-2bb51a3083b1
    Forbidden:
      description: Verify your organization before ordering.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestID'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    TooManyRequests:
      description: Request limit or rotation allowance reached.
      headers:
        Retry-After:
          $ref: '#/components/headers/RateLimitRetryAfter'
        X-Request-ID:
          $ref: '#/components/headers/RequestID'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: The request could not be completed.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestID'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ServiceUnavailable:
      description: The API is temporarily unavailable.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestID'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: Your organization's active API key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.