#Cells

---

#GET /{o}/{p}/cells

List cells

List placement cells defined in this project.

Auth: Bearer token required · Permission: catalog:read

Path parameters

Name	Type	Description
o	string
p	string

Responses

Status	Description	Schema
200	Cells	CellList

---

#POST /{o}/{p}/cells

Create a cell

Auth: Bearer token required · Permission: catalog:write

Path parameters

Name	Type	Description
o	string
p	string

Request body (application/json)

Field	Type	Description
kind	Cell	(required)
name	string	(required)
displayName	string
entityType	string	(required)
placementPolicy	least-loaded | round-robin | random
constraints	object[]
parentCells	string[]
membership	object

Responses

Status	Description	Schema
201	Created cell	Cell
400	Invalid derived-membership or parent-cell reference	Error
404	Parent cell not found	Error
409	Cell already exists	Error

---

#GET /{o}/{p}/cells/{name}

Get a cell by name

Auth: Bearer token required · Permission: catalog:read

Path parameters

Name	Type	Description
o	string
p	string
name	string

Responses

Status	Description	Schema
200	The cell	Cell
404	Cell not found	Error

---

#PUT /{o}/{p}/cells/{name}

Update a cell

Auth: Bearer token required · Permission: catalog:write

Path parameters

Name	Type	Description
o	string
p	string
name	string

Request body (application/json)

Field	Type	Description
kind	Cell	(required)
name	string	(required)
displayName	string
entityType	string	(required)
placementPolicy	least-loaded | round-robin | random
constraints	object[]
parentCells	string[]
membership	object

Responses

Status	Description	Schema
200	Updated cell	Cell
404	Cell not found	Error

---

#DELETE /{o}/{p}/cells/{name}

Delete a cell

Auth: Bearer token required · Permission: catalog:write

Path parameters

Name	Type	Description
o	string
p	string
name	string

Responses

Status	Description	Schema
200	Deletion result	Deleted
404	Cell not found	Error

---

#GET /{o}/{p}/cells/{name}/members

List effective cell members

List the entities that are members of this cell in the given environment (explicit or derived).

Auth: Bearer token required · Permission: catalog:read

Path parameters

Name	Type	Description
o	string
p	string
name	string

Responses

Status	Description	Schema
200	Member entities	EntityList
400	Environment not found	Error

---

#POST /{o}/{p}/cells/{name}/members

Add an explicit cell member

Add an entity to an explicit-membership cell. Derived cells reject direct writes (409).

Auth: Bearer token required · Permission: catalog:write

Path parameters

Name	Type	Description
o	string
p	string
name	string

Request body (application/json)

Field	Type	Description
entityName	string	(required)
entityTypeName	string	(required)
envId	string(uuid)
envName	string

Responses

Status	Description	Schema
201	Member added
400	Environment not found	Error
404	Entity not found	Error
409	Cell membership is derived	Error

---

#DELETE /{o}/{p}/cells/{name}/members/{entityName}

Remove an explicit cell member

Auth: Bearer token required · Permission: catalog:write

Path parameters

Name	Type	Description
o	string
p	string
name	string
entityName	string

Responses

Status	Description	Schema
200	Member removed
400	Environment not found	Error
409	Cell membership is derived	Error

---

#GET /{o}/{p}/cells/{name}/recommendations

Get placement recommendations for a cell

Rank the cell members by the cell placement policy to recommend a placement target.

Auth: Bearer token required · Permission: catalog:read

Path parameters

Name	Type	Description
o	string
p	string
name	string

Responses

Status	Description	Schema
200	Ranked placement recommendations
404	Cell not found	Error

#Schemas

#Cell

Field	Type	Description
name	string	(required)
displayName	string
placementPolicy	least-loaded | round-robin | random	(required)
constraints	object[]	(required)
parentCells	string[]	(required)
entityTypeName	string	(required)
membershipMode	explicit | derived	(required)
membershipDerivedFrom	object,null	(required)
orgId	string	(required)
projectId	string	(required)
createdAt	string | string	(required)
updatedAt	string | string	(required)

#CellList

Type: Cell[]

#Deleted

Field	Type	Description
deleted	true	(required)
name	string	(required)

#Entity

Field	Type	Description
id	string(uuid)	(required)
entityTypeName	string	(required)
name	string	(required)
state	string	(required)
properties	object	(required)
labels	object	(required)
lastSyncedAt	string | string | null	(required)
syncSource	string,null	(required)
createdAt	string | string	(required)
updatedAt	string | string	(required)
orgId	string	(required)
projectId	string	(required)
envId	string(uuid)	(required)

#EntityList

Type: Entity[]

#Error

Field	Type	Description
error	string	(required)
code	string