Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.dynamic.xyz/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
id
string
required
Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

​
projectEnvironmentId
string
required
Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

​
kid
string
required

Short identifier referenced in webhook envelopes so the developer knows which private key to use

Maximum string length: 64
​
alg
enum<string>
required

Algorithm for how this key is used

Available options:
RSA-OAEP-256,
HYBRID-RSA-AES-256
​
publicKeyPemB64
string
required

Developer's public key material, PEM encoded then base64'd

Maximum string length: 4096
​
status
enum<string>
required

Lifecycle status of this key

Available options:
pending,
active,
revoked
​
type
enum<string>
required
Available options:
dynamic,
external
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
expiresAt
string<date-time> | null

Optional expiry for planned rotations

​
revokedAt
string<date-time> | null

Timestamp when the key was revoked