[{"data":1,"prerenderedAt":333},["ShallowReactive",2],{"docs-slug-navigation":3,"content-paths":31,"doc-create-api-key":63,"docs-navigation":322},[4,9,14,19,25],{"path":5,"navigation":6},"\u002Fdocs\u002Fgetting-started",{"title":7,"icon":8},"Getting Started","mdi-file-document-outline",{"path":10,"navigation":11},"\u002Fdocs\u002Flinux",{"title":12,"icon":13},"Linux","mdi-linux",{"path":15,"navigation":16},"\u002Fdocs\u002Fwindows",{"title":17,"icon":18},"Windows","mdi-microsoft-windows",{"path":20,"navigation":21},"\u002Fdocs\u002Fdocker",{"title":22,"icon":23,"description":24},"Docker","mdi-docker","Expose your Docker Compose services to the internet through a GetPublicIP tunnel.",{"path":26,"navigation":27},"\u002Fdocs\u002Fcreate-api-key",{"title":28,"icon":29,"description":30},"Create API Key","mdi-key","Create and manage an API key so tools can configure one of your IP addresses for you.",[32,33,34,35,36,37,39,41,43,45,47,49,51,53,55,57,59,61],{"path":5},{"path":10},{"path":15},{"path":20},{"path":26},{"path":38},"\u002Fguides\u002Ffind-your-public-ip-address\u002Ffind-your-ip-address-on-linux",{"path":40},"\u002Fguides\u002Ffind-your-public-ip-address\u002Ffind-your-ip-address-on-windows",{"path":42},"\u002Fguides\u002Ffind-your-public-ip-address",{"path":44},"\u002Fguides\u002Fself-hosting\u002Fexpose-home-server-to-internet",{"path":46},"\u002Fguides\u002Fself-hosting\u002Fgetpublicip-vs-cloudflare-tunnel-vs-tailscale",{"path":48},"\u002Fguides\u002Fself-hosting\u002Fport-forwarding-not-working",{"path":50},"\u002Fguides\u002Fself-hosting\u002Fself-hosting-behind-carrier-grade-nat-cgnat",{"path":52},"\u002Fguides\u002Fself-hosting\u002Fwireguard-simple-watchdog-script",{"path":54},"\u002Fguides\u002Fstatic-public-ip-address\u002Fhow-to-get-a-public-ip-address",{"path":56},"\u002Fguides\u002Fstatic-public-ip-address\u002Fhow-to-get-a-static-ip-address",{"path":58},"\u002Fguides\u002Fstatic-public-ip-address",{"path":60},"\u002Fguides\u002Fuse-cases\u002Fhome-server",{"path":62},"\u002Fguides\u002Fuse-cases\u002Foffice-server",{"id":64,"title":65,"body":66,"createdAt":308,"description":309,"extension":310,"faq":311,"meta":317,"navigation":318,"path":26,"seo":319,"stem":320,"updatedAt":308,"__hash__":321},"docs\u002Fdocs\u002F5.create-api-key.md","GetPublicIP - Create an API Key",{"type":67,"value":68,"toc":299},"minimark",[69,74,85,93,96,101,110,120,124,139,145,148,152,162,168,172,175,181,187,193,204,208,214,234,238,250,259,268,277,286,289],[70,71,73],"h1",{"id":72},"create-an-api-key","Create an API Key",[75,76,77,78,84],"p",{},"An API key lets a program manage one of your IP addresses for you, reading its\nconfiguration, updating its port mappings and downloading its WireGuard config,\nall without anyone signing in to the dashboard. The\n",[79,80,83],"a",{"className":81,"href":20},[82],"link","Docker agent"," uses one to keep your port\nforwarding in step with your containers as they restart.",[75,86,87,88,92],{},"Keys belong to a ",[89,90,91],"strong",{},"single IP address",", not to your account. If you have several\nIP addresses, each one has its own key, and a key never grants access to any of\nthe others.",[94,95],"docs-toc",{},[97,98,100],"h2",{"id":99},"open-your-ip-address","Open your IP address",[75,102,103,104,109],{},"Go to ",[79,105,108],{"className":106,"href":107},[82],"\u002Fdashboard\u002Fyour-ips","Your IPs"," in the dashboard and\nclick the pencil icon at the end of the row for the IP address you want a key for.",[75,111,112],{},[113,114],"img",{"alt":115,"quality":116,"src":117,"width":118,"preload":119},"The Your IPs list in the GetPublicIP dashboard, with the pencil edit icon at the end of the IP address row highlighted","80","\u002Fimages\u002Fapi-key\u002Fapikey-1.png",850,"",[97,121,123],{"id":122},"find-api-access","Find API Access",[75,125,126,127,130,131,134,135,138],{},"Expand the ",[89,128,129],{},"Configuration"," section. ",[89,132,133],{},"API Access"," sits on the right, next to the\nWireGuard config downloads. Click ",[89,136,137],{},"Manage API Key",".",[75,140,141],{},[113,142],{"alt":143,"quality":116,"src":144,"width":118},"The Configuration section of an IP address, showing the API Access panel and its Manage API Key button","\u002Fimages\u002Fapi-key\u002Fapikey-2.png",[75,146,147],{},"You can do this at any time. An IP address does not have to finish provisioning\nbefore you create its key.",[97,149,151],{"id":150},"create-the-key","Create the key",[75,153,154,155,158,159,138],{},"If this IP address has no key yet, the dialog reads ",[89,156,157],{},"No API key found",". Click\n",[89,160,161],{},"Create",[75,163,164],{},[113,165],{"alt":166,"quality":116,"src":167,"width":118},"The Manage API Key dialog before a key exists, reading No API key found, with the Create button highlighted","\u002Fimages\u002Fapi-key\u002Fapikey-3.png",[97,169,171],{"id":170},"copy-the-key","Copy the key",[75,173,174],{},"The key appears immediately, along with the time it was created. Use the copy icon\non the right of the field to put it on your clipboard.",[75,176,177],{},[113,178],{"alt":179,"quality":116,"src":180,"width":118},"The Manage API Key dialog after creation, showing the generated key and the copy icon beside it","\u002Fimages\u002Fapi-key\u002Fapikey-4.png",[75,182,183,186],{},[89,184,185],{},"Treat this key like a password."," Anyone holding it can change how your IP\naddress forwards traffic and download its WireGuard configuration.",[75,188,189,190,192],{},"You do not have to save it right now, though. Unlike most services, GetPublicIP\ndoes not hide the key after you first see it. Reopen ",[89,191,137],{}," whenever\nyou need it again.",[75,194,195,198,199,203],{},[89,196,197],{},"Last Used"," stays at ",[200,201,202],"em",{},"Never"," until something authenticates with the key, then\nupdates on every request. It is the quickest way to confirm a tool you have set up\nis really reaching us.",[97,205,207],{"id":206},"replacing-and-revoking-a-key","Replacing and revoking a key",[75,209,210,211,213],{},"Both actions live in the same ",[89,212,137],{}," dialog.",[215,216,217,228],"ul",{},[218,219,220,222,223,227],"li",{},[89,221,161],{}," replaces the existing key with a new one. There is no confirmation\nstep, and the old key stops working the moment the new one appears, so anything\nstill using it, such as a running Docker agent, will start failing with ",[224,225,226],"code",{},"401","\nuntil you give it the new key. Do not press Create just to check what your key\nis; reopening the dialog already shows you.",[218,229,230,233],{},[89,231,232],{},"Delete"," revokes the key and leaves the IP address without one. Your tunnel,\nyour port mappings and the IP address itself are untouched, and only\nprogrammatic access is withdrawn. Create a new key whenever you want it back.",[97,235,237],{"id":236},"frequently-asked-questions","Frequently Asked Questions",[239,240,243,247],"details",{"className":241},[242],"faq-item",[244,245,246],"summary",{},"Is an API key tied to my account or to a single IP address?",[75,248,249],{},"To a single IP address. Each IP address in your dashboard has its own key, and a key only ever grants access to the one it belongs to. If you run several IP addresses, create a separate key for each.",[239,251,253,256],{"className":252},[242],[244,254,255],{},"Can I see my API key again after I have created it?",[75,257,258],{},"Yes. The key is not shown only once. Reopen Manage API Key on that IP address at any time and it is still there to copy, so you do not need to save it somewhere before closing the dialog.",[239,260,262,265],{"className":261},[242],[244,263,264],{},"What happens if I press Create when I already have a key?",[75,266,267],{},"You get a brand new key and the old one stops working immediately. There is no confirmation step, so avoid pressing Create as a way of checking your key. Anything still using the previous key, such as a running Docker agent, will start receiving 401 errors until you give it the new one.",[239,269,271,274],{"className":270},[242],[244,272,273],{},"How do I revoke an API key?",[75,275,276],{},"Open Manage API Key on that IP address and press Delete. The key stops working straight away. Your IP address, its tunnel and its port mappings are all unaffected, and only programmatic access is withdrawn.",[239,278,280,283],{"className":279},[242],[244,281,282],{},"Do I need an API key to use my public IP address?",[75,284,285],{},"No. You can download your WireGuard configuration and edit port mappings from the dashboard without one. A key is only needed when you want a tool to do that for you, such as the GetPublicIP Docker agent.",[287,288],"hr",{},[75,290,291,292,295,296,138],{},"Ready to use your key? The ",[79,293,22],{"className":294,"href":20},[82]," guide\nshows how to expose your containers through your public IP address. New to\nGetPublicIP? Start with\n",[79,297,7],{"className":298,"href":5},[82],{"title":119,"searchDepth":300,"depth":300,"links":301},2,[302,303,304,305,306,307],{"id":99,"depth":300,"text":100},{"id":122,"depth":300,"text":123},{"id":150,"depth":300,"text":151},{"id":170,"depth":300,"text":171},{"id":206,"depth":300,"text":207},{"id":236,"depth":300,"text":237},"2026-08-10","Create an API key for one of your IP addresses so tools like the GetPublicIP Docker agent can manage its port mappings and configuration for you.","md",[312,313,314,315,316],{"question":246,"answer":249},{"question":255,"answer":258},{"question":264,"answer":267},{"question":273,"answer":276},{"question":282,"answer":285},{},{"title":28,"icon":29,"description":30},{"title":65,"description":309},"docs\u002F5.create-api-key","QUqBINnvFmQXhDnn4k7sUHolf5yIgfVuugitUO_QoK8",[323,325,327,329,331],{"path":5,"navigation":324},{"title":7,"icon":8},{"path":10,"navigation":326},{"title":12,"icon":13},{"path":15,"navigation":328},{"title":17,"icon":18},{"path":20,"navigation":330},{"title":22,"icon":23,"description":24},{"path":26,"navigation":332},{"title":28,"icon":29,"description":30},1786424706252]