RSX · API · Reference

state v1

Persistent state and audit history for services that outlive the container they run in.

openapi.json

Current

Base URL: https://api.rsx.group/state/v1
Self-grantable scopes: None. Every endpoint here needs a key issued by a platform admin.
Machine readable: openapi.json

admin

6 operations under /state/v1/admin.

GET/state/v1/admin/audit/list

Audit events across every source, newest first

Scope: state:admin:audit:list Admin-issued keys only.

Query parameters

Query parameters of adminListAuditEvents
Parameter	Type	Description
source	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
scope	string	up to 256 characters
actor	string	up to 256 characters
action	string	up to 128 characters
target	string	up to 256 characters
before	string, date-time
after	string, date-time
cursor	string
limit	integer	1 to 100 · default 20

source
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
scope
Type
string
Description
up to 256 characters
actor
Type
string
Description
up to 256 characters
action
Type
string
Description
up to 128 characters
target
Type
string
Description
up to 256 characters
before
Type
string, date-time
Description
after
Type
string, date-time
Description
cursor
Type
string
Description
limit
Type
integer
Description
1 to 100 · default 20

Response 200Audit events

Response of adminListAuditEvents
Field	Type	Description
datarequired	array of AuditEvent
idrequired	string
sourcerequired	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
scoperequired	string, or null
actorrequired	string, or null
actionrequired	string
targetrequired	string, or null
metadatarequired	map of any, or null
{key}	any
createdAtrequired	string, date-time
metarequired	object
cursorrequired	string, or null

datarequired
Type
array of AuditEvent
Description
idrequired
Type
string
Description
sourcerequired
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
scoperequired
Type
string, or null
Description
actorrequired
Type
string, or null
Description
actionrequired
Type
string
Description
targetrequired
Type
string, or null
Description
metadatarequired
Type
map of any, or null
Description
{key}
Type
any
Description
createdAtrequired
Type
string, date-time
Description
metarequired
Type
object
Description
cursorrequired
Type
string, or null
Description

Example

curl

curl "https://api.rsx.group/state/v1/admin/audit/list" \
  -H "Authorization: Bearer rsx_live_..."

200 response

{
  "data": [
    {
      "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
      "source": "roxy",
      "scope": "guild:123456789",
      "actor": "user:987654321",
      "action": "member.ban",
      "target": "user:456789123",
      "metadata": {
        "reason": "Spam"
      },
      "createdAt": "2026-09-01T14:30:00.000Z"
    }
  ],
  "meta": {
    "cursor": "string"
  }
}

GET/state/v1/admin/audit/get

One audit event, whoever produced it

Scope: state:admin:audit:get Admin-issued keys only.

Query parameters

Query parameters of adminGetAuditEvent
Parameter	Type	Description
idrequired	string	1 to 64 characters

idrequired
Type
string
Description
1 to 64 characters

Response 200The audit event

Response of adminGetAuditEvent
Field	Type	Description
datarequired	AuditEvent
idrequired	string
sourcerequired	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
scoperequired	string, or null
actorrequired	string, or null
actionrequired	string
targetrequired	string, or null
metadatarequired	map of any, or null
{key}	any
createdAtrequired	string, date-time

datarequired
Type
AuditEvent
Description
idrequired
Type
string
Description
sourcerequired
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
scoperequired
Type
string, or null
Description
actorrequired
Type
string, or null
Description
actionrequired
Type
string
Description
targetrequired
Type
string, or null
Description
metadatarequired
Type
map of any, or null
Description
{key}
Type
any
Description
createdAtrequired
Type
string, date-time
Description

Example

curl

curl "https://api.rsx.group/state/v1/admin/audit/get?id=string" \
  -H "Authorization: Bearer rsx_live_..."

200 response

{
  "data": {
    "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
    "source": "roxy",
    "scope": "guild:123456789",
    "actor": "user:987654321",
    "action": "member.ban",
    "target": "user:456789123",
    "metadata": {
      "reason": "Spam"
    },
    "createdAt": "2026-09-01T14:30:00.000Z"
  }
}

GET/state/v1/admin/state/list

State entries across every namespace, or within one

Scope: state:admin:state:list Admin-issued keys only.

Query parameters

Query parameters of adminListState
Parameter	Type	Description
namespace	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
cursor	string
limit	integer	1 to 100 · default 50

namespace
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
cursor
Type
string
Description
limit
Type
integer
Description
1 to 100 · default 50

Response 200State entries, ordered by namespace then key

Response of adminListState
Field	Type	Description
datarequired	array of StateEntry
namespacerequired	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
keyrequired	string	1 to 256 characters · matches ^\S(?:[^\x00-\x1f\x7f]*\S)?$
valuerequired	any	Any JSON value. At most 32 KiB once serialised.
createdAtrequired	string, date-time
updatedAtrequired	string, date-time
metarequired	object
cursorrequired	string, or null

datarequired
Type
array of StateEntry
Description
namespacerequired
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
keyrequired
Type
string
Description
1 to 256 characters · matches ^\S(?:[^\x00-\x1f\x7f]*\S)?$
valuerequired
Type
any
Description
Any JSON value. At most 32 KiB once serialised.
createdAtrequired
Type
string, date-time
Description
updatedAtrequired
Type
string, date-time
Description
metarequired
Type
object
Description
cursorrequired
Type
string, or null
Description

Example

curl

curl "https://api.rsx.group/state/v1/admin/state/list" \
  -H "Authorization: Bearer rsx_live_..."

200 response

{
  "data": [
    {
      "namespace": "roxy",
      "key": "guild:123456789",
      "value": null,
      "createdAt": "2026-09-01T14:30:00.000Z",
      "updatedAt": "2026-09-01T14:30:00.000Z"
    }
  ],
  "meta": {
    "cursor": "string"
  }
}

GET/state/v1/admin/state/get

One state entry, in any namespace

Scope: state:admin:state:get Admin-issued keys only.

Query parameters

Query parameters of adminGetState
Parameter	Type	Description
namespacerequired	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
keyrequired	string	1 to 256 characters · matches ^\S(?:[^\x00-\x1f\x7f]*\S)?$

namespacerequired
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
keyrequired
Type
string
Description
1 to 256 characters · matches ^\S(?:[^\x00-\x1f\x7f]*\S)?$

Response 200The state entry

Response of adminGetState
Field	Type	Description
datarequired	object
namespacerequired	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
keyrequired	string	1 to 256 characters · matches ^\S(?:[^\x00-\x1f\x7f]*\S)?$
valuerequired	any	Any JSON value. At most 32 KiB once serialised.
createdAtrequired	string, date-time
updatedAtrequired	string, date-time

datarequired
Type
object
Description
namespacerequired
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
keyrequired
Type
string
Description
1 to 256 characters · matches ^\S(?:[^\x00-\x1f\x7f]*\S)?$
valuerequired
Type
any
Description
Any JSON value. At most 32 KiB once serialised.
createdAtrequired
Type
string, date-time
Description
updatedAtrequired
Type
string, date-time
Description

Example

curl

curl "https://api.rsx.group/state/v1/admin/state/get?namespace=roxy&key=guild%3A123456789" \
  -H "Authorization: Bearer rsx_live_..."

200 response

{
  "data": {
    "namespace": "roxy",
    "key": "guild:123456789",
    "value": null,
    "createdAt": "2026-09-01T14:30:00.000Z",
    "updatedAt": "2026-09-01T14:30:00.000Z"
  }
}

GET/state/v1/admin/owners/list

Every claimed namespace and audit source, and the key holding it

Scope: state:admin:owners:list Admin-issued keys only.

Query parameters

Query parameters of adminListStateOwners
Parameter	Type	Description
kind	string	one of "namespace", "source"
cursor	string
limit	integer	1 to 100 · default 50

kind
Type
string
Description
one of "namespace", "source"
cursor
Type
string
Description
limit
Type
integer
Description
1 to 100 · default 50

Response 200Ownership records

Response of adminListStateOwners
Field	Type	Description
datarequired	array of StateOwner
kindrequired	string	one of "namespace", "source"
namerequired	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
apiKeyIdrequired	string
claimedAtrequired	string, date-time
metarequired	object
cursorrequired	string, or null

datarequired
Type
array of StateOwner
Description
kindrequired
Type
string
Description
one of "namespace", "source"
namerequired
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
apiKeyIdrequired
Type
string
Description
claimedAtrequired
Type
string, date-time
Description
metarequired
Type
object
Description
cursorrequired
Type
string, or null
Description

Example

curl

curl "https://api.rsx.group/state/v1/admin/owners/list" \
  -H "Authorization: Bearer rsx_live_..."

200 response

{
  "data": [
    {
      "kind": "namespace",
      "name": "roxy",
      "apiKeyId": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
      "claimedAt": "2026-09-01T14:30:00.000Z"
    }
  ],
  "meta": {
    "cursor": "string"
  }
}

POST/state/v1/admin/owners/update

Reassign a namespace or audit source to a different API key

Scope: state:admin:owners:update Admin-issued keys only.

Request bodyapplication/json

Request body of adminUpdateStateOwner
Field	Type	Description
kindrequired	string	one of "namespace", "source"
namerequired	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
apiKeyIdrequired	string	1 to 128 characters

kindrequired
Type
string
Description
one of "namespace", "source"
namerequired
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
apiKeyIdrequired
Type
string
Description
1 to 128 characters

Response 200The ownership record, as it now stands

Response of adminUpdateStateOwner
Field	Type	Description
datarequired	StateOwner
kindrequired	string	one of "namespace", "source"
namerequired	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
apiKeyIdrequired	string
claimedAtrequired	string, date-time

datarequired
Type
StateOwner
Description
kindrequired
Type
string
Description
one of "namespace", "source"
namerequired
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
apiKeyIdrequired
Type
string
Description
claimedAtrequired
Type
string, date-time
Description

Example

curl

curl -X POST https://api.rsx.group/state/v1/admin/owners/update \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "kind": "namespace",
  "name": "roxy",
  "apiKeyId": "string"
}'

200 response

{
  "data": {
    "kind": "namespace",
    "name": "roxy",
    "apiKeyId": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
    "claimedAt": "2026-09-01T14:30:00.000Z"
  }
}

state

4 operations under /state/v1/state.

GET/state/v1/state/get

Read one persistent state value

Scope: state:state:get Admin-issued keys only.

Query parameters

Query parameters of getState
Parameter	Type	Description
namespacerequired	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
keyrequired	string	1 to 256 characters · matches ^\S(?:[^\x00-\x1f\x7f]*\S)?$

namespacerequired
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
keyrequired
Type
string
Description
1 to 256 characters · matches ^\S(?:[^\x00-\x1f\x7f]*\S)?$

Response 200The state entry

Response of getState
Field	Type	Description
datarequired	object
namespacerequired	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
keyrequired	string	1 to 256 characters · matches ^\S(?:[^\x00-\x1f\x7f]*\S)?$
valuerequired	any	Any JSON value. At most 32 KiB once serialised.
createdAtrequired	string, date-time
updatedAtrequired	string, date-time

datarequired
Type
object
Description
namespacerequired
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
keyrequired
Type
string
Description
1 to 256 characters · matches ^\S(?:[^\x00-\x1f\x7f]*\S)?$
valuerequired
Type
any
Description
Any JSON value. At most 32 KiB once serialised.
createdAtrequired
Type
string, date-time
Description
updatedAtrequired
Type
string, date-time
Description

Example

curl

curl "https://api.rsx.group/state/v1/state/get?namespace=roxy&key=guild%3A123456789" \
  -H "Authorization: Bearer rsx_live_..."

200 response

{
  "data": {
    "namespace": "roxy",
    "key": "guild:123456789",
    "value": null,
    "createdAt": "2026-09-01T14:30:00.000Z",
    "updatedAt": "2026-09-01T14:30:00.000Z"
  }
}

GET/state/v1/state/list

List persistent state within a namespace

Scope: state:state:list Admin-issued keys only.

Query parameters

Query parameters of listState
Parameter	Type	Description
namespacerequired	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
cursor	string
limit	integer	1 to 100 · default 20

namespacerequired
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
cursor
Type
string
Description
limit
Type
integer
Description
1 to 100 · default 20

Response 200State entries, ordered by key

Response of listState
Field	Type	Description
datarequired	array of object
namespacerequired	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
keyrequired	string	1 to 256 characters · matches ^\S(?:[^\x00-\x1f\x7f]*\S)?$
valuerequired	any	Any JSON value. At most 32 KiB once serialised.
createdAtrequired	string, date-time
updatedAtrequired	string, date-time
metarequired	object
cursorrequired	string, or null

datarequired
Type
array of object
Description
namespacerequired
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
keyrequired
Type
string
Description
1 to 256 characters · matches ^\S(?:[^\x00-\x1f\x7f]*\S)?$
valuerequired
Type
any
Description
Any JSON value. At most 32 KiB once serialised.
createdAtrequired
Type
string, date-time
Description
updatedAtrequired
Type
string, date-time
Description
metarequired
Type
object
Description
cursorrequired
Type
string, or null
Description

Example

curl

curl "https://api.rsx.group/state/v1/state/list?namespace=roxy" \
  -H "Authorization: Bearer rsx_live_..."

200 response

{
  "data": [
    {
      "namespace": "roxy",
      "key": "guild:123456789",
      "value": null,
      "createdAt": "2026-09-01T14:30:00.000Z",
      "updatedAt": "2026-09-01T14:30:00.000Z"
    }
  ],
  "meta": {
    "cursor": "string"
  }
}

POST/state/v1/state/update

Create or replace a persistent state value

Scope: state:state:update Admin-issued keys only.

Request bodyapplication/json

Request body of updateState
Field	Type	Description
namespacerequired	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
keyrequired	string	1 to 256 characters · matches ^\S(?:[^\x00-\x1f\x7f]*\S)?$
valuerequired	any	Any JSON value. At most 32 KiB once serialised.

namespacerequired
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
keyrequired
Type
string
Description
1 to 256 characters · matches ^\S(?:[^\x00-\x1f\x7f]*\S)?$
valuerequired
Type
any
Description
Any JSON value. At most 32 KiB once serialised.

Response 200The stored entry

Response of updateState
Field	Type	Description
datarequired	object
namespacerequired	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
keyrequired	string	1 to 256 characters · matches ^\S(?:[^\x00-\x1f\x7f]*\S)?$
valuerequired	any	Any JSON value. At most 32 KiB once serialised.
createdAtrequired	string, date-time
updatedAtrequired	string, date-time

datarequired
Type
object
Description
namespacerequired
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
keyrequired
Type
string
Description
1 to 256 characters · matches ^\S(?:[^\x00-\x1f\x7f]*\S)?$
valuerequired
Type
any
Description
Any JSON value. At most 32 KiB once serialised.
createdAtrequired
Type
string, date-time
Description
updatedAtrequired
Type
string, date-time
Description

Example

curl

curl -X POST https://api.rsx.group/state/v1/state/update \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "namespace": "roxy",
  "key": "guild:123456789",
  "value": null
}'

200 response

{
  "data": {
    "namespace": "roxy",
    "key": "guild:123456789",
    "value": null,
    "createdAt": "2026-09-01T14:30:00.000Z",
    "updatedAt": "2026-09-01T14:30:00.000Z"
  }
}

POST/state/v1/state/remove

Delete a persistent state value

Scope: state:state:remove Admin-issued keys only.

Request bodyapplication/json

Request body of removeState
Field	Type	Description
namespacerequired	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
keyrequired	string	1 to 256 characters · matches ^\S(?:[^\x00-\x1f\x7f]*\S)?$

namespacerequired
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
keyrequired
Type
string
Description
1 to 256 characters · matches ^\S(?:[^\x00-\x1f\x7f]*\S)?$

Response 200The entry that was removed

Response of removeState
Field	Type	Description
datarequired	object
namespacerequired	string
keyrequired	string

datarequired
Type
object
Description
namespacerequired
Type
string
Description
keyrequired
Type
string
Description

Example

curl

curl -X POST https://api.rsx.group/state/v1/state/remove \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "namespace": "roxy",
  "key": "guild:123456789"
}'

200 response

{
  "data": {
    "namespace": "string",
    "key": "string"
  }
}

audit

3 operations under /state/v1/audit.

POST/state/v1/audit/add

Record an audit event

Scope: state:audit:add Admin-issued keys only.
Idempotency: Requires an Idempotency-Key header. Reusing the key within 24 hours returns the original response instead of creating a second record.

Request bodyapplication/json

Request body of addAuditEvent
Field	Type	Description
sourcerequired	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
scope	string, or null	up to 256 characters
actor	string, or null	up to 256 characters
actionrequired	string	1 to 128 characters
target	string, or null	up to 256 characters
metadata	map of any, or null
{key}	any

sourcerequired
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
scope
Type
string, or null
Description
up to 256 characters
actor
Type
string, or null
Description
up to 256 characters
actionrequired
Type
string
Description
1 to 128 characters
target
Type
string, or null
Description
up to 256 characters
metadata
Type
map of any, or null
Description
{key}
Type
any
Description

Response 200The recorded event, with the timestamp this service assigned

Response of addAuditEvent
Field	Type	Description
datarequired	AuditEvent
idrequired	string
sourcerequired	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
scoperequired	string, or null
actorrequired	string, or null
actionrequired	string
targetrequired	string, or null
metadatarequired	map of any, or null
{key}	any
createdAtrequired	string, date-time

datarequired
Type
AuditEvent
Description
idrequired
Type
string
Description
sourcerequired
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
scoperequired
Type
string, or null
Description
actorrequired
Type
string, or null
Description
actionrequired
Type
string
Description
targetrequired
Type
string, or null
Description
metadatarequired
Type
map of any, or null
Description
{key}
Type
any
Description
createdAtrequired
Type
string, date-time
Description

Example

curl

curl -X POST https://api.rsx.group/state/v1/audit/add \
  -H "Authorization: Bearer rsx_live_..." \
  -H "Idempotency-Key: 5b8f2d1a-0c7e-4b1f-9a6d-3e2f1c0b9a8d" \
  -H "Content-Type: application/json" \
  -d '{
  "source": "roxy",
  "scope": "guild:123456789",
  "actor": "user:987654321",
  "action": "member.ban",
  "target": "user:456789123",
  "metadata": {
    "reason": "Spam"
  }
}'

200 response

{
  "data": {
    "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
    "source": "roxy",
    "scope": "guild:123456789",
    "actor": "user:987654321",
    "action": "member.ban",
    "target": "user:456789123",
    "metadata": {
      "reason": "Spam"
    },
    "createdAt": "2026-09-01T14:30:00.000Z"
  }
}

GET/state/v1/audit/list

Query audit events, newest first

Scope: state:audit:list Admin-issued keys only.

Query parameters

Query parameters of listAuditEvents
Parameter	Type	Description
source	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
scope	string	up to 256 characters
actor	string	up to 256 characters
action	string	up to 128 characters
target	string	up to 256 characters
before	string, date-time
after	string, date-time
cursor	string
limit	integer	1 to 100 · default 20

source
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
scope
Type
string
Description
up to 256 characters
actor
Type
string
Description
up to 256 characters
action
Type
string
Description
up to 128 characters
target
Type
string
Description
up to 256 characters
before
Type
string, date-time
Description
after
Type
string, date-time
Description
cursor
Type
string
Description
limit
Type
integer
Description
1 to 100 · default 20

Response 200Audit events, newest first

Response of listAuditEvents
Field	Type	Description
datarequired	array of AuditEvent
idrequired	string
sourcerequired	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
scoperequired	string, or null
actorrequired	string, or null
actionrequired	string
targetrequired	string, or null
metadatarequired	map of any, or null
{key}	any
createdAtrequired	string, date-time
metarequired	object
cursorrequired	string, or null

datarequired
Type
array of AuditEvent
Description
idrequired
Type
string
Description
sourcerequired
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
scoperequired
Type
string, or null
Description
actorrequired
Type
string, or null
Description
actionrequired
Type
string
Description
targetrequired
Type
string, or null
Description
metadatarequired
Type
map of any, or null
Description
{key}
Type
any
Description
createdAtrequired
Type
string, date-time
Description
metarequired
Type
object
Description
cursorrequired
Type
string, or null
Description

Example

curl

curl "https://api.rsx.group/state/v1/audit/list" \
  -H "Authorization: Bearer rsx_live_..."

200 response

{
  "data": [
    {
      "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
      "source": "roxy",
      "scope": "guild:123456789",
      "actor": "user:987654321",
      "action": "member.ban",
      "target": "user:456789123",
      "metadata": {
        "reason": "Spam"
      },
      "createdAt": "2026-09-01T14:30:00.000Z"
    }
  ],
  "meta": {
    "cursor": "string"
  }
}

GET/state/v1/audit/get

Read one audit event

Scope: state:audit:get Admin-issued keys only.

Query parameters

Query parameters of getAuditEvent
Parameter	Type	Description
idrequired	string	1 to 64 characters

idrequired
Type
string
Description
1 to 64 characters

Response 200The audit event

Response of getAuditEvent
Field	Type	Description
datarequired	AuditEvent
idrequired	string
sourcerequired	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
scoperequired	string, or null
actorrequired	string, or null
actionrequired	string
targetrequired	string, or null
metadatarequired	map of any, or null
{key}	any
createdAtrequired	string, date-time

datarequired
Type
AuditEvent
Description
idrequired
Type
string
Description
sourcerequired
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
scoperequired
Type
string, or null
Description
actorrequired
Type
string, or null
Description
actionrequired
Type
string
Description
targetrequired
Type
string, or null
Description
metadatarequired
Type
map of any, or null
Description
{key}
Type
any
Description
createdAtrequired
Type
string, date-time
Description

Example

curl

curl "https://api.rsx.group/state/v1/audit/get?id=string" \
  -H "Authorization: Bearer rsx_live_..."

200 response

{
  "data": {
    "id": "0198f2b1-6c2a-7c9e-9d3a-1e2f3a4b5c6d",
    "source": "roxy",
    "scope": "guild:123456789",
    "actor": "user:987654321",
    "action": "member.ban",
    "target": "user:456789123",
    "metadata": {
      "reason": "Spam"
    },
    "createdAt": "2026-09-01T14:30:00.000Z"
  }
}

Schemas

Every named shape in this reference, as the operations above refer to it.

AuditEvent

AuditEvent
Field	Type	Description
idrequired	string
sourcerequired	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
scoperequired	string, or null
actorrequired	string, or null
actionrequired	string
targetrequired	string, or null
metadatarequired	map of any, or null
{key}	any
createdAtrequired	string, date-time

idrequired
Type
string
Description
sourcerequired
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
scoperequired
Type
string, or null
Description
actorrequired
Type
string, or null
Description
actionrequired
Type
string
Description
targetrequired
Type
string, or null
Description
metadatarequired
Type
map of any, or null
Description
{key}
Type
any
Description
createdAtrequired
Type
string, date-time
Description

StateEntry

StateEntry
Field	Type	Description
namespacerequired	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
keyrequired	string	1 to 256 characters · matches ^\S(?:[^\x00-\x1f\x7f]*\S)?$
valuerequired	any	Any JSON value. At most 32 KiB once serialised.
createdAtrequired	string, date-time
updatedAtrequired	string, date-time

namespacerequired
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
keyrequired
Type
string
Description
1 to 256 characters · matches ^\S(?:[^\x00-\x1f\x7f]*\S)?$
valuerequired
Type
any
Description
Any JSON value. At most 32 KiB once serialised.
createdAtrequired
Type
string, date-time
Description
updatedAtrequired
Type
string, date-time
Description

StateOwner

StateOwner
Field	Type	Description
kindrequired	string	one of "namespace", "source"
namerequired	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
apiKeyIdrequired	string
claimedAtrequired	string, date-time

kindrequired
Type
string
Description
one of "namespace", "source"
namerequired
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
apiKeyIdrequired
Type
string
Description
claimedAtrequired
Type
string, date-time
Description

UpdateStateOwner

UpdateStateOwner
Field	Type	Description
kindrequired	string	one of "namespace", "source"
namerequired	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
apiKeyIdrequired	string	1 to 128 characters

kindrequired
Type
string
Description
one of "namespace", "source"
namerequired
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
apiKeyIdrequired
Type
string
Description
1 to 128 characters

UpdateState

UpdateState
Field	Type	Description
namespacerequired	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
keyrequired	string	1 to 256 characters · matches ^\S(?:[^\x00-\x1f\x7f]*\S)?$
valuerequired	any	Any JSON value. At most 32 KiB once serialised.

namespacerequired
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
keyrequired
Type
string
Description
1 to 256 characters · matches ^\S(?:[^\x00-\x1f\x7f]*\S)?$
valuerequired
Type
any
Description
Any JSON value. At most 32 KiB once serialised.

RemoveState

RemoveState
Field	Type	Description
namespacerequired	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
keyrequired	string	1 to 256 characters · matches ^\S(?:[^\x00-\x1f\x7f]*\S)?$

namespacerequired
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
keyrequired
Type
string
Description
1 to 256 characters · matches ^\S(?:[^\x00-\x1f\x7f]*\S)?$

AddAuditEvent

AddAuditEvent
Field	Type	Description
sourcerequired	string	1 to 64 characters · matches ^[a-z][a-z0-9-](:[a-z0-9-]+)$
scope	string, or null	up to 256 characters
actor	string, or null	up to 256 characters
actionrequired	string	1 to 128 characters
target	string, or null	up to 256 characters
metadata	map of any, or null
{key}	any

sourcerequired
Type
string
Description
1 to 64 characters · matches ^[a-z][a-z0-9-]*(:[a-z0-9-]+)*$
scope
Type
string, or null
Description
up to 256 characters
actor
Type
string, or null
Description
up to 256 characters
actionrequired
Type
string
Description
1 to 128 characters
target
Type
string, or null
Description
up to 256 characters
metadata
Type
map of any, or null
Description
{key}
Type
any
Description