Skip to main content
DELETE
Revoke one issued database credential

Authorizations

Authorization
string
header
required

WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.

Headers

X-Request-Id
string

Optional caller-provided correlation identifier.

Required string length: 1 - 128

Path Parameters

project_id
string
required

Project identifier.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
access_id
string
required

Issued database credential identifier.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Response

The revoked credential record without any connection URI.

access_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
environment
enum<string>
required
Available options:
dev,
prod
mode
enum<string>
required
Available options:
read,
write
role_name
string
required
Pattern: ^ohmyho_da_[0-7][0-9a-hjkmnp-tv-z]{25}_[0-9a-z]{8}$
host
string
required
Required string length: 1 - 253
database
string
required
Allowed value: "neondb"
label
string | null
required
Required string length: 1 - 64
state
enum<string>
required
Available options:
active,
expired,
revoked
issued_at
string<date-time>
required
expires_at
string<date-time>
required
revoked_at
string<date-time> | null
required
revocation_reason
enum<string> | null
required
Available options:
principal,
expired,
budget,
creation_failed,
null