> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# GetSecretValue

# Package: secrets

# Namespace: SecretsVaultService

# Method link: https://dev.wix.com/docs/api-reference/business-management/secrets/get-secret-value.md

## Permission Scopes:
Manage Secrets: SCOPE.VELO.MANAGE_SECRETS

## Introduction

Retrieves a secret value by name.

<blockquote class="caution">
__Caution:__
Only use a secret's value in the backend code. Returning the secret value in the frontend is a security risk.
</blockquote>

---

## REST API

### Schema

```
 Method: getSecretValue
 Description: Retrieves a secret value by name.  <blockquote class="caution"> __Caution:__ Only use a secret's value in the backend code. Returning the secret value in the frontend is a security risk. </blockquote>
 URL: https://www.wixapis.com/api/v1/secrets/name/{name}
 Method: GET
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  name
 Method parameters: 
   param name: name | type:   none | required: true
 Return type: GetSecretValueResponse
  - name: value | type: string | description: The confidential value to protect, such as an API key. 


```

### Examples

### GetSecretValue
```curl
~~~cURL
curl -X GET 'https://www.wixapis.com/_api/cloud-secrets-vault-server/api/v1/secrets/name/secret_key' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH TOKEN>' \
~~~
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.secrets.SecretsVaultService.getSecretValue(name)
 Description: Retrieves a secret value by name.  <blockquote class="caution"> __Caution:__ Only use a secret's value in the backend code. Returning the secret value in the frontend is a security risk. </blockquote>
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  name
 Method parameters: 
   param name: name | type: string | description: The name of the secret to get the value of.  | required: true
 Return type: PROMISE<GetSecretValueResponse>
  - name: value | type: string | description: The confidential value to protect, such as an API key. 


```

### Examples

### getSecretValue
```javascript
import { secrets } from '@wix/secrets';

async function getSecretValue(name) {
  const response = await secrets.getSecretValue(name);
};
```

### getSecretValue (with elevated permissions)
```javascript
import { secrets } from '@wix/secrets';
import { auth } from '@wix/essentials';

async function myGetSecretValueMethod(name) {
  const elevatedGetSecretValue = auth.elevate(secrets.getSecretValue);
  const response = await elevatedGetSecretValue(name);
}
```

### getSecretValue (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { secrets } from '@wix/secrets';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { secrets },
  // Include the auth strategy and host as relevant
});


async function getSecretValue(name) {
  const response = await myWixClient.secrets.getSecretValue(name);
};
```

---