Delete Provider Key

DELETE /provider_keys/{provider_key_id}

Interactive request editor loads with JavaScript.

Authorization

BearerAdminToken

AuthorizationBearer <token>

Organization-scoped admin token. Read operations require a valid token, and write operations require a token with write permission.

In: header

Path Parameters

provider_key_id*string

Provider key ID.

Formatuuid

Response Body

`application/json`

curl -X DELETE "$AISIX_CP/provider_keys/$PROVIDER_KEY_ID" \  -H "Authorization: Bearer $AISIX_TOKEN"

{
  "deleted": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Request body or parameters failed validation.

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Missing or invalid bearer.

{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "no org context"
  }
}

Authenticated request is not permitted.

{
  "error": {
    "code": "CUSTOM_KEY_DISABLED",
    "message": "custom API key values are disabled for this organization"
  }
}

Resource not found.

{
  "error": {
    "code": "NOT_FOUND",
    "message": "provider key not found"
  }
}

Request conflicts with current resource state.

{
  "error": {
    "code": "CREDENTIAL_IN_USE",
    "message": "models still reference this provider_key"
  }
}

Complete operation details and schema variants