API reference

Revoke an API key

DELETE /v1/api-keys/{id}

Permanently revokes one credential owned by the authenticated identity.

Authentication: Send an API key or a service-account access token as a Bearer token.

Parameters

204
Key revoked.

object X-Request-ID
401
Authentication required.

PublicApiError X-Request-ID
403
The API key lacks key-management permission.

PublicApiError X-Request-ID
404
Key is absent or owned by another identity.

PublicApiError X-Request-ID

Machine-readable product API failure.

Allowed values

Browser-safe recovery action selected by the authoritative product boundary.

ErrorRecovery alternatives
Variant	Type
1	object
2	object

Stable public error envelope for APIs whose reason vocabulary is extensible.

code ErrorCode Required
Closed status category suitable for program control flow.
Allowed
- unauthenticated
- forbidden
- invalid_request
- not_found
- conflict
- payment_required
- too_many_requests
- upstream
- internal
message string Required

Safe diagnostic intended for operators, not program branching.
reason string Required

Extensible machine-readable detail; clients must accept unknown values.
recovery null | ErrorRecovery Optional
request_id string | null Optional

The request reference, equal to the response's `X-Request-ID`; quote it to support.
validation null | ValidationReport Optional

One actionable, privacy-safe contract violation.

allowed_values array | null Optional
Maximum items
- 16
code string Required
Stable, extensible machine-readable category.
Maximum length
- 64
path string Required
RFC 6901 pointer to the rejected location; empty means the root value.
Maximum length
- 1024
suggestion string Required
Code-owned instruction for correcting the request.
Maximum length
- 512

Bounded validation feedback shared by model, REST, and MCP boundaries.

contract string Required
Stable contract name, normally the published schema component name.
Maximum length
- 128
issues ValidationIssue[] Required
At most eight deterministic violations. Correct every issue before retrying.
Maximum items
- 8
truncated boolean Required

Whether more violations were omitted; retry after correcting the listed issues.

Request

curl --request DELETE "https://platform.yep.com/api/v1/api-keys/$YEP_API_KEY_ID" \
  --header "Authorization: Bearer $YEP_API_KEY"