Personal Access Token (PAT) passed in the Authorization header (e.g., Bearer <pat>) for authenticated API requests. PATs are generated via /auth/generate-pat after authenticating through the magic link flow.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"OneFirewall Documentation","colors":{"primary":"#0D9373","light":"#4475C5","dark":"#0C1427"},"favicon":"https://mintcdn.com/onefirewall/7guFu20M_sXWrG3T/favicon.png?fit=max\u0026auto=format\u0026n=7guFu20M_sXWrG3T\u0026q=85\u0026s=ec7b5d5a9ef605b4f89a6c961952575f","logo":{"light":"https://mintcdn.com/onefirewall/GBluirlWMPo2oQeM/logo/onefirewall-logo.png?fit=max\u0026auto=format\u0026n=GBluirlWMPo2oQeM\u0026q=85\u0026s=d78bae863124f3528cae4cec0b4c383a","dark":"https://app.onefirewall.com/assets/images/logo-negativ.png"},"api":{"openapi":["gateway-api.json","closedvpn/openapi.json"]},"navbar":{"links":[{"label":"Support","href":"https://onefirewall.com/contact.html?subject=Urgent:%20Immediate%20Assistance%20Required"}],"primary":{"type":"button","label":"Start Free Trial","href":"https://onefirewall.com/proof-of-value.html"}},"footer":{"socials":{"website":"https://onefirewall.com","github":"https://github.com/onefirewall","linkedin":"https://www.linkedin.com/company/onefirewall-alliance"}},"integrations":{"ga4":{"measurementId":"G-P017T6ZNCY"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Proof of Value","href":"https://onefirewall.com/proof-of-value.html","icon":"terminal"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"onefirewall","hasAudioNarration":false,"actualSubdomain":"onefirewall","customDomains":["docs.onefirewall.com"],"gitSource":{"type":"github","owner":"onefirewall","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aec74568029e5fb8e3e3efa","collectionId":"3a6f527a-b185-448c-9283-f5e9555a07e4","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aec74568029e5fb8e3e3efa"},"entitlements":{},"buildId":"6aec74568029e5fb8e3e3efa","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"Documentation","count":92},{"language":"default","tag":"API - ClosedVPN","count":38},{"language":"default","tag":"API - OneFirewall","count":34},{"language":"default","tag":"Case Studies","count":29},{"language":"default","tag":"Essentials","count":23},{"language":"default","tag":"Releases","count":17},{"language":"default","tag":"WCF Agent","count":14},{"language":"default","tag":"Offensive Security","count":9},{"language":"default","tag":"AI Gateway","count":7},{"language":"default","tag":"Organizations","count":6}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"closedvpn/endpoint/vpn-configurations/get-vpn-config","slug":"/closedvpn/endpoint/vpn-configurations/get-vpn-config","pageMetadata":{"title":"Get VPN Configuration","openapi":"GET /auth/vpn-config/{id}","description":"Returns details of a specific active VPN configuration by ID.","href":"/closedvpn/endpoint/vpn-configurations/get-vpn-config"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns details of a specific active VPN configuration by ID.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get VPN Configuration","openapi":"GET /auth/vpn-config/{id}","description":"Returns details of a specific active VPN configuration by ID.","href":"/closedvpn/endpoint/vpn-configurations/get-vpn-config"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["VPN Configurations"],"operationId":"getVPNConfig","summary":"Get a specific VPN configuration","description":"Returns details of a specific active VPN configuration by ID.","security":["844b4a03-1552-43e9-8880-10912a27fde0"],"parameters":["4cf5c93f-8856-4374-a018-84984c1f3752"],"responses":{"200":"e8ad7143-cc7d-4865-93d5-cc6e12adaca0","401":"9cd3e4e1-55b3-4d69-9a06-13a337392d4b","403":"2d29ee52-1e75-4ddf-af64-5e7e712cbed2","404":"8329f1a5-fd5e-49bb-b6e5-3dd2cc3ca311","500":"c5c226d7-bb3a-41d1-a030-27c9f303e520"},"method":"get","type":"path","servers":["bc20a847-4913-41d6-9589-c098b681d39c"],"path":"/auth/vpn-config/{id}","baseUrlOptions":["https://closedvpn.io"],"title":"Get a specific VPN configuration","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"4cf5c93f-8856-4374-a018-84984c1f3752":{"name":"id","in":"path","required":true,"schema":{"type":"string","example":"60c72b2f5f1b2c001c8e4b1a","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"e8ad7143-cc7d-4865-93d5-cc6e12adaca0":{"description":"VPN configuration retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"vpnConfig":{"type":"object","properties":{"_id":{"type":"string","example":"60c72b2f5f1b2c001c8e4b2a","uniqueKey":"vpnConfig._id","typeLabel":"string"},"name":{"type":"string","example":"Frankfurt Node","uniqueKey":"vpnConfig.name","typeLabel":"string"},"config":{"type":"object","description":"Configuration document for a VPN server. Additional keys are stored and returned unchanged. The `commands` and `private` sections are required for certificate issuance and user statistics to work.\n","properties":{"location":{"type":"string","example":"Frankfurt, Germany","uniqueKey":"vpnConfig.config.location","typeLabel":"string"},"coordinates":{"type":"array","description":"Node position as [latitude, longitude]. Defaults to [0, 0] if not a two-element array.\n","items":{"type":"number","uniqueKey":"vpnConfig.config.coordinates.items.[INDEX]","typeLabel":"number"},"minItems":2,"maxItems":2,"example":[50.1109,8.6821],"uniqueKey":"vpnConfig.config.coordinates","typeLabel":"number[]"},"usage_percentage":{"type":"number","description":"Current load as a percentage. Defaults to 0.","example":45,"uniqueKey":"vpnConfig.config.usage_percentage","typeLabel":"number"},"img":{"type":"string","description":"Flag or icon path. Defaults to /img/countries/DF.png.","example":"/img/countries/DE.png","uniqueKey":"vpnConfig.config.img","typeLabel":"string"},"access":{"type":"array","description":"Emails permitted to read and modify this configuration. The creator is always added automatically.\n","items":{"type":"string","format":"email","uniqueKey":"vpnConfig.config.access.items.[INDEX]","typeLabel":"string\u003cemail>"},"example":["[email protected]"],"uniqueKey":"vpnConfig.config.access","typeLabel":"string\u003cemail>[]"},"orgs":{"type":"array","description":"ObjectIds of organizations assigned to this VPN","items":{"type":"string","uniqueKey":"vpnConfig.config.orgs.items.[INDEX]","typeLabel":"string"},"uniqueKey":"vpnConfig.config.orgs","typeLabel":"string[]"},"commands":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"vpnConfig.config.commands.additionalProperties","typeLabel":"string"},"description":"Named shell commands run over SSH on the VPN host. `create_cert` is required by `/auth/download-certificate` and `get_users_stats` by `/auth/vpn-user-stats`. Occurrences of `CLIENT_NAME` are replaced at run time with the requesting member's client identifier.\n","example":{"create_cert":"/opt/vpn/create-client.sh CLIENT_NAME","get_users_stats":"/opt/vpn/user-stats.sh CLIENT_NAME"},"uniqueKey":"vpnConfig.config.commands","typeLabel":"object"},"private":{"type":"object","description":"SSH connection details for the VPN host. Stripped from `/auth/vpn-exit-nodes` responses.\n","properties":{"server":{"type":"string","example":"vpn-fra.closedvpn.io","uniqueKey":"vpnConfig.config.private.server","typeLabel":"string"},"port":{"type":"integer","default":22,"example":22,"uniqueKey":"vpnConfig.config.private.port","typeLabel":"integer"},"user":{"type":"string","example":"vpnadmin","uniqueKey":"vpnConfig.config.private.user","typeLabel":"string"},"ssh_public_key":{"type":"string","description":"Generated by the platform when the configuration is created. Install it on the VPN host so the platform can connect.\n","uniqueKey":"vpnConfig.config.private.ssh_public_key","typeLabel":"string"}},"uniqueKey":"vpnConfig.config.private","typeLabel":"object"}},"uniqueKey":"vpnConfig.config","typeLabel":"object"},"users":{"type":"array","items":{"type":"string","format":"email","uniqueKey":"vpnConfig.users.items.[INDEX]","typeLabel":"string\u003cemail>"},"uniqueKey":"vpnConfig.users","typeLabel":"string\u003cemail>[]"},"active":{"type":"boolean","example":true,"uniqueKey":"vpnConfig.active","typeLabel":"boolean"},"createdAt":{"type":"integer","format":"int64","description":"Unix epoch milliseconds","example":1735689600000,"uniqueKey":"vpnConfig.createdAt","typeLabel":"integer\u003cint64>"},"updatedAt":{"type":"integer","format":"int64","description":"Unix epoch milliseconds","example":1735689600000,"uniqueKey":"vpnConfig.updatedAt","typeLabel":"integer\u003cint64>"}},"uniqueKey":"vpnConfig","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"vpnConfig":{"_id":"60c72b2f5f1b2c001c8e4b2a","name":"Frankfurt Node","config":{"location":"Frankfurt, Germany","coordinates":[50.1109,8.6821],"usage_percentage":45,"img":"/img/countries/DE.png","access":["[email protected]"],"orgs":["\u003cstring>"],"commands":{"create_cert":"/opt/vpn/create-client.sh CLIENT_NAME","get_users_stats":"/opt/vpn/user-stats.sh CLIENT_NAME"},"private":{"server":"vpn-fra.closedvpn.io","port":22,"user":"vpnadmin","ssh_public_key":"\u003cstring>"}},"users":["[email protected]"],"active":true,"createdAt":1735689600000,"updatedAt":1735689600000}}}},"exampleType":"generated"}},"exampleType":"generated"},"9cd3e4e1-55b3-4d69-9a06-13a337392d4b":{"description":"Unauthorized (invalid or missing PAT)","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Unauthorized","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Unauthorized"}}},"exampleType":"generated"}},"exampleType":"generated"},"2d29ee52-1e75-4ddf-af64-5e7e712cbed2":{"description":"Forbidden (no access to this VPN configuration)","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"You do not have permission to view this VPN configuration","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"You do not have permission to view this VPN configuration"}}},"exampleType":"generated"}},"exampleType":"generated"},"8329f1a5-fd5e-49bb-b6e5-3dd2cc3ca311":{"description":"VPN configuration not found or inactive","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"VPN configuration not found or inactive","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"VPN configuration not found or inactive"}}},"exampleType":"generated"}},"exampleType":"generated"},"c5c226d7-bb3a-41d1-a030-27c9f303e520":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Error fetching VPN configuration","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Error fetching VPN configuration"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"844b4a03-1552-43e9-8880-10912a27fde0":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"PAT","description":"Personal Access Token (PAT) passed in the Authorization header (e.g., `Bearer \u003cpat>`) for authenticated API requests. PATs are generated via `/auth/generate-pat` after authenticating through the magic link flow.\n","scopes":[]}}},"servers":{"bc20a847-4913-41d6-9589-c098b681d39c":{"url":"https://closedvpn.io","description":"Production server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"PAT","description":"Personal Access Token (PAT) passed in the Authorization header (e.g., `Bearer \u003cpat>`) for authenticated API requests. PATs are generated via `/auth/generate-pat` after authenticating through the magic link flow.\n","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Personal Access Token (PAT) passed in the Authorization header (e.g., `Bearer \u003cpat>`) for authenticated API requests. PATs are generated via `/auth/generate-pat` after authenticating through the magic link flow.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"closedvpn/openapi.json"},"subdomain":"onefirewall","siteName":"OneFirewall Documentation","title":"Get VPN Configuration - OneFirewall Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-06T20:17:36.321Z","originalFileLocation":"closedvpn/endpoint/vpn-configurations/get-vpn-config.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns details of a specific active VPN configuration by ID.\">\u003cmeta data-mint-head name=\"application-name\" content=\"OneFirewall Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/onefirewall/gIVqeDr01J3QMgeg/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/onefirewall/gIVqeDr01J3QMgeg/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/onefirewall/gIVqeDr01J3QMgeg/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/onefirewall/gIVqeDr01J3QMgeg/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/onefirewall/gIVqeDr01J3QMgeg/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/onefirewall/gIVqeDr01J3QMgeg/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/onefirewall/gIVqeDr01J3QMgeg/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/onefirewall/gIVqeDr01J3QMgeg/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/onefirewall/gIVqeDr01J3QMgeg/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get VPN Configuration - OneFirewall Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns details of a specific active VPN configuration by ID.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OneFirewall Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.onefirewall.com/closedvpn/endpoint/vpn-configurations/get-vpn-config\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://onefirewall.mintlify.site/_mintlify/api/og/v2?division=VPN+Configurations\u0026amp;title=Get+VPN+Configuration\u0026amp;description=Returns+details+of+a+specific+active+VPN+configuration+by+ID.\u0026amp;theme=d64f8676cbf42fa619f21957\u0026amp;signature=84a94fc85d2040aaa830c69c79323b73ba625039a21cf2fabc766173fa5d39a6\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get VPN Configuration - OneFirewall Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns details of a specific active VPN configuration by ID.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://onefirewall.mintlify.site/_mintlify/api/og/v2?division=VPN+Configurations\u0026amp;title=Get+VPN+Configuration\u0026amp;description=Returns+details+of+a+specific+active+VPN+configuration+by+ID.\u0026amp;theme=d64f8676cbf42fa619f21957\u0026amp;signature=84a94fc85d2040aaa830c69c79323b73ba625039a21cf2fabc766173fa5d39a6\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/onefirewall/gIVqeDr01J3QMgeg/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"OneFirewall Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.onefirewall.com/closedvpn/endpoint/vpn-configurations/get-vpn-config\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/closedvpn/endpoint/vpn-configurations/get-vpn-config.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.onefirewall.com/#organization\",\"name\":\"OneFirewall Documentation\",\"url\":\"https://docs.onefirewall.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/onefirewall/GBluirlWMPo2oQeM/logo/onefirewall-logo.png?fit=max\u0026auto=format\u0026n=GBluirlWMPo2oQeM\u0026q=85\u0026s=d78bae863124f3528cae4cec0b4c383a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.onefirewall.com#website\",\"name\":\"OneFirewall Documentation\",\"url\":\"https://docs.onefirewall.com\",\"publisher\":{\"@id\":\"https://docs.onefirewall.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.onefirewall.com/closedvpn/endpoint/vpn-configurations/get-vpn-config#webpage\",\"url\":\"https://docs.onefirewall.com/closedvpn/endpoint/vpn-configurations/get-vpn-config\",\"name\":\"Get VPN Configuration\",\"description\":\"Returns details of a specific active VPN configuration by ID.\",\"dateModified\":\"2026-09-06T20:17:36.321Z\",\"isPartOf\":{\"@id\":\"https://docs.onefirewall.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.onefirewall.com/closedvpn/endpoint/vpn-configurations/get-vpn-config#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.onefirewall.com/closedvpn/endpoint/vpn-configurations/get-vpn-config#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"VPN Configurations\",\"item\":\"https://docs.onefirewall.com/closedvpn/endpoint/vpn-configurations/list-vpn-configs\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get VPN Configuration\",\"item\":\"https://docs.onefirewall.com/closedvpn/endpoint/vpn-configurations/get-vpn-config\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.onefirewall.com/closedvpn/endpoint/vpn-configurations/get-vpn-config#apireference\",\"headline\":\"Get VPN Configuration\",\"name\":\"Get VPN Configuration\",\"description\":\"Returns details of a specific active VPN configuration by ID.\",\"url\":\"https://docs.onefirewall.com/closedvpn/endpoint/vpn-configurations/get-vpn-config\",\"mainEntityOfPage\":{\"@id\":\"https://docs.onefirewall.com/closedvpn/endpoint/vpn-configurations/get-vpn-config#webpage\"},\"dateModified\":\"2026-09-06T20:17:36.321Z\",\"publisher\":{\"@id\":\"https://docs.onefirewall.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.onefirewall.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"OneFirewall Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"OneFirewall Documentation","nav":{"global":{"anchors":[{"anchor":"Proof of Value","href":"https://onefirewall.com/proof-of-value.html","icon":"terminal"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API - OneFirewall","pages":[{"title":"API - OneFirewall","href":"/api-reference/introduction"}]},{"tab":"API - ClosedVPN","groups":[{"group":"ClosedVPN API","pages":[{"title":"Introduction","href":"/closedvpn/introduction"},{"title":"Authorization","href":"/closedvpn/authorization"},{"title":"Creating a VPN Certificate","href":"/closedvpn/create-vpn-cert"}]},{"group":"Authentication","pages":[{"title":"Send Magic Link","openapi":"POST /auth/send-magic-link","href":"/closedvpn/endpoint/authentication/send-magic-link"},{"title":"Verify Magic Link","openapi":"GET /auth/verify-magic-link","href":"/closedvpn/endpoint/authentication/verify-magic-link"},{"title":"Validate Token","openapi":"GET /auth/validate-token","href":"/closedvpn/endpoint/authentication/validate-token"},{"title":"Logout","openapi":"POST /auth/logout","href":"/closedvpn/endpoint/authentication/logout"}]},{"group":"Personal Access Tokens","pages":[{"title":"Generate PAT","openapi":"POST /auth/generate-pat","href":"/closedvpn/endpoint/personal-access-tokens/generate-pat"},{"title":"List PATs","openapi":"GET /auth/get-pats","href":"/closedvpn/endpoint/personal-access-tokens/get-pats"},{"title":"Revoke PAT","openapi":"POST /auth/delete-pat","href":"/closedvpn/endpoint/personal-access-tokens/delete-pat"}]},{"group":"Profile","pages":[{"title":"Update Profile","openapi":"PUT /auth/settings-profile","href":"/closedvpn/endpoint/profile/update-profile"}]},{"group":"Organizations","pages":[{"title":"List Organizations","openapi":"GET /auth/get-orgs","href":"/closedvpn/endpoint/organizations/get-orgs"},{"title":"Get Organization","openapi":"GET /auth/get-org/{org_id}","href":"/closedvpn/endpoint/organizations/get-org"},{"title":"Create Organization","openapi":"POST /auth/create-org","href":"/closedvpn/endpoint/organizations/create-org"},{"title":"Update Organization","openapi":"POST /auth/update-org","href":"/closedvpn/endpoint/organizations/update-org"},{"title":"Select Organization","openapi":"POST /auth/select-org","href":"/closedvpn/endpoint/organizations/select-org"},{"title":"Delete Organization","openapi":"POST /auth/delete-org","href":"/closedvpn/endpoint/organizations/delete-org"}]},{"group":"Members","pages":[{"title":"Add Member","openapi":"POST /auth/add-user","href":"/closedvpn/endpoint/members/add-user"},{"title":"Update Member Role","openapi":"POST /auth/update-user-role","href":"/closedvpn/endpoint/members/update-user-role"},{"title":"Remove Member","openapi":"POST /auth/remove-user","href":"/closedvpn/endpoint/members/remove-user"},{"title":"Leave Organization","openapi":"POST /auth/leave-org","href":"/closedvpn/endpoint/members/leave-org"}]},{"group":"VPN Certificates","pages":[{"title":"Download Certificate","openapi":"GET /auth/download-certificate","href":"/closedvpn/endpoint/certificates/download-certificate"}]},{"group":"VPN Configurations","pages":[{"title":"List VPN Configurations","openapi":"GET /auth/vpn-configs","description":"Returns a list of active VPN configurations the authenticated user has access to.","href":"/closedvpn/endpoint/vpn-configurations/list-vpn-configs"},{"title":"Get VPN Configuration","openapi":"GET /auth/vpn-config/{id}","href":"/closedvpn/endpoint/vpn-configurations/get-vpn-config"},{"title":"Create VPN Configuration","openapi":"POST /auth/create-vpn-config","description":"Creates a new VPN server configuration. Generates an SSH key pair automatically. Requires the user to have at least one existing configuration access.","href":"/closedvpn/endpoint/vpn-configurations/create-vpn-config"},{"title":"Update VPN Configuration","openapi":"PUT /auth/update-vpn-config/{id}","href":"/closedvpn/endpoint/vpn-configurations/update-vpn-config"},{"title":"Delete VPN Configuration","openapi":"DELETE /auth/delete-vpn-config/{id}","href":"/closedvpn/endpoint/vpn-configurations/delete-vpn-config"},{"title":"Execute VPN Command","openapi":"POST /auth/execute-vpn-command/{id}","href":"/closedvpn/endpoint/vpn-configurations/execute-vpn-command"}]},{"group":"VPN Exit Nodes","pages":[{"title":"List Exit Nodes","openapi":"GET /auth/vpn-exit-nodes","href":"/closedvpn/endpoint/vpn-exit-nodes/vpn-exit-nodes"},{"title":"List All VPNs","openapi":"GET /auth/vpns","href":"/closedvpn/endpoint/vpn-exit-nodes/list-vpns"}]},{"group":"Statistics","pages":[{"title":"VPN User Stats","openapi":"GET /auth/vpn-user-stats","href":"/closedvpn/endpoint/statistics/vpn-user-stats"},{"title":"VPN Traffic Report","openapi":"GET /auth/vpn-report-stats","href":"/closedvpn/endpoint/statistics/vpn-report-stats"},{"title":"Threat Prevention Stats","openapi":"GET /auth/threat-prevention-stats","href":"/closedvpn/endpoint/statistics/threat-prevention-stats"}]},{"group":"Notifications","pages":[{"title":"List Notifications","openapi":"GET /auth/get-notifications","href":"/closedvpn/endpoint/notifications/get-notifications"},{"title":"Count Notifications","openapi":"GET /auth/count-notifications","href":"/closedvpn/endpoint/notifications/count-notifications"},{"title":"Mark Notification Read","openapi":"POST /auth/mark-notification-read","href":"/closedvpn/endpoint/notifications/mark-notification-read"},{"title":"Mark All Notifications Read","openapi":"POST /auth/mark-all-notifications-read","href":"/closedvpn/endpoint/notifications/mark-all-notifications-read"}]},{"group":"Activity Logs","pages":[{"title":"Activity Logs","openapi":"GET /auth/activity-logs","href":"/closedvpn/endpoint/activity-logs/activity-logs"}]}]},{"tab":"Offensive Security","pages":[{"title":"Offensive Security","href":"/offensive-security/introduction"}]},{"tab":"AI Gateway","pages":[{"title":"AI Gateway","href":"/ai-gateway/introduction"}]}]},"basePath":"","title":"Get VPN Configuration - OneFirewall Documentation","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}