Skip to main content
POST
Stop a policy layer

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"

layerId
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
reason
string
required
Required string length: 1 - 500

Response

200 - application/json

The stopped layer

id
string
required
name
string
required
when
object
required

What a layer targets besides installs and app users (spec 12.4). Sent back as read, it changes nothing; the targeted installs and users are in the layer's hints.

hints
object
required

The last four characters of each install and app user the layer targets: read only. Leave when.installs and when.users out of a PUT to keep them; send them only to target new ones.

rollout
object | null
required

A staged rollout (spec 12.4), with at most two decimals: percent of the targeted installs take the layer, holdback_percent are kept out of it to compare against; together at most 100.

expires_at
string | null
required
changes
object
required

What the layer changes, as the policy's own keys (spec 12.2): capture only narrows, masking and replay only tighten, and in instrumentation only the families: a family is replaced whole, and may list only the app's rules.

guardrails
object
required

The bounds the backend watches (spec 12.4): past one, it publishes the policy without the layer and marks it rolled_back. A guardrail needs a holdback.

state
enum<string>
required

active: published. stopped: a person stopped it (stopped_reason says why). rolled_back: a guardrail did (stopped_reason says which bound). removed: left out of the list. expired: past expires_at.

Available options:
active,
stopped,
rolled_back,
removed,
expired
stopped_reason
string | null
required
stopped_at
string | null
required
updated_by
string | null
required
updated_at
string
required