74 lines
2.4 KiB
Markdown
74 lines
2.4 KiB
Markdown
---
|
|
title: Add secrets
|
|
description: Add secrets using the InfluxDB Cloud UI, `influx` CLI, or the InfluxDB API.
|
|
influxdb/cloud/tags: [secrets, security]
|
|
menu:
|
|
influxdb_cloud:
|
|
parent: Manage secrets
|
|
weight: 301
|
|
aliases:
|
|
- /influxdb/cloud/security/secrets/manage-secrets/add/
|
|
- /influxdb/cloud/security/secrets/add/
|
|
---
|
|
|
|
Add secrets using the {{< product-name "short" >}} UI, `influx` command line interface (CLI) or the InfluxDB API.
|
|
|
|
- [Add a secret using the InfluxDB Cloud UI](#add-a-secret-using-the-influxdb-cloud-ui)
|
|
- [Add a secret using the influx CLI](#add-a-secret-using-the-influx-cli)
|
|
- [Add a secret using the InfluxDB API](#add-a-secret-using-the-influxdb-api)
|
|
|
|
## Add a secret using the InfluxDB Cloud UI
|
|
|
|
1. In the {{< product-name "short" >}} UI, click **Settings**.
|
|
|
|
{{< nav-icon "settings" >}}
|
|
2. Click the **Secrets** tab.
|
|
3. Click **Add Secret**.
|
|
4. Enter a *key* and a *value*.
|
|
{{% warn %}}
|
|
Once the value is set, you will not be able to view the secret value again.
|
|
It will only be accessible to your code through the secrets library.
|
|
{{% /warn %}}
|
|
5. Click **Add Secret**.
|
|
|
|
## Add a secret using the influx CLI
|
|
Use the [`influx secret update` command](/influxdb/cloud/reference/cli/influx/secret/update/)
|
|
to add a new secret to your organization.
|
|
Provide the secret key with the `-k` or `--key` flag.
|
|
You may also provide the secret value with the `-v` or `--value` flag.
|
|
If you do not provide the secret value with the `-v` or `--value` flag,
|
|
enter the value when prompted.
|
|
|
|
{{% warn %}}
|
|
Providing a secret value with the `-v` or `--value` flag may expose the secret
|
|
in your command history.
|
|
{{% /warn %}}
|
|
|
|
```sh
|
|
# Syntax
|
|
influx secret update -k <secret-key>
|
|
|
|
# Example
|
|
influx secret update -k foo
|
|
```
|
|
|
|
## Add a secret using the InfluxDB API
|
|
Use the `PATCH` request method and the `/orgs/{orgID}/secrets` API endpoint to
|
|
add a new secret to your organization.
|
|
|
|
**Include the following:**
|
|
|
|
- Your [organization ID](/influxdb/cloud/admin/organizations/view-orgs/#view-your-organization-id) in the request URL
|
|
- Your [API token](/influxdb/cloud/admin/tokens/view-tokens/) in the `Authorization` header
|
|
- The secret key-value pair in the request body
|
|
|
|
<!-- -->
|
|
```sh
|
|
curl -XPATCH https://cloud2.influxdata.com/api/v2/orgs/<org-id>/secrets \
|
|
-H 'Authorization: Token YOUR_API_TOKEN' \
|
|
-H 'Content-type: application/json' \
|
|
--data '{
|
|
"<secret-key>": "<secret-value>"
|
|
}'
|
|
```
|