Delete a secret set

Updated

Deletes a secret set and all its keys.

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}

You can't delete a set that an agent references. Remove the references first. Changing a key also changes the set's ETag, so retrieve the set to get its current ETag before you delete it.

Path Parameters

appidstring
Required

The App ID of your project.

namestring
Required

The name of the secret set.

Header Parameters

If-Matchstring
Required

The ETag value from the most recent response for this resource. If the resource has changed since then, the request fails with 412 and reason PreconditionFailed. Retrieve the resource, apply your change again, and retry with the new ETag.

Response Body

The secret set was deleted.

Response Headers

Agora-Request-Idstring

A unique ID for the request. Include it when you contact Agora support.

deletedboolean
Required

Always true. The resource is deleted.

Authorization

This endpoint requires authentication.

Request examples

Example Request
curl -X DELETE 'https://preview.ai.agora.io/conversational-ai/v1/projects/string/secrets/string' \  -H 'If-Match: string'

Response example

Example Response
{  "deleted": true}