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

# Get VPN ID

> Get Information and Installation instruction of a given VPN License ID



## OpenAPI

````yaml get /vpn/{vid}
openapi: 3.0.2
info:
  title: OneFirewall Alliance - OpenAPI 3.0
  description: >-
    The API documentation site serves as a comprehensive resource for developers
    looking to utilize the OneFirewall Platform's application programming
    interface (API). It offers in-depth information on API endpoints,
    parameters, responses, and authentication processes. Additionally, it
    features practical examples and code snippets to assist developers in
    integrating the API into their own applications. The website is crafted to
    be user-friendly, intuitive, and easily navigable, enabling developers to
    swiftly locate the necessary information to begin working with the API.
  termsOfService: https://onefirewall.com/eula.html
  contact:
    email: support@onefirewall.com
    url: https://onefirewall.com/contact.html
    name: Engineering Division
  license:
    name: ''
    url: ''
  version: V4.18.0
servers:
  - url: https://app.onefirewall.com/api/v1
    description: OneFirewall Server
    variables: {}
security: []
tags:
  - name: IPv4 Feeds
    description: ''
    externalDocs:
      description: ''
      url: ''
  - name: IoCs
    description: ''
    externalDocs:
      description: ''
      url: ''
  - name: Tools
    description: ''
    externalDocs:
      description: ''
      url: ''
  - name: URL Feeds
    description: ''
    externalDocs:
      description: ''
      url: ''
  - name: Domain Feeds
    description: ''
    externalDocs:
      description: ''
      url: ''
  - name: Security Binary Feeds
    description: ''
    externalDocs:
      description: ''
      url: ''
  - name: Secure VPN
    description: Secure VPN by OneFirewall
    externalDocs:
      description: ''
      url: ''
  - name: WCF Agent
    description: ''
    externalDocs:
      description: ''
      url: ''
externalDocs:
  description: http://docs.onefirewall.com
  url: http://app.onefirewall.com
paths:
  /vpn/{vid}:
    parameters:
      - in: path
        name: vid
        description: VPN ID (Starts with OFA-VID-LIC prefix)
        schema:
          type: string
        required: true
    get:
      tags:
        - Secure VPN
      summary: Get VPN ID
      description: Get Information and Installation instruction of a given VPN License ID
      operationId: Get VPN ID
      parameters: []
      responses:
        '200':
          description: ''
          headers: {}
          content:
            application/json:
              schema:
                type: string
              examples:
                example1:
                  value:
                    vid: OFA-VID-LIC-XXXXXX
                    account_name: Test
                    notes: ''
                    ts: 1720917876
                    user:
                      guid: OFA-GUID-2091-4193-9813
                      name: Name
                      surname: Surname
                      username: name.surname@onefirewall.com
                      role: 0
                      unsuccessful_login: 0
                      member_of:
                        gid: OFA-GID-XXXXXXX
                        name: OneFirewall Alliance LTD
                        trust: 0.85
                        delay: '0'
                        credit_tokens: 20003000
                        debit_tokens: 2597036
                        is_public: 0
                    mgid: OFA-GID-XXXXXXXXX
                    exist: true
      security:
        - Authorization: []
components:
  securitySchemes:
    Authorization:
      type: apiKey
      in: header
      description: Authorization Token
      name: Authorization

````