> 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 # PartiallyUpdateSecret # Package: secrets # Namespace: SecretsVaultService # Method link: https://dev.wix.com/docs/api-reference/business-management/secrets/partially-update-secret.md ## Permission Scopes: Manage Secrets: SCOPE.VELO.MANAGE_SECRETS ## Introduction Updates 1 or all fields of a secret. To get the secret ID, call [List Secret Info](https://dev.wix.com/docs/rest/business-management/secrets/list-secret-info.md). --- ## REST API ### Schema ``` Method: partiallyUpdateSecret Description: Updates 1 or all fields of a secret. To get the secret GUID, call [List Secret Info](https://dev.wix.com/docs/rest/business-management/secrets/list-secret-info.md). URL: https://www.wixapis.com/api/v1/secrets/{id} Method: PATCH # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: secret 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. - 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. Return type: UpdateSecretResponse EMPTY-OBJECT {} ``` ### Examples ### PartiallyUpdateSecret ```curl ~~~cURL curl -X PATCH 'https://www.wixapis.com/_api/cloud-secrets-vault-server/api/v1/secrets/a560ff70-3e9b-41b6-b66d-cf3434085f7d' \ -H 'Content-Type: application/json' \ -H 'Authorization: ' \ -d '{ "secret": { "name": "updated_secret_key", "description": "AWS secret access key", "value": "44aSQCljxL9FLvTVA.9dKbpwueYoQ8isyQhvun19pOT9gHEdgxam39LJ0Ts70" } }' ~~~ ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.secrets.SecretsVaultService.partiallyUpdateSecret(_id, secret) Description: Updates 1 or all fields of a secret. To get the secret GUID, call [List Secret Info](https://dev.wix.com/docs/rest/business-management/secrets/list-secret-info.md). # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: secret, _id Method parameters: param name: _id | type: string | description: GUID of the secret to update. | required: true 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. - 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. Return type: PROMISE EMPTY-OBJECT {} ``` ### Examples ### updateSecret ```javascript import { secrets } from '@wix/secrets'; async function updateSecret(_id,secret) { const response = await secrets.updateSecret(_id,secret); }; ``` ### updateSecret (with elevated permissions) ```javascript import { secrets } from '@wix/secrets'; import { auth } from '@wix/essentials'; async function myUpdateSecretMethod(_id,secret) { const elevatedUpdateSecret = auth.elevate(secrets.updateSecret); const response = await elevatedUpdateSecret(_id,secret); } ``` ### updateSecret (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 updateSecret(_id,secret) { const response = await myWixClient.secrets.updateSecret(_id,secret); }; ``` ---