[{"data":1,"prerenderedAt":472},["ShallowReactive",2],{"navLinks":3,"sidebar_docs_navigation_\u002Fdocs\u002Fcredits-and-auth":124,"navigation":169,"navLinks_footer":186,"\u002Fdocs\u002Fcredits-and-auth\u002Fauth_page":216,"\u002Fdocs\u002Fcredits-and-auth\u002Fauth_surround":379,"\u002Fdocs\u002Fcredits-and-auth\u002Fauth":382},{"id":4,"extension":5,"links":6,"meta":121,"stem":122,"__hash__":123},"navigationMenu\u002Fnavigation.json","json",[7,57,62,103],{"label":8,"icon":9,"nested":10,"children":11},"API Products","i-lucide-box",true,[12,17,22,27,32,37,42,47,52],{"label":13,"to":14,"description":15,"icon":16},"Full IP Lookup","\u002Ffull-ip-lookup","Enrich any IP with complete intelligence","i-lucide-globe",{"label":18,"to":19,"description":20,"icon":21},"Proxy & VPN Detection","\u002Fproxy-vpn-detection","Identify proxies and VPN networks","i-lucide-shield-alert",{"label":23,"to":24,"description":25,"icon":26},"Tor Exit Nodes","\u002Ftor-exit-nodes","Block Tor anonymity network traffic","i-lucide-eye-off",{"label":28,"to":29,"description":30,"icon":31},"Granular Geolocation","\u002Fgranular-geolocation","Highly accurate location mapping","i-lucide-map-pin",{"label":33,"to":34,"description":35,"icon":36},"Threat Scoring System","\u002Fthreat-scoring-system","Unified traffic risk score","i-lucide-activity",{"label":38,"to":39,"description":40,"icon":41},"ASN & Carrier Data","\u002Fasn-carrier-data","Identify autonomous systems","i-lucide-server",{"label":43,"to":44,"description":45,"icon":46},"Disposable Email Check","\u002Fdisposable-email-check","Detect temporary email domains","i-lucide-mail",{"label":48,"to":49,"description":50,"icon":51},"User Agent Parser","\u002Fuser-agent-bot-parser","Parse messy HTTP headers","i-lucide-bot",{"label":53,"to":54,"description":55,"icon":56},"Verified Bots","\u002Fverified-bots-crawlers","Identify legitimate search engine crawlers","i-lucide-check-circle",{"label":58,"to":59,"icon":60,"nested":61},"Pricing","\u002Fpricing","i-lucide-credit-card",false,{"label":63,"to":64,"icon":65,"nested":10,"children":66},"Docs","\u002Fdocs","i-lucide-book-open",[67,71,76,81,86,91,95,98],{"label":68,"to":64,"description":69,"icon":70},"Getting Started","Learn how to setup and use IP Shield","i-lucide-rocket",{"label":72,"to":73,"description":74,"icon":75},"All Endpoints","\u002Fdocs\u002Fendpoints\u002Femail-domain-check","Reference for all IP Shield REST API endpoints","i-lucide-plug",{"label":77,"to":78,"description":79,"icon":80},"Network API","\u002Fdocs\u002Fendpoints\u002Fnetwork","Network intelligence and routing data","i-lucide-network",{"label":82,"to":83,"description":84,"icon":85},"Summary API","\u002Fdocs\u002Fendpoints\u002Fsummary","Full IP intelligence summary","i-lucide-bar-chart-2",{"label":87,"to":88,"description":89,"icon":90},"Lookup IP API","\u002Fdocs\u002Fendpoints\u002Flookup-ip","Single IP data lookup","i-lucide-search",{"label":92,"to":93,"description":94,"icon":31},"Geo Check API","\u002Fdocs\u002Fendpoints\u002Fgeo-check","Check geographic location",{"label":96,"to":73,"description":97,"icon":46},"Email Domain Check API","Verify disposable email domains",{"label":99,"to":100,"description":101,"icon":102},"User Agent Check API","\u002Fdocs\u002Fendpoints\u002Fuser-agent-check","Detect malicious user agents","i-lucide-monitor",{"label":104,"icon":105,"nested":10,"children":106},"Resources","i-lucide-library",[107,112,117],{"label":108,"to":109,"icon":110,"description":111},"About Us","\u002Fabout","i-lucide-info","Learn more about IP Shield and our mission",{"label":113,"to":114,"icon":115,"description":116},"Blog","\u002Fblog","i-lucide-newspaper","Latest news, updates, and security articles",{"label":118,"to":119,"description":120,"icon":46},"Contact Us","\u002Fcontact","Get in touch with our support team",{},"navigation","OH-Zj4UmYqVQJC8Ts6f4KeKRzXJYi5trdK22JpX9Y0Q",[125],{"title":63,"path":64,"stem":126,"children":127,"page":-1},"docs",[128,131,152],{"title":129,"path":64,"stem":130,"icon":110},"Introduction","docs\u002Findex",{"title":132,"icon":133,"path":134,"stem":135,"children":136,"page":61},"Credit & Authorization","i-lucide-key","\u002Fdocs\u002Fcredits-and-auth","docs\u002Fcredits-and-auth",[137,142,147],{"title":138,"path":139,"stem":140,"icon":141},"Authentication","\u002Fdocs\u002Fcredits-and-auth\u002Fauth","docs\u002Fcredits-and-auth\u002Fauth","i-lucide-shield-check",{"title":143,"path":144,"stem":145,"icon":146},"Credits & Usage","\u002Fdocs\u002Fcredits-and-auth\u002Fcredits-usage","docs\u002Fcredits-and-auth\u002Fcredits-usage","i-lucide-coins",{"title":148,"path":149,"stem":150,"icon":151},"Rate Limits","\u002Fdocs\u002Fcredits-and-auth\u002Frate-limits","docs\u002Fcredits-and-auth\u002Frate-limits","i-lucide-gauge",{"title":153,"icon":75,"path":154,"stem":155,"children":156,"page":61},"API Endpoints","\u002Fdocs\u002Fendpoints","docs\u002Fendpoints",[157,159,161,163,165,167],{"title":96,"path":73,"stem":158,"icon":46},"docs\u002Fendpoints\u002Femail-domain-check",{"title":92,"path":93,"stem":160,"icon":31},"docs\u002Fendpoints\u002Fgeo-check",{"title":87,"path":88,"stem":162,"icon":90},"docs\u002Fendpoints\u002Flookup-ip",{"title":77,"path":78,"stem":164,"icon":80},"docs\u002Fendpoints\u002Fnetwork",{"title":82,"path":83,"stem":166,"icon":85},"docs\u002Fendpoints\u002Fsummary",{"title":99,"path":100,"stem":168,"icon":102},"docs\u002Fendpoints\u002Fuser-agent-check",[170],{"title":63,"path":64,"stem":126,"children":171},[172,173,178],{"title":129,"path":64,"stem":130},{"title":132,"path":134,"stem":135,"children":174,"page":61},[175,176,177],{"title":138,"path":139,"stem":140},{"title":143,"path":144,"stem":145},{"title":148,"path":149,"stem":150},{"title":153,"path":154,"stem":155,"children":179,"page":61},[180,181,182,183,184,185],{"title":96,"path":73,"stem":158},{"title":92,"path":93,"stem":160},{"title":87,"path":88,"stem":162},{"title":77,"path":78,"stem":164},{"title":82,"path":83,"stem":166},{"title":99,"path":100,"stem":168},{"id":4,"extension":5,"links":187,"meta":215,"stem":122,"__hash__":123},[188,199,200,210],{"label":8,"icon":9,"nested":10,"children":189},[190,191,192,193,194,195,196,197,198],{"label":13,"to":14,"description":15,"icon":16},{"label":18,"to":19,"description":20,"icon":21},{"label":23,"to":24,"description":25,"icon":26},{"label":28,"to":29,"description":30,"icon":31},{"label":33,"to":34,"description":35,"icon":36},{"label":38,"to":39,"description":40,"icon":41},{"label":43,"to":44,"description":45,"icon":46},{"label":48,"to":49,"description":50,"icon":51},{"label":53,"to":54,"description":55,"icon":56},{"label":58,"to":59,"icon":60,"nested":61},{"label":63,"to":64,"icon":65,"nested":10,"children":201},[202,203,204,205,206,207,208,209],{"label":68,"to":64,"description":69,"icon":70},{"label":72,"to":73,"description":74,"icon":75},{"label":77,"to":78,"description":79,"icon":80},{"label":82,"to":83,"description":84,"icon":85},{"label":87,"to":88,"description":89,"icon":90},{"label":92,"to":93,"description":94,"icon":31},{"label":96,"to":73,"description":97,"icon":46},{"label":99,"to":100,"description":101,"icon":102},{"label":104,"icon":105,"nested":10,"children":211},[212,213,214],{"label":108,"to":109,"icon":110,"description":111},{"label":113,"to":114,"icon":115,"description":116},{"label":118,"to":119,"description":120,"icon":46},{},{"id":217,"title":138,"body":218,"description":372,"extension":373,"icon":141,"meta":374,"module":375,"navigation":10,"path":139,"rawbody":376,"seo":377,"stem":140,"__hash__":378},"docs\u002Fdocs\u002Fcredits-and-auth\u002Fauth.md",{"type":219,"value":220,"toc":360},"minimark",[221,233,236,241,244,249,252,256,259,263,266,270,273,277,280,284,295,350,356],[222,223,224,225,232],"p",{},"The IP Shield API uses API keys to authenticate requests. You can view and manage your API keys in the ",[226,227,231],"a",{"external":228,"href":229,"target":230},"true","\u002Faccount","_self","Dashboard",".",[234,235],"hr",{},[237,238,240],"h2",{"id":239},"creating-an-api-key","Creating an API Key",[222,242,243],{},"When you first log in to your dashboard, you will be prompted to generate your first API key. During creation, you can configure additional security options to strictly control how and when your key can be used.",[245,246,248],"h3",{"id":247},"setting-an-expiry-date","Setting an Expiry Date",[222,250,251],{},"To ensure keys are rotated securely, you can set a specific expiration date for your API key. Once the date passes, the key will automatically become invalid and API requests using it will be rejected. You can omit this option if you prefer the key to remain valid indefinitely.",[245,253,255],{"id":254},"restricting-allowed-hosts","Restricting Allowed Hosts",[222,257,258],{},"For maximum security, you can restrict API access to specific IP addresses. When configured, IP Shield will explicitly reject any API requests originating from unauthorized servers, even if the API key is valid. If left blank, the API key can be used from any network.",[237,260,262],{"id":261},"managing-api-keys","Managing API Keys",[222,264,265],{},"From your dashboard, you can create, rotate, and revoke API keys at any time to maintain strict access control over your account.",[245,267,269],{"id":268},"rotating-a-key","Rotating a Key",[222,271,272],{},"If you suspect a key has been compromised or simply want to enforce routine key rotation, you can rotate your API key. Rotating generates a brand-new secret key while preserving all of your existing configuration settings—such as host restrictions and expiry dates.",[245,274,276],{"id":275},"revoking-a-key","Revoking a Key",[222,278,279],{},"Revoking an API key immediately and permanently invalidates it. Any systems or applications attempting to authenticate with a revoked key will instantly be denied access.",[237,281,283],{"id":282},"using-your-api-key","Using Your API Key",[222,285,286,287,291,292,294],{},"Authentication to the API is performed via the ",[288,289,290],"code",{},"x-api-key"," header. When making a request, you must include your API key using the ",[288,293,290],{}," HTTP header.",[296,297,303],"pre",{"className":298,"code":299,"filename":300,"language":301,"meta":302,"style":302},"language-bash shiki shiki-themes light-plus light-plus dracula","curl -X GET \"https:\u002F\u002Fip-shield.riavzon.com\u002Fapi\u002Fv1\u002Fnetwork\u002F8.8.8.8\" \\\n  -H \"x-api-key: YOUR_API_KEY\"\n","Terminal","bash","",[288,304,305,336],{"__ignoreMap":302},[306,307,310,314,318,322,326,329,332],"span",{"class":308,"line":309},"line",1,[306,311,313],{"class":312},"sHOzp","curl",[306,315,317],{"class":316},"sjR7W"," -X",[306,319,321],{"class":320},"sFB1V"," GET",[306,323,325],{"class":324},"sFkSl"," \"",[306,327,328],{"class":320},"https:\u002F\u002Fip-shield.riavzon.com\u002Fapi\u002Fv1\u002Fnetwork\u002F8.8.8.8",[306,330,331],{"class":324},"\"",[306,333,335],{"class":334},"st6lo"," \\\n",[306,337,339,342,344,347],{"class":308,"line":338},2,[306,340,341],{"class":316},"  -H",[306,343,325],{"class":324},[306,345,346],{"class":320},"x-api-key: YOUR_API_KEY",[306,348,349],{"class":324},"\"\n",[351,352,353],"warning",{},[222,354,355],{},"Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, or public forums.",[357,358,359],"style",{},"html pre.shiki code .sHOzp, html code.shiki .sHOzp{--shiki-light:#795E26;--shiki-default:#795E26;--shiki-dark:#50FA7B}html pre.shiki code .sjR7W, html code.shiki .sjR7W{--shiki-light:#0000FF;--shiki-default:#0000FF;--shiki-dark:#BD93F9}html pre.shiki code .sFB1V, html code.shiki .sFB1V{--shiki-light:#A31515;--shiki-default:#A31515;--shiki-dark:#F1FA8C}html pre.shiki code .sFkSl, html code.shiki .sFkSl{--shiki-light:#A31515;--shiki-default:#A31515;--shiki-dark:#E9F284}html pre.shiki code .st6lo, html code.shiki .st6lo{--shiki-light:#EE0000;--shiki-default:#EE0000;--shiki-dark:#FF79C6}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}",{"title":302,"searchDepth":338,"depth":338,"links":361},[362,367,371],{"id":239,"depth":338,"text":240,"children":363},[364,366],{"id":247,"depth":365,"text":248},3,{"id":254,"depth":365,"text":255},{"id":261,"depth":338,"text":262,"children":368},[369,370],{"id":268,"depth":365,"text":269},{"id":275,"depth":365,"text":276},{"id":282,"depth":338,"text":283},"Learn how to authenticate your API requests using API keys.","md",{},null,"---\ntitle: Authentication\ndescription: Learn how to authenticate your API requests using API keys.\nicon: i-lucide-shield-check\n---\n\nThe IP Shield API uses API keys to authenticate requests. You can view and manage your API keys in the [Dashboard](\u002Faccount){target=\"_self\" external=\"true\"}.\n\n---\n\n\u003C!-- TODO: ADD Screenshots -->\n## Creating an API Key\n\nWhen you first log in to your dashboard, you will be prompted to generate your first API key. During creation, you can configure additional security options to strictly control how and when your key can be used.\n\n### Setting an Expiry Date\n\nTo ensure keys are rotated securely, you can set a specific expiration date for your API key. Once the date passes, the key will automatically become invalid and API requests using it will be rejected. You can omit this option if you prefer the key to remain valid indefinitely.\n\n### Restricting Allowed Hosts\n\nFor maximum security, you can restrict API access to specific IP addresses. When configured, IP Shield will explicitly reject any API requests originating from unauthorized servers, even if the API key is valid. If left blank, the API key can be used from any network.\n\n## Managing API Keys\n\nFrom your dashboard, you can create, rotate, and revoke API keys at any time to maintain strict access control over your account.\n\n### Rotating a Key\nIf you suspect a key has been compromised or simply want to enforce routine key rotation, you can rotate your API key. Rotating generates a brand-new secret key while preserving all of your existing configuration settings—such as host restrictions and expiry dates. \n\n### Revoking a Key\nRevoking an API key immediately and permanently invalidates it. Any systems or applications attempting to authenticate with a revoked key will instantly be denied access.\n\n## Using Your API Key\n\nAuthentication to the API is performed via the `x-api-key` header. When making a request, you must include your API key using the `x-api-key` HTTP header.\n\n```bash [Terminal]\ncurl -X GET \"https:\u002F\u002Fip-shield.riavzon.com\u002Fapi\u002Fv1\u002Fnetwork\u002F8.8.8.8\" \\\n  -H \"x-api-key: YOUR_API_KEY\"\n```\n\n\n::warning\nDo not share your secret API keys in publicly accessible areas such as GitHub, client-side code, or public forums.\n::",{"title":138,"description":372},"iVM3jQiHPHgETKE7TTo-yQJNO_uR4ul5VieJuvVRCw4",[380,381],{"title":129,"path":64,"stem":130,"children":-1},{"title":143,"path":144,"stem":145,"children":-1},{"id":217,"title":138,"body":383,"description":372,"extension":373,"icon":141,"meta":470,"module":375,"navigation":10,"path":139,"rawbody":376,"seo":471,"stem":140,"__hash__":378},{"type":219,"value":384,"toc":459},[385,389,391,393,395,397,399,401,403,405,407,409,411,413,415,417,423,453,457],[222,386,224,387,232],{},[226,388,231],{"external":228,"href":229,"target":230},[234,390],{},[237,392,240],{"id":239},[222,394,243],{},[245,396,248],{"id":247},[222,398,251],{},[245,400,255],{"id":254},[222,402,258],{},[237,404,262],{"id":261},[222,406,265],{},[245,408,269],{"id":268},[222,410,272],{},[245,412,276],{"id":275},[222,414,279],{},[237,416,283],{"id":282},[222,418,286,419,291,421,294],{},[288,420,290],{},[288,422,290],{},[296,424,425],{"className":298,"code":299,"filename":300,"language":301,"meta":302,"style":302},[288,426,427,443],{"__ignoreMap":302},[306,428,429,431,433,435,437,439,441],{"class":308,"line":309},[306,430,313],{"class":312},[306,432,317],{"class":316},[306,434,321],{"class":320},[306,436,325],{"class":324},[306,438,328],{"class":320},[306,440,331],{"class":324},[306,442,335],{"class":334},[306,444,445,447,449,451],{"class":308,"line":338},[306,446,341],{"class":316},[306,448,325],{"class":324},[306,450,346],{"class":320},[306,452,349],{"class":324},[351,454,455],{},[222,456,355],{},[357,458,359],{},{"title":302,"searchDepth":338,"depth":338,"links":460},[461,465,469],{"id":239,"depth":338,"text":240,"children":462},[463,464],{"id":247,"depth":365,"text":248},{"id":254,"depth":365,"text":255},{"id":261,"depth":338,"text":262,"children":466},[467,468],{"id":268,"depth":365,"text":269},{"id":275,"depth":365,"text":276},{"id":282,"depth":338,"text":283},{},{"title":138,"description":372},1782044521689]