PorticoDocs

User Mutations

Generated user mutations operations.

GET/v1/user-mutations/{key}Read the original sign-in's compact mutation receiptplayback
Audience
Clients · Native API
Authorization
API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID
get_user_mutation

Parameters

NameInTypeDescription
keyrequiredpathstring
Portico-Mutation-Rootheaderstring

Responses

200Successapplication/json

Example
{
  "committedMs": 1800000,
  "expiresMs": 1800000,
  "generation": 0,
  "key": "string",
  "operation": "string",
  "positionMs": 1800000,
  "positionStatus": "",
  "revision": 0,
  "status": "applied",
  "targetId": "id_8h2k4q"
}
Schema
  • committedMsintegerrequired0–9999999999999
  • expiresMsintegerrequired0–10002591999999
  • generationinteger0–2147483647
  • keystringrequiredlength 51–51pattern ^p251_[0-9]{13}_[0-9a-f]{32}$
  • operationstringrequiredlength 0–96
  • positionMsinteger≥ 0
  • positionStatusstringone of "", "applied", "already_stopped", "not_renderer", "policy_rejected", "unchanged"
  • revisioninteger≥ 0
  • statusstringrequiredone of "applied", "already_stopped", "conflict", "invalid", "terminal", "deleted", "removed", "partial"
  • targetIdstringlength 0–128

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesunauthorizednot_permittednot_foundreceipt_unknownreceipt_expiredinvalid_mutation_keyinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/user-mutations/{key}" \
  -H "Authorization: Bearer $PORTICO_API_KEY"
GET/v1/user-mutations/policyRead server time and the mutation replay cutoffplayback
Audience
Clients · Native API
Authorization
API key or personal access token with the playback scope, or a signed-in session
OpenAPI operation ID
get_user_mutation_policy

Responses

200Successapplication/json

Example
{
  "retentionDays": 0,
  "retiredBeforeMs": 1800000,
  "serverTimeMs": 1800000
}
Schema
  • retentionDaysintegerrequired
  • retiredBeforeMsintegerrequired
  • serverTimeMsintegerrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesunauthorizednot_permittedinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/user-mutations/policy" \
  -H "Authorization: Bearer $PORTICO_API_KEY"