Skip to content

Reconcile the project's entities to a declared full state

POST
/api/v2026-01/projects/entities/reconcile
curl --request POST \
--url https://api.zstrike.io/api/v2026-01/projects/entities/reconcile \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-op-id: example' \
--header 'x-session-id: example' \
--data '{ "scope": { "entityTypes": [ "example" ] }, "entities": [ { "uid": "User::\"alice\"", "attrs": {}, "parents": [ { "type": "example", "id": "example" } ] } ], "confirmEmpty": true, "projectId": "example" }'

The payload is the complete desired entity set (optionally scoped to entityTypes). The server diffs against current entities: new uids are created, changed ones overwritten, absent ones deleted. Requires entities write + delete grants. Empty entity sets require confirmEmpty: true.

x-op-id
required
string

Operation ID

x-session-id
required
string

Session ID

Media typeapplication/json
object
scope
object
entityTypes
required
Array<string>
>= 1 items
entities
required
Array<object>
object
uid
required
One of:
string

Example

User::"alice"
attrs
object
key
additional properties
any
parents
Array<object>
object
type
required
string
id
required
string
confirmEmpty

Required to be true when entities is empty

boolean
projectId

Required for an org-wide token. Must match the scope of a project-scoped token.

string

Success

Media typeapplication/json
object
code
string
description
string
success
boolean
data
object
timestamp
string format: date-time

Example

{
"code": "S200",
"description": "Operation Successful",
"success": true,
"data": {
"key": "value"
}
}

Bad Request

Media typeapplication/json
object
code
string
description
string
success
boolean
errors
Array<string>
op_id
string
timestamp
string format: date-time

Example

{
"code": "E400",
"description": "Bad Request",
"success": false,
"errors": [
"Error Message 1",
"Error Message 2"
],
"op_id": "op_example"
}

Unauthorized

Media typeapplication/json
object
code
string
description
string
success
boolean
errors
Array<string>
op_id
string
timestamp
string format: date-time

Example

{
"code": "E401",
"description": "Unauthorized",
"success": false,
"errors": [
"Unauthorized"
],
"op_id": "op_example"
}

Forbidden

Media typeapplication/json
object
code
string
description
string
success
boolean
errors
Array<string>
op_id
string
timestamp
string format: date-time

Example

{
"code": "E403",
"description": "Forbidden",
"success": false,
"errors": [
"Forbidden"
],
"op_id": "op_example"
}

Not Found

Media typeapplication/json
object
code
string
description
string
success
boolean
errors
Array<string>
op_id
string
timestamp
string format: date-time

Example

{
"code": "E404",
"description": "Not Found",
"success": false,
"errors": [
"Not Found"
],
"op_id": "op_example"
}

Internal Server Error

Media typeapplication/json
object
code
string
description
string
success
boolean
errors
Array<string>
op_id
string
timestamp
string format: date-time

Example

{
"code": "E500",
"description": "Internal Server Error",
"success": false,
"errors": [
"Internal Server Error"
]
}