Block Source Graph

post/extensions/roboledger/{graph_id}/operations/block-source-graph

Part of RoboLedger: Report Distribution.

Bars a graph from sharing reports into this one. Subsequent share-report calls naming this graph fail for this target with an explicit error — blocked senders are told, not silently dropped. Idempotent: re-blocking preserves the original blocked_at. Set purge to also delete every report already shared in from that source, along with its fact sets and facts; reports this graph authored are never touched.

Idempotency: supply an Idempotency-Key header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.

Authentication

Authenticate in any one of these ways — not all of them:

API key in the X-API-Key header.
Bearer token in the Authorization header.

Path parameters

Name	Type	Description
`graph_id`required	string	Graph Id Constraints: matches `^(kg[a-f0-9]{16,}(?:_[a-zA-Z0-9]{1,20})?\|sec(?:_[a-zA-Z0-9]{1,20})?\|library)$`

Header parameters

Name	Type	Description
`Idempotency-Key`optional	string	Idempotency-Key

Request body

Required, application/json.

Field Type Description

Field	Type	Description
`source_graph_id`required	string	Graph ID to block. Read it off the `source_graph_id` provenance field of a report that was shared to you. Constraints: at most 64 characters
`reason`optional	string	Free-form note for your own records. Never disclosed to the sender. Constraints: at most 500 characters
`purge`optional	boolean	Also delete every report already shared in from this source, with their fact sets and facts. Reports you authored are never touched. Default: `false`

source_graph_idrequired

string

Graph ID to block. Read it off the source_graph_id provenance field of a report that was shared to you.

Constraints: at most 64 characters

reasonoptional

string

Free-form note for your own records. Never disclosed to the sender.

Constraints: at most 500 characters

purgeoptional

boolean

Also delete every report already shared in from this source, with their fact sets and facts. Reports you authored are never touched.

Default: false

Example request

curl · example 1 of 2

curl -X POST "https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/block-source-graph" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "source_graph_id": "kg1a2b3c4d5e6f7a8b9c"
}'

curl · example 2 of 2

curl -X POST "https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/block-source-graph" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "purge": true,
  "reason": "No longer a shareholder.",
  "source_graph_id": "kg1a2b3c4d5e6f7a8b9c"
}'

Responses

200 Successful Response

Field Type Description

operationrequired

string

Kebab-case operation name

operationIdrequired

string

op_-prefixed ULID for audit and SSE correlation

statusrequired

string

Operation lifecycle state

One of: completed, pending, failed

resultoptional

BlockSourceGraphResult

Command-specific result payload

BlockSourceGraphResult fields

Field Type Description

blockrequired

BlockedSourceGraphResponse

The block record.

BlockedSourceGraphResponse fields

Field	Type	Description
`id`required	string	Block row identifier (ULID).
`source_graph_id`required	string	The blocked sender's graph ID.
`source_graph_name`optional	string	Display name of the blocked graph (if known).
`blocked_by`required	string	User ID that created the block.
`blocked_at`required	string (date-time)	When the block was created.
`reason`optional	string	Recipient's own note, if given.

already_blockedoptional

boolean

True when the source was already blocked and this call was a no-op apart from any purge.

Default: false

purged_report_countoptional

integer

Number of previously-shared reports deleted from this graph. Zero unless purge was set.

Default: 0

purged_report_idsoptional

string[]

Ids of the previously-shared reports deleted from this graph. Empty unless purge was set.

atrequired

string

ISO-8601 UTC timestamp

createdByoptional

string

User ID that initiated the operation

idempotentReplayoptional

boolean

True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.

Default: false

Status	Meaning
400	Invalid request
401	Authentication required
403	Access denied
404	Resource not found
409	Idempotency-Key conflict — key reused with different body
422	Validation error
429	Rate limit exceeded
500	Internal server error