Organization Secrets

Delete Secret

Changed on

Delete a secret from organization vault.

Warning:

  • Deletion is permanent and immediate
  • Any api_call stages using this secret will fail
  • No confirmation prompt - use with caution

Use Cases:

  • Remove unused credentials
  • Clean up after service decommissioning
  • Security incident response
delete/v1/organizations/secrets/{secret_name}

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/organizations/secrets/{secret_name}
  • Auth: HTTP bearer

Path parameters

secret_namestring required

Response

Successful Response

secret_namestring required

Name of the secret that was operated on. This is the same name provided in the request. Use this name to reference the secret in api_call stage configuration.

createdboolean nullable

True if this secret was created, null otherwise. Only set for POST /secrets operations.

updatedboolean nullable

True if this secret was updated, null otherwise. Only set for PUT /secrets/{name} operations.

deletedboolean nullable

True if this secret was deleted, null otherwise. Only set for DELETE /secrets/{name} operations.

Example response

{
  "created": true,
  "description": "Secret created successfully",
  "secret_name": "stripe_api_key"
}

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 5d4c905106b4Revision changes
    • info

      the endpoint scheme security BearerAuth was added to the API