Read Bundle

POST /v1/tenants/{tenant_id}/bundle/read Returns the full definition of a named bundle, including its arguments and operations. Use this to inspect how a bundle is configured before running it.

Path Parameters

tenant_id

string

required

The tenant identifier. Use t1 for single-tenant deployments. Must match ^([a-zA-Z0-9_\-@\.:+]{1,128}|\*)$.

Request Body

name

string

required

The name of the bundle to retrieve.

Response

bundle

object

The bundle definition.

Show properties

name

string

The bundle name.

arguments

array

List of argument names the bundle accepts.

operations

array

List of operations the bundle performs, each containing optional relationships_write, relationships_delete, attributes_write, and attributes_delete arrays.

Example

curl --location --request POST 'localhost:3476/v1/tenants/{tenant_id}/bundle/read' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "organization_created"
}'

Request body

{
  "name": "organization_created"
}

Response

{
  "bundle": {
    "name": "organization_created",
    "arguments": ["creatorID", "organizationID"],
    "operations": [
      {
        "relationships_write": [
          "organization:{{.organizationID}}#admin@user:{{.creatorID}}",
          "organization:{{.organizationID}}#manager@user:{{.creatorID}}"
        ],
        "attributes_write": [
          "organization:{{.organizationID}}$public|boolean:false"
        ]
      }
    ]
  }
}

Error Codes

HTTP Status	Description
`400`	Bad request — missing bundle name
`401`	Unauthorized
`404`	Tenant or bundle not found
`429`	Rate limit exceeded
`500`	Internal server error

Introduction

Permission Service

Schema Service

Data Service

Tenancy & Bundle

Watch Service

Path Parameters

Request Body

Response

Example

Error Codes

Build docs developers (and LLMs) love

Introduction

Permission Service

Schema Service

Data Service

Tenancy & Bundle

Watch Service

​Path Parameters

​Request Body

​Response

​Example

​Error Codes

Build docs developers (and LLMs) love

Path Parameters

Request Body

Response

Example

Error Codes