-
Notifications
You must be signed in to change notification settings - Fork 70
/
Copy pathapi-key.html
567 lines (546 loc) · 29.6 KB
/
api-key.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="UTF-8">
<title>API keys | APM Server Reference [7.11] | Elastic</title>
<meta class="elastic" name="content" content="API keys | APM Server Reference [7.11]">
<link rel="home" href="index.html" title="APM Server Reference [7.11]"/>
<link rel="up" href="secure-communication-agents.html" title="Secure communication with APM Agents"/>
<link rel="prev" href="ssl-setup.html" title="SSL/TLS communication"/>
<link rel="next" href="api-key-settings.html" title="api_key.* configuration options"/>
<meta class="elastic" name="product_version" content="7.11"/>
<meta class="elastic" name="product_name" content="APM"/>
<meta class="elastic" name="website_area" content="documentation"/>
<meta name="DC.type" content="Learn/Docs/APM Server/Reference/7.11"/>
<meta name="DC.subject" content="APM"/>
<meta name="DC.identifier" content="7.11"/>
<meta name="robots" content="noindex,nofollow"/>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<script src="https://cdn.optimizely.com/js/18132920325.js"></script>
<link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png">
<link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png">
<link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png">
<link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png">
<link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png">
<link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png">
<link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png">
<link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png">
<link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png">
<link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32">
<link rel="icon" type="image/png" href="/android-chrome-192x192.png" sizes="192x192">
<link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96">
<link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16">
<link rel="manifest" href="/manifest.json">
<meta name="apple-mobile-web-app-title" content="Elastic">
<meta name="application-name" content="Elastic">
<meta name="msapplication-TileColor" content="#ffffff">
<meta name="msapplication-TileImage" content="/mstile-144x144.png">
<meta name="theme-color" content="#ffffff">
<meta name="naver-site-verification" content="936882c1853b701b3cef3721758d80535413dbfd" />
<meta name="yandex-verification" content="d8a47e95d0972434" />
<meta name="localized" content="true" />
<meta name="st:robots" content="follow,index" />
<meta property="og:image" content="https://static-www.elastic.co/v3/assets/bltefdd0b53724fa2ce/blt280217a63b82a734/6202d3378b1f312528798412/elastic-logo.svg" />
<meta property="og:image:width" content="500" />
<meta property="og:image:height" content="172" />
<link rel="shortcut icon" href="/favicon.ico" type="image/x-icon">
<link rel="icon" href="/favicon.ico" type="image/x-icon">
<link rel="apple-touch-icon-precomposed" sizes="64x64" href="/favicon_64x64_16bit.png">
<link rel="apple-touch-icon-precomposed" sizes="32x32" href="/favicon_32x32.png">
<link rel="apple-touch-icon-precomposed" sizes="16x16" href="/favicon_16x16.png">
<!-- Give IE8 a fighting chance -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
<link rel="stylesheet" type="text/css" href="/guide/static/styles-v1.css" />
</head>
<!--© 2015-2025 Elasticsearch B.V. -->
<!-- All Elastic documentation is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License. -->
<!-- http://creativecommons.org/licenses/by-nc-nd/4.0/ -->
<body>
<!-- Google Tag Manager -->
<script>dataLayer = [];</script><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-58RLH5" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-58RLH5');</script>
<!-- End Google Tag Manager -->
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-12395217-16"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-12395217-16');
</script>
<!-- Google Tag Manager for GA4 -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src='https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-KNJMG2M');</script>
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KNJMG2M" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<!-- End Google Tag Manager for GA4-->
<div id='elastic-nav' style="display:none;"></div>
<script src='https://www.elastic.co/elastic-nav.js'></script>
<div class="main-container">
<section id="content" >
<div class="content-wrapper">
<section id="guide" lang="en">
<div class="container-fluid">
<div class="row pb-3">
<div class="col-12 order-2 col-md-4 order-md-1 col-lg-3 h-almost-full-md sticky-top-md" id="left_col">
<!-- The TOC is appended here -->
</div>
<div class="col-12 order-1 col-md-8 order-md-2 col-lg-7 order-lg-2 guide-section" id="middle_col">
<!-- start body -->
<div class="page_header">
A newer version is available. For the latest information, see the
<a href="../current/index.html">current release documentation</a>.
</div>
<div class="navheader">
<span class="prev">
<a href="ssl-setup.html">« SSL/TLS communication</a>
</span>
<span class="next">
<a href="api-key-settings.html"><code class="literal">api_key.*</code> configuration options »</a>
</span>
</div>
<div class="book" lang="en">
<div class="titlepage">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="/guide/">Elastic Docs</a></span>
<span class="chevron-right">›</span><span class="breadcrumb-link">
<div id="related-products" class="dropdown">
<div class="related-products-title">APM:</div>
<div class="dropdown-anchor" tabindex="0">Server Reference<span class="dropdown-icon"></span></div>
<div class="dropdown-content">
<ul>
<li class="dropdown-category">APM</li>
<ul>
<li><a href="/guide/en/observability/current/apm.html">Observability › APM</a></li>
</ul>
<li class="dropdown-category">APM agents</li>
<ul>
<li><a href="/guide/en/apm/agent/android/current/intro.html">Android Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/go/current/introduction.html">Go Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/swift/current/intro.html">iOS Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/java/current/intro.html">Java Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/dotnet/current/intro.html">.NET Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/nodejs/current/intro.html">Node.js Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/php/current/intro.html">PHP Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/python/current/getting-started.html">Python Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/ruby/current/introduction.html">Ruby Agent Reference</a></li>
<li><a href="/guide/en/apm/agent/rum-js/current/intro.html">Real User Monitoring JavaScript Agent Reference</a></li>
</ul>
<li class="dropdown-category">APM extensions</li>
<ul>
<li><a href="/guide/en/apm/lambda/current/aws-lambda-arch.html">AWS Lambda extension</a></li>
<li><a href="/guide/en/apm/attacher/current/apm-attacher.html">Attacher</a></li>
</ul>
</ul>
</div>
</div>
<span class="chevron-right">›</span><span class="breadcrumb-link"><a href="securing-apm-server.html">Secure APM Server</a></span>
<span class="chevron-right">›</span><span class="breadcrumb-link"><a href="secure-communication-agents.html">Secure communication with APM Agents</a></span>
</div>
<div>
<div><h1 class="title"><a id="id-1"></a>API keys</h1><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.11/docs/secure-communication-agents.asciidoc">edit</a></div>
</div>
<!--EXTRA-->
</div>
<div id="content">
<div id="url-to-v3" class="version-warning">
<strong>IMPORTANT</strong>: This documentation is no longer updated. Refer to <a href="https://www.elastic.co/support/eol">Elastic's version policy</a> and the <a href="https://www.elastic.co/docs">latest documentation</a>.
</div>
<div class="section">
<div class="titlepage"><div><div>
<div class="position-relative"><h2 class="title"><a id="api-key"></a>API keys</h2><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.11/docs/secure-communication-agents.asciidoc">edit</a></div>
</div></div></div>
<div class="warning admon">
<div class="icon"></div>
<div class="admon_content">
<p>This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.</p>
</div>
</div>
<p>You can configure API keys to authorize requests to the APM Server.</p>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>API keys are sent as plain-text,
so they only provide security when used in combination with <a class="xref" href="ssl-setup.html" title="SSL/TLS communication">SSL/TLS</a>.</p>
</div>
</div>
<p>By enabling <code class="literal">apm-server.api_key.enabled: true</code>, you ensure that only agents with a valid API Key
are able to successfully use APM Server’s API (except for RUM endpoints).</p>
<p>To secure the communication between APM Agents and the APM Server with API keys:</p>
<div class="olist orderedlist">
<ol class="orderedlist">
<li class="listitem">
Make sure <a class="xref" href="ssl-setup.html" title="SSL/TLS communication">SSL/TLS</a> is enabled
</li>
<li class="listitem">
<a class="xref" href="api-key.html#configure-api-key" title="Enable and configure API keys">Enable and configure API keys</a>
</li>
<li class="listitem">
<a class="xref" href="api-key.html#create-api-key" title="Create and validate an API key">Create an API key with APM Server</a>
</li>
<li class="listitem">
<a class="xref" href="api-key.html#set-api-key" title="Set the API key in your APM Agents">Set the API key in your APM Agents</a>
</li>
</ol>
</div>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>API Keys are not applicable for the RUM Agent,
as there is no way to prevent them from being publicly exposed.</p>
</div>
</div>
<div class="position-relative"><h3><a id="configure-api-key"></a>Enable and configure API keys</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.11/docs/secure-communication-agents.asciidoc">edit</a></div>
<p>API keys are disabled by default. You can change this, and additional settings,
in the <code class="literal">apm-server.api_key</code> section of the <code class="literal">apm-server.yml</code> configuration file.</p>
<p>At a minimum, you must enable API keys,
and should set a limit on the number of unique API keys that APM Server allows per minute.
Here’s an example <code class="literal">apm-server.api_key</code> config using 50 unique API keys:</p>
<div class="pre_wrapper lang-yaml">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-yaml">apm-server.api_key.enabled: true <a id="CO18-1"></a><i class="conum" data-value="1"></i>
apm-server.api_key.limit: 50 <a id="CO18-2"></a><i class="conum" data-value="2"></i></pre>
</div>
<div class="calloutlist">
<table border="0" summary="Callout list">
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO18-1"><i class="conum" data-value="1"></i></a></p>
</td>
<td align="left" valign="top">
<p>Enables API keys</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO18-2"><i class="conum" data-value="2"></i></a></p>
</td>
<td align="left" valign="top">
<p>Restricts the number of unique API keys that Elasticsearch allows each minute.
This value should be the number of unique API keys configured in your monitored services.</p>
</td>
</tr>
</table>
</div>
<p>All other configuration options are described in <a class="xref" href="api-key-settings.html" title="api_key.* configuration options"><code class="literal">api_key.*</code> configuration options</a>.</p>
<div class="position-relative"><h3><a id="create-api-key"></a>Create and validate an API key</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.11/docs/secure-communication-agents.asciidoc">edit</a></div>
<p>APM Server provides a command line interface for creating, retrieving, invalidating, and verifying API keys.
Keys created using this method can only be used for Agent/Server communication.</p>
<div class="position-relative"><h4><a id="create-api-key-subcommands"></a><code class="literal">apikey</code> subcommands</h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.11/docs/secure-communication-agents.asciidoc">edit</a></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">create</code></strong></span>
</span>
</dt>
<dd>
<p>
Create an API Key with the specified privilege(s). No required flags.
</p>
<p>The user requesting to create an API Key needs to have APM privileges used by the APM Server.
A superuser, by default, has these privileges. For other users,
you can create them. See <a class="xref" href="privileges-api-key.html" title="Grant privileges and roles needed for API key management">create an API key user</a> for required privileges.</p>
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">info</code></strong></span>
</span>
</dt>
<dd>
Query API Key(s). <code class="literal">--id</code> or <code class="literal">--name</code> required.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">invalidate</code></strong></span>
</span>
</dt>
<dd>
Invalidate API Key(s). <code class="literal">--id</code> or <code class="literal">--name</code> required.
</dd>
<dt>
<span class="term">
<span class="strong strong"><strong><code class="literal">verify</code></strong></span>
</span>
</dt>
<dd>
Check if a credentials string has the given privilege(s).
<code class="literal">--credentials</code> required.
</dd>
</dl>
</div>
<div class="position-relative"><h4><a id="create-api-key-privileges"></a>Privileges</h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.11/docs/secure-communication-agents.asciidoc">edit</a></div>
<p>There are three unique privileges you can assign to each API keys.
If privileges are not specified at creation time, the created key will have all privileges.</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
<span class="strong strong"><strong>Agent configuration</strong></span>: Required for agents to read
<a href="/guide/en/kibana/7.11/agent-configuration.html" class="ulink" target="_top">Agent configuration remotely</a>.
<code class="literal">--agent-config</code> gives the <code class="literal">config_agent:read</code> privilege to the created key.
</li>
<li class="listitem">
<span class="strong strong"><strong>Ingest</strong></span>: Required for ingesting Agent events.
<code class="literal">--ingest</code> gives the <code class="literal">event:write</code> privilege to the created key.
</li>
<li class="listitem">
<span class="strong strong"><strong>Sourcemap</strong></span>: Required for <a class="xref" href="sourcemaps.html" title="How to apply source maps to error stack traces when using minified bundles">uploading sourcemaps</a>.
<code class="literal">--sourcemap</code> gives the <code class="literal">sourcemap:write</code> privilege to the created key.
</li>
</ul>
</div>
<div class="position-relative"><h4><a id="create-api-key-workflow"></a>API key workflow example</h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.11/docs/secure-communication-agents.asciidoc">edit</a></div>
<p>Create an API key with the <code class="literal">create</code> subcommand.</p>
<p>The following example creates an API key with a <code class="literal">name</code> of <code class="literal">java-001</code>,
and gives the "agent configuration" and "ingest" privileges.</p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server apikey create --ingest --agent-config --name java-001</pre>
</div>
<p>The response will look similar to this:</p>
<div class="pre_wrapper lang-console-result">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-console-result">Name ........... java-001
Expiration ..... never
Id ............. qT4tz28B1g59zC3uAXfW
API Key ........ rH55zKd5QT6wvs3UbbkxOA (won't be shown again)
Credentials .... cVQ0dHoyOEIxZzU5ekMzdUFYZlc6ckg1NXpLZDVRVDZ3dnMzVWJia3hPQQ== (won't be shown again)</pre>
</div>
<p>You should always verify the privileges of an API key after creating it.
Verification can be done using the <code class="literal">verify</code> subcommand.</p>
<p>The following example verifies that the <code class="literal">java-001</code> API key has the "agent configuration" and "ingest" privileges.</p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server apikey verify --agent-config --ingest --credentials cVQ0dHoyOEIxZzU5ekMzdUFYZlc6ckg1NXpLZDVRVDZ3dnMzVWJia3hPQQ==</pre>
</div>
<p>If the API key has the requested privileges, the response will look similar to this:</p>
<div class="pre_wrapper lang-console-result">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-console-result">Authorized for privilege "event:write"...: Yes
Authorized for privilege "config_agent:read"...: Yes</pre>
</div>
<p>To invalidate an API key, use the <code class="literal">invalidate</code> subcommand.
Due to Elasticsearch caching, there may be a delay between when this subcommand is executed and when it takes effect.</p>
<p>The following example invalidates the <code class="literal">java-001</code> API key.</p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server apikey invalidate --name java-001</pre>
</div>
<p>The response will look similar to this:</p>
<div class="pre_wrapper lang-console-result">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-console-result">Invalidated keys ... qT4tz28B1g59zC3uAXfW
Error count ........ 0</pre>
</div>
<p>A full list of <code class="literal">apikey</code> subcommands and flags is available in the <a class="xref" href="command-line-options.html#apikey-command" title="apikey command">API key command reference</a>.</p>
<div class="position-relative"><h4><a id="create-api-key-workflow-es"></a>Alternate API key workflow example</h4><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.11/docs/secure-communication-agents.asciidoc">edit</a></div>
<p>Instead of using the APM Server CLI, it is possible to create API keys using the Elasticsearch
<a href="/guide/en/elasticsearch/reference/7.11/security-api-create-api-key.html" class="ulink" target="_top">create API key API</a>.</p>
<p>This example creates an API key named <code class="literal">java-002</code>:</p>
<div class="pre_wrapper lang-kibana">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-kibana">POST /_security/api_key
{
"name": "java-002", <a id="CO19-1"></a><i class="conum" data-value="1"></i>
"expiration": "1d", <a id="CO19-2"></a><i class="conum" data-value="2"></i>
"role_descriptors": {
"apm": {
"applications": [
{
"application": "apm",
"privileges": ["sourcemap:write", "event:write", "config_agent:read"], <a id="CO19-3"></a><i class="conum" data-value="3"></i>
"resources": ["*"]
}
]
}
}
}</pre>
</div>
<div class="kibana_widget" data-snippet="snippets/8.kibana"></div>
<div class="calloutlist">
<table border="0" summary="Callout list">
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO19-1"><i class="conum" data-value="1"></i></a></p>
</td>
<td align="left" valign="top">
<p>The name of the API key</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO19-2"><i class="conum" data-value="2"></i></a></p>
</td>
<td align="left" valign="top">
<p>The expiration time of the API key</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO19-3"><i class="conum" data-value="3"></i></a></p>
</td>
<td align="left" valign="top">
<p>Any assigned privileges</p>
</td>
</tr>
</table>
</div>
<p>The response will look similar to this:</p>
<div class="pre_wrapper lang-console-result">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-console-result">{
"id" : "GnrUT3QB7yZbSNxKET6d",
"name" : "java-002",
"expiration" : 1599153532262,
"api_key" : "RhHKisTmQ1aPCHC_TPwOvw"
}</pre>
</div>
<p>The <code class="literal">credential</code> string, which is what agents use to communicate with APM Server,
is a base64 encoded representation of the API key’s <code class="literal">id:api_key</code>.
It can be created like this:</p>
<div class="pre_wrapper lang-console-result">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-console-result">echo -n GnrUT3QB7yZbSNxKET6d:RhHKisTmQ1aPCHC_TPwOvw | base64</pre>
</div>
<p>You can verify your API key has been base64-encoded correctly with the
<a href="/guide/en/elasticsearch/reference/7.11/security-api-authenticate.html" class="ulink" target="_top">Authenticate API</a>:</p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">curl -H "Authorization: ApiKey R0gzRWIzUUI3eVpiU054S3pYSy06bXQyQWl4TlZUeEcyUjd4cUZDS0NlUQ==" localhost:9200/_security/_authentication</pre>
</div>
<p>If the API key has been encoded correctly, you’ll see a response similar to the following:</p>
<div class="pre_wrapper lang-console-result">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-console-result">{
"username":"1325298603",
"roles":[],
"full_name":null,
"email":null,
"metadata":{
"saml_nameid_format":"urn:oasis:names:tc:SAML:2.0:nameid-format:transient",
"saml(http://saml.elastic-cloud.com/attributes/principal)":[
"1325298603"
],
"saml_roles":[
"superuser"
],
"saml_principal":[
"1325298603"
],
"saml_nameid":"_7b0ab93bbdbc21d825edf7dca9879bd8d44c0be2",
"saml(http://saml.elastic-cloud.com/attributes/roles)":[
"superuser"
]
},
"enabled":true,
"authentication_realm":{
"name":"_es_api_key",
"type":"_es_api_key"
},
"lookup_realm":{
"name":"_es_api_key",
"type":"_es_api_key"
}
}</pre>
</div>
<p>You can then use the APM Server CLI to verify that the API key has the requested privileges:</p>
<div class="pre_wrapper lang-sh">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-sh">apm-server apikey verify --credentials R25yVVQzUUI3eVpiU054S0VUNmQ6UmhIS2lzVG1RMWFQQ0hDX1RQd092dw==</pre>
</div>
<p>If the API key has the requested privileges, the response will look similar to this:</p>
<div class="pre_wrapper lang-console-result">
<div class="console_code_copy" title="Copy to clipboard"></div>
<pre class="programlisting prettyprint lang-console-result">Authorized for privilege "config_agent:read"...: Yes
Authorized for privilege "event:write"...: Yes
Authorized for privilege "sourcemap:write"...: Yes</pre>
</div>
<div class="position-relative"><h3><a id="set-api-key"></a>Set the API key in your APM Agents</h3><a class="edit_me" rel="nofollow" title="Edit this page on GitHub" href="https://github.com/elastic/apm-server/edit/7.11/docs/secure-communication-agents.asciidoc">edit</a></div>
<p>You can now apply your newly created API keys in the configuration of each of your APM Agents.
See the relevant Agent documentation for additional information:</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
<span class="strong strong"><strong>Go Agent</strong></span>: <a href="/guide/en/apm/agent/go/current/configuration.html#config-api-key" class="ulink" target="_top"><code class="literal">ELASTIC_APM_API_KEY</code></a>
</li>
<li class="listitem">
<span class="strong strong"><strong>.NET Agent</strong></span>: <a href="/guide/en/apm/agent/dotnet/current/config-reporter.html#config-api-key" class="ulink" target="_top"><code class="literal">ApiKey</code></a>
</li>
<li class="listitem">
<span class="strong strong"><strong>Java Agent</strong></span>: <a href="/guide/en/apm/agent/java/current/config-reporter.html#config-api-key" class="ulink" target="_top"><code class="literal">api_key</code></a>
</li>
<li class="listitem">
<span class="strong strong"><strong>Python Agent</strong></span>: <a href="/guide/en/apm/agent/python/current/configuration.html#config-api-key" class="ulink" target="_top"><code class="literal">api_key</code></a>
</li>
<li class="listitem">
<span class="strong strong"><strong>Ruby Agent</strong></span>: <a href="/guide/en/apm/agent/ruby/current/configuration.html#config-api-key" class="ulink" target="_top"><code class="literal">api_key</code></a>
</li>
</ul>
</div>
</div>
</div>
</div><div class="navfooter">
<span class="prev">
<a href="ssl-setup.html">« SSL/TLS communication</a>
</span>
<span class="next">
<a href="api-key-settings.html"><code class="literal">api_key.*</code> configuration options »</a>
</span>
</div>
<!-- end body -->
</div>
<div class="col-12 order-3 col-lg-2 order-lg-3 h-almost-full-lg sticky-top-lg" id="right_col">
<div id="sticky_content">
<!-- The OTP is appended here -->
<div class="row">
<div class="col-0 col-md-4 col-lg-0" id="bottom_left_col"></div>
<div class="col-12 col-md-8 col-lg-12">
<div id="rtpcontainer">
<div class="mktg-promo" id="most-popular">
<p class="aside-heading">Most Popular</p>
<div class="pb-2">
<p class="media-type">Video</p>
<a href="https://www.elastic.co/webinars/getting-started-elasticsearch?page=docs&placement=top-video">
<p class="mb-0">Get Started with Elasticsearch</p>
</a>
</div>
<div class="pb-2">
<p class="media-type">Video</p>
<a href="https://www.elastic.co/webinars/getting-started-kibana?page=docs&placement=top-video">
<p class="mb-0">Intro to Kibana</p>
</a>
</div>
<div class="pb-2">
<p class="media-type">Video</p>
<a href="https://www.elastic.co/webinars/introduction-elk-stack?page=docs&placement=top-video">
<p class="mb-0">ELK for Logs & Metrics</p>
</a>
</div>
</div>
</div>
<!-- Feedback widget -->
<div id="feedbackWidgetContainer"></div>
</div>
</div>
</div>
</div>
</div>
</div>
</section>
</div>
<div id='elastic-footer'></div>
<script src='https://www.elastic.co/elastic-footer.js'></script>
<!-- Footer Section end-->
</section>
</div>
<!-- Feedback modal -->
<div id="feedbackModalContainer"></div>
<script src="/guide/static/jquery.js"></script>
<script type="text/javascript" src="/guide/static/docs-v1.js"></script>
<script type="text/javascript">
window.initial_state = {}</script>
</body>
</html>