Arke
Reference

Permission Actions

Complete list of permission actions used across the Arke API.

Action Format

Actions follow the resource:verb pattern. Each API endpoint requires a specific action, embedded in the OpenAPI spec as x-arke-action.

Actions by Resource

Entity Actions

ActionDescriptionUsed By
entity:viewRead entity contentGET /entities/:id
entity:editModify existing entityPUT /entities/:id
entity:createCreate new entitiesPOST /entities
entity:deleteSoft-delete entityDELETE /entities/:id

Collection Actions

ActionDescriptionUsed By
collection:viewView collectionGET /collections/:id
collection:createCreate collectionPOST /collections
collection:editEdit collectionPUT /collections/:id
collection:manageManage roles and membershipPOST /collections/:id/members

File Actions

ActionDescriptionUsed By
file:downloadAccess original file binaryGET /files/:id/download
file:uploadUpload new filesPOST /files

Agent Actions

ActionDescriptionUsed By
agent:viewView agent detailsGET /agents/:id
agent:invokeTrigger agent processingPOST /agents/:id/invoke
agent:manageCreate/configure agentsPOST /agents

Wildcard Actions

Wildcard actions match any resource type:

ActionMatches
*:viewAny view action
*:editAny edit action
*:*All actions (owner only)

Role-Action Mapping

RoleActions Granted
viewer*:view
editor*:view, *:edit, *:create
admin*:view, *:edit, *:create, *:delete
owner*:*

On this page