Get public share metadata - Enkryptify Documentation

GET

{token}

meta

cURL

curl -X GET 'http://localhost:8080/v1/share/share_example/meta' \
  -H 'Authorization: Bearer ek_live_xxxxx'

{
  "requiresPassword": true,
  "expiresAt": "<string>",
  "viewsUsed": 123,
  "maxViews": 123,
  "secretCount": 123,
  "environmentName": "<string>",
  "projectName": "<string>"
}

Path Parameters

token

string

required

Required string length: 1 - 128

Pattern: ^[a-f0-9]+$

Response

200 - application/json

Default Response

requiresPassword

boolean

required

expiresAt

string

required

viewsUsed

number

required

maxViews

number | null

required

secretCount

number

required

environmentName

string

required

projectName

string

required

status

enum<string>

required

Available options:

active,

expired,

revoked,

exhausted

Consume a public shareDecrypts and returns the share's contents. Consumes one view from the share's remaining count. If the share is password-protected, the password must be supplied in the body. Public endpoint, no authentication required.

cURL

curl -X GET 'http://localhost:8080/v1/share/share_example/meta' \
  -H 'Authorization: Bearer ek_live_xxxxx'

{
  "requiresPassword": true,
  "expiresAt": "<string>",
  "viewsUsed": 123,
  "maxViews": 123,
  "secretCount": 123,
  "environmentName": "<string>",
  "projectName": "<string>"
}