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

# Retrieves a ProxyAccount resource.

> Retrieves a ProxyAccount resource.



## OpenAPI

````yaml /openapi.json get /api/proxy_accounts/{id}
openapi: 3.1.0
info:
  title: AnyIP.io API documentation
  description: >-
    The anyIP REST API allows you to programmatically manage proxy accounts,
    monitor traffic, and access geographic data. Authenticate using your API
    key.
  version: 1.0.0
servers:
  - url: https://dashboard.anyip.io
    description: anyIP Production API
security:
  - apiHeader: []
tags: []
paths:
  /api/proxy_accounts/{id}:
    get:
      tags:
        - ProxyAccount
      summary: Retrieves a ProxyAccount resource.
      description: Retrieves a ProxyAccount resource.
      operationId: api_proxy_accounts_id_get
      parameters:
        - name: id
          in: path
          description: ProxyAccount identifier
          required: true
          deprecated: false
          schema:
            type: string
      responses:
        '200':
          description: ProxyAccount resource
          content:
            application/ld+json:
              schema:
                $ref: '#/components/schemas/ProxyAccount.jsonld-read'
            application/json:
              schema:
                $ref: '#/components/schemas/ProxyAccount-read'
            text/html:
              schema:
                $ref: '#/components/schemas/ProxyAccount-read'
        '403':
          description: Forbidden
        '404':
          description: Resource not found
      deprecated: false
components:
  schemas:
    ProxyAccount.jsonld-read:
      type: object
      description: ''
      deprecated: false
      properties:
        '@context':
          readOnly: true
          oneOf:
            - type: string
            - type: object
              properties:
                '@vocab':
                  type: string
                hydra:
                  type: string
                  enum:
                    - http://www.w3.org/ns/hydra/core#
              required:
                - '@vocab'
                - hydra
              additionalProperties: true
        '@id':
          readOnly: true
          type: string
        '@type':
          readOnly: true
          type: string
        description:
          maxLength: 256
          type:
            - string
            - 'null'
        enabled_by_admin:
          default: true
          example: true
          type: boolean
        status:
          readOnly: true
          default: ACCOUNT_BLOCKED
          example: ACCOUNT_BLOCKED
          type: string
        is_active:
          readOnly: true
          type: boolean
        enabled:
          default: true
          example: true
          type: boolean
        id:
          readOnly: true
          type: string
        ip_whitelist:
          $ref: '#/components/schemas/IPWhitelist.jsonld-read'
        plain_password:
          minLength: 6
          type:
            - string
            - 'null'
        quota:
          type: integer
        username:
          minLength: 6
          type: string
        hash:
          readOnly: true
          type: string
        quota_str:
          readOnly: true
          type: string
        bytes_recv:
          type: integer
        bytes_sent:
          type: integer
        consumption:
          readOnly: true
          type: integer
        consumption_str:
          readOnly: true
          type: string
    ProxyAccount-read:
      type: object
      description: ''
      deprecated: false
      properties:
        description:
          maxLength: 256
          type:
            - string
            - 'null'
        enabled_by_admin:
          default: true
          example: true
          type: boolean
        status:
          readOnly: true
          default: ACCOUNT_BLOCKED
          example: ACCOUNT_BLOCKED
          type: string
        is_active:
          readOnly: true
          type: boolean
        enabled:
          default: true
          example: true
          type: boolean
        id:
          readOnly: true
          type: string
        ip_whitelist:
          $ref: '#/components/schemas/IPWhitelist-read'
        plain_password:
          minLength: 6
          type:
            - string
            - 'null'
        quota:
          type: integer
        username:
          minLength: 6
          type: string
        hash:
          readOnly: true
          type: string
        quota_str:
          readOnly: true
          type: string
        bytes_recv:
          type: integer
        bytes_sent:
          type: integer
        consumption:
          readOnly: true
          type: integer
        consumption_str:
          readOnly: true
          type: string
    IPWhitelist.jsonld-read:
      type: object
      description: ''
      deprecated: false
      properties:
        '@context':
          readOnly: true
          oneOf:
            - type: string
            - type: object
              properties:
                '@vocab':
                  type: string
                hydra:
                  type: string
                  enum:
                    - http://www.w3.org/ns/hydra/core#
              required:
                - '@vocab'
                - hydra
              additionalProperties: true
        '@id':
          readOnly: true
          type: string
        '@type':
          readOnly: true
          type: string
        ips:
          type: array
          items:
            type: string
        ports:
          type: array
          items:
            $ref: '#/components/schemas/Port.jsonld-read'
        is_enabled:
          type: boolean
    IPWhitelist-read:
      type: object
      description: ''
      deprecated: false
      properties:
        ips:
          type: array
          items:
            type: string
        ports:
          type: array
          items:
            $ref: '#/components/schemas/Port-read'
        is_enabled:
          type: boolean
    Port.jsonld-read:
      type: object
      description: ''
      deprecated: false
      properties:
        '@context':
          readOnly: true
          oneOf:
            - type: string
            - type: object
              properties:
                '@vocab':
                  type: string
                hydra:
                  type: string
                  enum:
                    - http://www.w3.org/ns/hydra/core#
              required:
                - '@vocab'
                - hydra
              additionalProperties: true
        '@id':
          readOnly: true
          type: string
        '@type':
          readOnly: true
          type: string
        port:
          minimum: '2000'
          maximum: '2999'
          type: integer
        type:
          enum:
            - residential
            - mobile
          type:
            - string
            - 'null'
        country:
          minLength: 2
          maxLength: 2
          pattern: ^([A-Z]+)$
          type:
            - string
            - 'null'
        city:
          minLength: 1
          maxLength: 100
          pattern: ^([a-z'-]+)$
          type:
            - string
            - 'null'
        session:
          minLength: 3
          maxLength: 32
          type:
            - string
            - 'null'
        sess_time:
          minimum: 1
          maximum: 60
          type:
            - integer
            - 'null'
        sess_replace:
          type:
            - boolean
            - 'null'
        sess_ip_collision:
          enum:
            - strict
            - flexible
          type:
            - string
            - 'null'
    Port-read:
      type: object
      description: ''
      deprecated: false
      properties:
        port:
          minimum: '2000'
          maximum: '2999'
          type: integer
        type:
          enum:
            - residential
            - mobile
          type:
            - string
            - 'null'
        country:
          minLength: 2
          maxLength: 2
          pattern: ^([A-Z]+)$
          type:
            - string
            - 'null'
        city:
          minLength: 1
          maxLength: 100
          pattern: ^([a-z'-]+)$
          type:
            - string
            - 'null'
        session:
          minLength: 3
          maxLength: 32
          type:
            - string
            - 'null'
        sess_time:
          minimum: 1
          maximum: 60
          type:
            - integer
            - 'null'
        sess_replace:
          type:
            - boolean
            - 'null'
        sess_ip_collision:
          enum:
            - strict
            - flexible
          type:
            - string
            - 'null'
  securitySchemes:
    apiHeader:
      type: apiKey
      description: Value for the api-key header parameter.
      name: api-key
      in: header

````