Get namespace settings

GET/v1/data/{namespace}/settings

Fetch the stored schema, settings, and configuration version for a namespace. Use the returned version as previous_version when updating so a stale update is rejected instead of overwriting a newer one.

Path ParametersExpand Collapse

namespace: string

The namespace to ingest data into

ReturnsExpand Collapse

namespace: string

schema: map[unknown]

The stored schema for this namespace, returned exactly as stored.

settings: map[unknown]

The stored namespace settings. Configure with guidance from SafetyKit.

version: number

The current configuration version, incremented each time the configuration is updated through the API or by SafetyKit. Send it as previous_version when updating to detect intervening changes.

Get namespace settings

curl https://api.safetykit.com/v1/data/$NAMESPACE/settings \
    -H "Authorization: Bearer $SAFETYKIT_API_KEY"

{
  "namespace": "users",
  "schema": {
    "profile_image": "bar",
    "cover_photo": "bar",
    "website": "bar"
  },
  "settings": {},
  "version": 4
}

Returns Examples

{
  "namespace": "users",
  "schema": {
    "profile_image": "bar",
    "cover_photo": "bar",
    "website": "bar"
  },
  "settings": {},
  "version": 4
}