Delete a secret key
Updated
Removes a key from a secret set.
Preview documentation
You're reading the Conversational AI Platform (Preview) docs. Switch to Main.
DELETE
https://preview.ai.agora.io/conversational-ai/v1/projects/{appid}/secrets/{name}/keys/{key}You can't remove a key that an agent references. A secret set must also keep at least one key. To remove the last key, delete the set instead.
appidstringRequired
The App ID of your project.
namestringRequired
The name of the secret set.
keystringRequired
The name of the key in the secret set. When you add a key, use 1 to 64 characters from A-Z, a-z, 0-9, and _.
If-MatchstringThe key's ETag from your last write to it. The request fails with 412 if the key has changed since then.
Response Body
Request examples
curl -X DELETE 'https://preview.ai.agora.io/conversational-ai/v1/projects/string/secrets/string/keys/string'Response example
Example Response
{ "deleted": true}