FruxonDocs
ApiIntegration config sandbox

Diff a sandbox snapshot against current live state or another snapshot.

Returns the per-entity classification (added/modified/removed) between two sandbox states for one config. With no `against` query parameter, diffs the snapshot against current live state — the "what has changed since this snapshot was taken" view. Pass another snapshot id to compare two saved states directly.

GET
/v1/tenants/{tenant}/integrations/{integration}/configs/{config}/sandbox/snapshots/{snapshot}/diff

Authorization

Bearer
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

config*string

The integration config id.

Formatuuid
snapshot*string

The base snapshot id.

Formatuuid
tenant*string

The tenant identifier

integration*string

The integration identifier

Query Parameters

against?string

Optional other snapshot id to diff against. Omit to diff against live state.

Formatuuid

Response Body

curl -X GET "https://api.fruxon.com/v1/tenants/string/integrations/string/configs/497f6eca-6276-4993-bfeb-53cbbbba6f08/sandbox/snapshots/497f6eca-6276-4993-bfeb-53cbbbba6f08/diff"
{
  "added": [
    {
      "entityType": "string",
      "scope": "string",
      "entityId": "string",
      "payload": "string"
    }
  ],
  "modified": [
    {
      "entityType": "string",
      "scope": "string",
      "entityId": "string",
      "payloadBefore": "string",
      "payloadAfter": "string"
    }
  ],
  "removed": [
    {
      "entityType": "string",
      "scope": "string",
      "entityId": "string",
      "payload": "string"
    }
  ]
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}