API7 Docs

Delete a secret provider on a gateway group

DELETE /apisix/admin/secret_providers/{secret_provider}/{secret_provider_id}

DELETE /apisix/admin/secret_providers/{secret_provider}/{secret_provider_id}

Interactive request editor loads with JavaScript.

Authorization

X-API-KEY<token>

In: header

Path Parameters

secret_provider*string

Secret provider.

Value in

  • "vault"
  • "aws"
  • "kubernetes"
secret_provider_id*string

Secret provider ID.

Match^[a-zA-Z0-9-_.]+$
Length1 <= length <= 256

Query Parameters

gateway_group_id*string

Gateway group ID. Optional when using the gateway group admin key to authenticate.

Length1 <= length

Response Body

application/json

application/json

curl -X DELETE "$API_BASE_URL/apisix/admin/secret_providers/vault/bd58fce2-b6cc-4d2d-a53c-6ce11b19c101?gateway_group_id=86fb9981-d9d2-4555-9df8-91ae92129335"

Operation completed successfully with no response body.

""
Complete operation details and schema variants

DELETE /apisix/admin/secret_providers/{secret_provider}/{secret_provider_id}

Delete a secret provider on a gateway group

Delete a secret provider integration from the gateway group. Ensure no plugin or resource still references secrets from this provider before removal. Required IAM Permission: Action gateway:DeleteSecretProvider, Resource arn:api7:gateway:gatewaygroup/%s/secret_provider/%s

Parameters

  • secret_provider (path, string, required): Secret provider.
  • secret_provider_id (path, string, required): Secret provider ID.
  • gateway_group_id (query, string, required): Gateway group ID. Optional when using the gateway group admin key to authenticate.

Responses

  • 200: Operation completed successfully with no response body.
  • 400: Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.
  • value (object, optional): The specific resource.
  • error_msg (string, optional): The error message.

cURL

curl -X DELETE '$API_BASE_URL/apisix/admin/secret_providers/{secret_provider}/{secret_provider_id}'