You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Aug 7, 2025. It is now read-only.
<metaname=descriptioncontent="Configure your API key to start LocalStack
3
-
"><metaproperty="og:url" content="/references/api-key/"><metaproperty="og:site_name" content="Docs"><metaproperty="og:title" content="API Key (Deprecated)"><metaproperty="og:description" content="Configure your API key to start LocalStack"><metaproperty="og:locale" content="en"><metaproperty="og:type" content="article"><metaproperty="article:section" content="references"><metaproperty="article:modified_time" content="2024-11-21T20:52:05+05:30"><metaitemprop=namecontent="API Key (Deprecated)"><metaitemprop=descriptioncontent="Configure your API key to start LocalStack
4
-
"><metaitemprop=dateModifiedcontent="2024-11-21T20:52:05+05:30"><metaitemprop=wordCountcontent="856"><metaname=twitter:cardcontent="summary"><metaname=twitter:titlecontent="API Key (Deprecated)"><metaname=twitter:descriptioncontent="Configure your API key to start LocalStack
3
+
"><metaproperty="og:url" content="/references/api-key/"><metaproperty="og:site_name" content="Docs"><metaproperty="og:title" content="API Key (Deprecated)"><metaproperty="og:description" content="Configure your API key to start LocalStack"><metaproperty="og:locale" content="en"><metaproperty="og:type" content="article"><metaproperty="article:section" content="references"><metaproperty="article:modified_time" content="2025-05-08T18:19:54+02:00"><metaitemprop=namecontent="API Key (Deprecated)"><metaitemprop=descriptioncontent="Configure your API key to start LocalStack
4
+
"><metaitemprop=dateModifiedcontent="2025-05-08T18:19:54+02:00"><metaitemprop=wordCountcontent="857"><metaname=twitter:cardcontent="summary"><metaname=twitter:titlecontent="API Key (Deprecated)"><metaname=twitter:descriptioncontent="Configure your API key to start LocalStack
5
5
"><linkrel=preloadhref=/scss/main.min.b8c1ba167031424cea8c41b1328156b67591cff764990abe8c62609266efeed4.cssas=style><linkhref=/scss/main.min.b8c1ba167031424cea8c41b1328156b67591cff764990abe8c62609266efeed4.cssrel=stylesheetintegrity><scriptsrc=https://code.jquery.com/jquery-3.7.1.min.jsintegrity="sha512-v2CJ7UaYy4JwqLDIrZUI/4hqeoQieOmAZNXBeQyjo21dadnwR+8ZaIJVT8EE2iyI61OV8e6M8PP2/4hpQINQ/g==" crossorigin=anonymous></script><linkrel=stylesheethref=https://cdn.jsdelivr.net/npm/@docsearch/css@3.6.0integrity="sha512-AyDFDkYyALC5qoao077IqAOV7UC4oKCBTp+mJfjIt306AIRoBxoEZYDo0kAx/R7RbT+3EYEky1po/F1w1eQt7g==" crossorigin=anonymous><linkrel=stylesheethref=https://cdn.jsdelivr.net/npm/@docsearch/css@3><scripttype=text/javascriptid=hs-script-loaderasyncdefersrc=//js-eu1.hs-scripts.com/26596507.js></script><scriptasyncsrc=https://widget.kapa.ai/kapa-widget.bundle.jsdata-website-id=3dfbd0ac-9e56-4664-8315-032e17917ab6data-project-name=LocalStackdata-project-color=#281763data-project-logo="https://avatars.githubusercontent.com/u/28732122?s=280&v=4" data-user-analytics-fingerprint-enabled=truedata-modal-disclaimer="This is a custom LocalStack LLM to help you find the information you need by searching across all LocalStack documentation. Give it a try and let us know what you think!"></script><script>!function(e,t){varn,s,o,i;t.__SV||(window.posthog=t,t._i=[],t.init=function(a,r,c){functiond(e,t){varn=t.split(".");2==n.length&&(e=e[n[0]],t=n[1]),e[t]=function(){e.push([t].concat(Array.prototype.slice.call(arguments,0)))}}(n=e.createElement("script")).type="text/javascript",n.crossOrigin="anonymous",n.async=!0,n.src=r.api_host.replace(".i.posthog.com","-assets.i.posthog.com")+"/static/array.js",(i=e.getElementsByTagName("script")[0]).parentNode.insertBefore(n,i);varl=t;for(void0!==c?l=t[c]=[]:c="posthog",l.people=l.people||[],l.toString=function(e){vart="posthog";return"posthog"!==c&&(t+="."+c),e||(t+=" (stub)"),t},l.people.toString=function(){returnl.toString(1)+".people (stub)"},o="init capture register register_once register_for_session unregister unregister_for_session getFeatureFlag getFeatureFlagPayload isFeatureEnabled reloadFeatureFlags updateEarlyAccessFeatureEnrollment getEarlyAccessFeatures on onFeatureFlags onSessionId getSurveys getActiveMatchingSurveys renderSurvey canRenderSurvey identify setPersonProperties group resetGroups setPersonPropertiesForFlags resetPersonPropertiesForFlags setGroupPropertiesForFlags resetGroupPropertiesForFlags reset get_distinct_id getGroups get_session_id get_session_replay_url alias set_config startSessionRecording stopSessionRecording sessionRecordingStarted captureException loadToolbar get_property getSessionProperty createPersonProfile opt_in_capturing opt_out_capturing has_opted_in_capturing has_opted_out_capturing clear_opt_in_out_capturing debug getPageViewId captureTraceFeedback captureTraceMetric".split(" "),s=0;s<o.length;s++)d(l,o[s]);t._i.push([a,r,c])},t.__SV=1)}(document,window.posthog||[]),posthog.init("phc_6bea9iRqN9iwiwf5aM3dVXrKmAQGGMahouBRMIyQfnE",{api_host:"https://us.i.posthog.com",person_profiles:"always"})</script><scriptasyncsrc="https://www.googletagmanager.com/gtag/js?id=UA-101988473-1"></script><script>vardoNotTrack=!1;if(!doNotTrack){window.dataLayer=window.dataLayer||[];functiongtag(){dataLayer.push(arguments)}gtag("js",newDate),gtag("config","UA-101988473-1")}</script></head><bodyclass=td-page><header><navclass="js-navbar-scroll navbar navbar-expand flex-column flex-md-row td-navbar"><divclass=navbar-brand><aclass=brand-linkhref=/><spanclass=navbar-logo><imgsrc=/images/logo.svgheight=40px>
If the key activation fails, LocalStack will quit with an error messages that may look something like this:</p><divclass=highlight><pretabindex=0style=background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4><codeclass=language-bashdata-lang=bash><spanstyle=display:flex><span><spanstyle=color:#ce5c00;font-weight:700>===============================================</span>
</span></span><spanstyle=display:flex><span>The API key you provided in the <spanstyle=color:#4e9a06>`</span>LOCALSTACK_API_KEY<spanstyle=color:#4e9a06>`</span> environment variable <spanstyle=color:#4e9a06>'"foo..."(6)'</span> could not beactivated against our licensing server. Server message: Unable to verify API key.
375
+
</span></span><spanstyle=display:flex><span>The API key you provided in the <spanstyle=color:#4e9a06>`</span>LOCALSTACK_API_KEY<spanstyle=color:#4e9a06>`</span> environment variable <spanstyle=color:#4e9a06>'"foo..."(6)'</span> could not be activated against our licensing server. Server message: Unable to verify API key.
376
376
</span></span><spanstyle=display:flex><span>
377
377
</span></span><spanstyle=display:flex><span>Due to this error, Localstack has quit. LocalStack pro features can only be used with a valid license.
378
378
</span></span><spanstyle=display:flex><span>
379
379
</span></span><spanstyle=display:flex><span>- Please check that your API key is <spanstyle=color:#204a87>set</span> up correctly and that you are using the correct key.
380
380
</span></span><spanstyle=display:flex><span> You can find your API key in our webapp at https://app.localstack.cloud.
381
381
</span></span><spanstyle=display:flex><span>- If you want to <spanstyle=color:#204a87;font-weight:700>continue</span> using LocalStack without pro features you can <spanstyle=color:#204a87>set</span><spanstyle=color:#4e9a06>`</span><spanstyle=color:#000>ACTIVATE_PRO</span><spanstyle=color:#ce5c00;font-weight:700>=</span>0<spanstyle=color:#4e9a06>`</span>.
382
382
</span></span></code></pre></div><p>There are several reasons a key activation can fail:</p><ul><li>Missing credentials: Using <code>localstack/localstack-pro</code> requires per default to have an API key set.</li><li>Invalid key: there is no valid license associated with the key, for example because the license has expired.</li><li>License server cannot be reached: LocalStack will try to perform an offline license activation if the license server cannot be reached, but will require a re-activation every 24 hours.</li></ul><p>If you are using the <code>localstack/localstack-pro</code> image, but cannot activate your license key, we recommend falling back to the community image <code>localstack/localstack</code>.
0 commit comments