> 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

# CreateSecret

# Package: secrets

# Namespace: SecretsVaultService

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

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

## Introduction

Creates a secret.

---

## REST API

### Schema

```
 Method: createSecret
 Description: Creates a secret.
 URL: https://www.wixapis.com/api/v1/secrets
 Method: POST
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  secret, secret.name, secret.value
 Method parameters: 
   param name: secret | type: Secret   | required: true
        - name: name | type: string | description: A unique, human-friendly name for the secret. Use it to retrieve the secret value with Get Secret Value.  **Note:** You can use alphanumeric characters and the following special characters: `_+=-@#$`. Spaces are not supported. | required: true
        - name: description | type: string | description: Optional text describing the secret's purpose or any other notes about it. 
        - name: value | type: string | description: The encrypted confidential value. | required: true
 Return type: CreateSecretResponse
  - name: id | type: string | description: Unique secret GUID. 


```

### Examples

### CreateSecret
```curl
~~~cURL
curl -X POST 'https://www.wixapis.com/_api/cloud-secrets-vault-server/api/v1/secrets' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH TOKEN>' \
-d '{
     "secret": {
        "name": "secret_key",
        "description": "AWS secret access key",
        "value": "Fm8OfflH6bJOwWjenqAtLurLbkiMNvmhQHZV+118"
    }
}'
~~~
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.secrets.SecretsVaultService.createSecret(secret)
 Description: Creates a secret.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  secret, secret.name, secret.value
 Method parameters: 
   param name: secret | type: Secret   | required: true
        - name: name | type: string | description: A unique, human-friendly name for the secret. Use it to retrieve the secret value with Get Secret Value.  **Note:** You can use alphanumeric characters and the following special characters: `_+=-@#$`. Spaces are not supported. | required: true
        - name: description | type: string | description: Optional text describing the secret's purpose or any other notes about it. 
        - name: value | type: string | description: The encrypted confidential value. | required: true
 Return type: PROMISE<CreateSecretResponse>
  - name: _id | type: string | description: Unique secret GUID. 


```

### Examples

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

async function createSecret(secret) {
  const response = await secrets.createSecret(secret);
};
```

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

async function myCreateSecretMethod(secret) {
  const elevatedCreateSecret = auth.elevate(secrets.createSecret);
  const response = await elevatedCreateSecret(secret);
}
```

### createSecret (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 createSecret(secret) {
  const response = await myWixClient.secrets.createSecret(secret);
};
```

---