Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

API key authentication. Pass Authorization: Bearer ek_live_xxxxx on every request.

Path Parameters

ws
required
Required string length: 2 - 48
Pattern: ^[a-z0-9-]+$
prj
required
Required string length: 2 - 48
Pattern: ^[a-z0-9-]+$

Response

200 - application/json

Default Response

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
projectId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
projectName
string
required
projectSlug
string
required
environmentId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
environmentName
string
required
createdByUserId
string | null
required
createdByUserName
string | null
required
createdAt
string
required
expiresAt
string
required
revokedAt
string | null
required
maxViews
number | null
required
viewCount
number
required
secretCount
number
required
hasPassword
boolean
required
status
enum<string>
required
Available options:
active,
expired,
revoked,
exhausted