Skip to main content
POST
Stop or restart an app's SDK

Authorizations

apsio_session
string
cookie
required

The console session, set by /v1/auth/callback (__Host-apsio_session when host-only).

Path Parameters

orgId
string
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"0192f3a4-0000-7000-8000-00000000a001"

projectId
string
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"0192f3a4-0000-7000-8000-00000000a001"

appId
string
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"0192f3a4-0000-7000-8000-00000000a001"

Body

application/json
on
boolean
required
reason
string

Required to turn it on: 1 to 500 characters.

Maximum string length: 500

Response

200 - application/json

The instrumentation, with the switch as published

app_id
string
required
families
object
required

A family left out is in always mode, except resources, which is in never mode (D113).

retention_hours
integer
required

How long held records stay on the device: 1 to 168 hours.

cap_bytes
integer
required

The store's cap: at most 20 MiB.

replay_cap_bytes
integer
required

Replay's share of it: at most 10 MiB.

rules
object[]
required

At most 50; families list them as rule:.

kill_switch
object
required

The app's own kill switch (spec 12.3): its SDKs stop collecting, drop what they hold and send nothing until it is off.

updated_by
string | null
required

Null: the profile's defaults.

updated_at
string | null
required