Skip to navigation
Management APIReferenceSecrets

SetSecretInfo

View as Markdown

Edits a secret’s parameters.

Example request: Update the value for secret 10.

Authentication

AuthorizationBearer

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the Authorization header as a Bearer value:

Authorization: Bearer $VOXIMPLANT_TOKEN

See Authorization for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

Query parameters

application_idintegerOptional

Application ID. Required unless application_name is provided.

application_namestringOptional

Application name. Required unless application_id is provided.

secret_idintegerOptional

Secret ID to edit. Required unless secret_name is provided.

secret_namestringOptional

Secret name. Required unless secret_id is provided.

new_secret_namestringOptionalformat: "^[A-Za-z][A-Za-z0-9_]{0,63}$"<=64 characters
New secret name. The name must start with a Latin letter and can contain up to 64 characters, including Latin letters, digits and underscores
secret_valuestringOptional
Secret value. Maximum length is 8192 characters
descriptionstringOptional
Secret description. When processing, the length is truncated to the first 200 characters

Response

Successful response
resultintegerOptional
Returns 1 if the secret has been updated successfully