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"

​
checksum
string
required

A 6-character alpha-numeric string checksum of the random API Token. The last 6 characters of the raw token

Example:

"4n3LFC"

​
createdBy
object
required
​
createdAt
string<date-time>
required
​
note
string
​
projectEnvironmentId
string
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"

​
projectEnvironment
object
​
scopes
enum<string>[]

Scopes assigned to an API token which they will have access to.

Valid scopes for an environment API token

Available options:
waas.delegatedAccess.signMessage,
waas.authenticate,
environment.settings.read,
environment.settings.write,
environment.apiTokens.read,
environment.apiTokens.write,
environment.users.read,
environment.users.write,
environment.analytics.read,
environment.webhooks.read,
environment.webhooks.write,
environment.events.read,
environment.events.write,
environment.balances.read