Developer Guide

Cells Developer Guide provides technical documentation to programmatically interact with a Cells instance, from the REST APIs to the various command line tools that come with the product. An overview of Cells internals is also provided as a start to expand the code.

• Introduction
  • Main APIs presentation
  • Authentication
  • Consumers Examples
    • Using Postman
    • Using cURL
  • Other APIs
• Clients / SDKs
  • Cells Client
  • Cells SDK for Go
  • Cells SDK for JavaScript
  • Cells SDK for Java
• Rest API
  • ACL Service
    • POST /a/acl
    • POST /a/acl/bulk/delete
    • PUT /a/acl
  • Activity Service
    • POST /a/activity/stream
    • POST /a/activity/subscribe
    • POST /a/activity/subscriptions
  • Admin Tree Service
    • POST /a/tree/admin/list
    • POST /a/tree/admin/stat
  • [Enterprise] Audit Service
    • GET /a/audit/data/reports
    • POST /a/audit/data/shares
  • Config Service
    • DELETE /a/config/datasource/{Name}
    • GET /a/config/ctl
    • GET /a/config/datasource
    • GET /a/config/datasource/{Name}
    • GET /a/config/discovery
    • GET /a/config/discovery/forms/{ServiceName}
    • GET /a/config/discovery/openapi
    • GET /a/config/peers
    • GET /a/config/scheduler/actions
    • GET /a/config/scheduler/actions/{ActionName}
    • GET /a/config/sites/{Filter}
    • GET /a/config/versioning
    • GET /a/config/versioning/{Uuid}
    • GET /a/config/virtualnodes
    • GET /a/config/{FullPath}
    • POST /a/config/buckets
    • POST /a/config/ctl
    • POST /a/config/datasource/{Name}
    • POST /a/config/encryption/create
    • POST /a/config/encryption/delete
    • POST /a/config/encryption/export
    • POST /a/config/encryption/list
    • POST /a/config/peers/{PeerAddress}
    • POST /a/config/processes
    • POST /a/config/registry
    • PUT /a/config/buckets/{BucketName}
    • PUT /a/config/encryption/import
    • PUT /a/config/peers/{PeerAddress}
    • PUT /a/config/{FullPath}
  • [Enterprise] Config Service
    • DELETE /a/config/directories/{ConfigId}
    • DELETE /a/config/oauth2clients/{ClientID}
    • DELETE /a/config/oauth2clients/{client_id}
    • DELETE /a/config/oauth2connectors/{id}
    • DELETE /a/config/versioning/{Uuid}
    • DELETE /a/config/virtualnodes/{Uuid}
    • GET /a/config/directories
    • GET /a/config/oauth2clients
    • GET /a/config/oauth2connectors
    • GET /a/config/sites
    • POST /a/config/directories-test/ping
    • POST /a/config/directories-test/search
    • POST /a/config/versioning/{Uuid}
    • POST /a/config/virtualnodes/{Uuid}
    • PUT /a/config/directories/{ConfigId}
    • PUT /a/config/oauth2clients/{ClientID}
    • PUT /a/config/oauth2clients/{client_id}
    • PUT /a/config/oauth2connectors
    • PUT /a/config/oauth2connectors/{id}
  • [Enterprise] Front Service
    • GET /a/frontend/auth/state
    • GET /a/frontend/login/connectors
  • [Enterprise] Log Service
    • POST /a/log/audit
    • POST /a/log/audit/chartdata
    • POST /a/log/audit/export
    • POST /a/log/sys/export
  • [Enterprise] Policy Service
    • DELETE /a/policy/{Uuid}
    • GET /a/policy/ipbans
    • GET /a/policy/iplists/{Name}
    • POST /a/policy/ipbans
    • POST /a/policy/iplists
    • PUT /a/policy
  • [Enterprise] Templates Service
    • DELETE /a/templates/meta/{TemplateUuid}
    • DELETE /a/templates/node/{TemplateUuid}
    • GET /a/templates/meta
    • POST /a/templates/node
    • PUT /a/templates/meta
  • [Enterprise] Token Service
    • DELETE /a/auth/tokens/{TokenId}
    • POST /a/auth/token/impersonate
    • POST /a/auth/token/personal
    • POST /a/auth/tokens
  • Frontend Service
    • GET /a/frontend/binaries/{BinaryType}/{Uuid}
    • GET /a/frontend/bootconf
    • GET /a/frontend/messages/{Lang}
    • GET /a/frontend/plugins/{Lang}
    • GET /a/frontend/settings-menu
    • GET /a/frontend/state
    • POST /a/frontend/binaries/{BinaryType}/{Uuid}
    • POST /a/frontend/enroll
    • POST /a/frontend/session
  • Graph Service
    • GET /a/graph/relation/{UserId}
    • GET /a/graph/state/{Segment}
    • POST /a/graph/recommend
  • Install Service
    • GET /a/install
    • GET /a/install/agreement
    • GET /a/install/events
    • POST /a/install
    • POST /a/install/check
  • Jobs Service
    • POST /a/jobs/tasks/delete
    • POST /a/jobs/tasks/logs
    • POST /a/jobs/user
    • PUT /a/jobs/user
    • PUT /a/jobs/user/{JobName}
  • [Enterprise] License Service
    • GET /a/license/stats
    • PUT /a/license/update
  • Log Service
    • POST /a/log/sys
  • Mailer Service
    • POST /a/mailer/send
  • Meta Service
    • POST /a/meta/bulk/get
    • POST /a/meta/delete/{NodePath}
    • POST /a/meta/get/{NodePath}
    • POST /a/meta/set/{NodePath}
  • Policy Service
    • POST /a/policy
  • Role Service
    • DELETE /a/role/{Uuid}
    • GET /a/role/{Uuid}
    • POST /a/role
    • PUT /a/role/{Uuid}
  • [Enterprise] Scheduler Service
    • DELETE /a/scheduler/jobs/{JobID}
    • DELETE /a/scheduler/templates/actions/{TemplateName}
    • DELETE /a/scheduler/templates/jobs/{Name}
    • DELETE /a/scheduler/templates/selectors/{TemplateName}
    • DELETE /a/scheduler/versions/{JobID}/{VersionID}
    • GET /a/scheduler/templates/docs/{Type}
    • PATCH /a/scheduler/versions/{JobID}/{VersionID}
    • POST /a/scheduler/hooks/{HookSlug}
    • POST /a/scheduler/templates/actions
    • POST /a/scheduler/templates/jobs
    • POST /a/scheduler/templates/playground
    • POST /a/scheduler/templates/selectors
    • POST /a/scheduler/versions/{JobID}
    • PUT /a/scheduler/jobs
    • PUT /a/scheduler/templates/actions
    • PUT /a/scheduler/templates/jobs/{Name}
    • PUT /a/scheduler/templates/selectors
  • Search Service
    • POST /a/search/nodes
  • Share Service
    • DELETE /a/share/cell/{Uuid}
    • DELETE /a/share/link/{Uuid}
    • GET /a/share/cell/{Uuid}
    • GET /a/share/link/{Uuid}
    • POST /a/share/resources
    • PUT /a/share/cell
    • PUT /a/share/link
    • PUT /a/share/policies
  • Templates Service
    • GET /a/templates
  • Token Service
    • POST /a/auth/reset-password
    • POST /a/auth/token/document
    • POST /a/auth/token/revoke
    • PUT /a/auth/reset-password-token/{UserLogin}
  • Tree Service
    • GET /a/tree/stat/{Node}
    • POST /a/tree/create
    • POST /a/tree/delete
    • POST /a/tree/restore
    • POST /a/tree/selection
    • POST /a/tree/stats
  • Update Service
    • PATCH /a/update/{TargetVersion}
    • POST /a/update
  • UserMeta Service
    • DELETE /a/user-meta/tags/{Namespace}/{Tags}
    • GET /a/user-meta/namespace
    • GET /a/user-meta/tags/{Namespace}
    • POST /a/user-meta/bookmarks
    • POST /a/user-meta/search
    • POST /a/user-meta/tags/{Namespace}
    • PUT /a/user-meta/namespace
    • PUT /a/user-meta/update
  • Users Service
    • DELETE /a/user/{Login}
    • GET /a/user/{Login}
    • POST /a/user
    • PUT /a/user/roles/{Login}
    • PUT /a/user/{Login}
  • Workspace Service
    • DELETE /a/workspace/{Slug}
    • POST /a/workspace
    • PUT /a/workspace/{Slug}
• Command line reference
  • Cells Binary
    • cells
    • cells admin
    • cells admin acl
    • cells admin acl create
    • cells admin acl delete
    • cells admin acl patch-recycle-personal
    • cells admin acl search
    • cells admin cert
    • cells admin cert import
    • cells admin clean
    • cells admin clean acls
    • cells admin clean activities
    • cells admin clean logs
    • cells admin clean reset-jobs
    • cells admin clean resync
    • cells admin config
    • cells admin config check
    • cells admin config copy
    • cells admin config db
    • cells admin config db add
    • cells admin config db list
    • cells admin config db move
    • cells admin config db set
    • cells admin config delete
    • cells admin config history
    • cells admin config list
    • cells admin config set
    • cells admin datasource
    • cells admin datasource capture
    • cells admin datasource migrate
    • cells admin datasource rehash
    • cells admin datasource resync
    • cells admin datasource rethumb
    • cells admin datasource snapshot
    • cells admin file
    • cells admin file create-bench
    • cells admin file ls
    • cells admin file meta-put
    • cells admin file meta-read
    • cells admin user
    • cells admin user create
    • cells admin user delete
    • cells admin user search
    • cells admin user set-profile
    • cells admin user set-pwd
    • cells admin user token
    • cells admin user unlock
    • cells configure
    • cells configure sites
    • cells configure sites add
    • cells configure sites delete
    • cells ctl
    • cells ctl service-level
    • cells start
    • cells update
    • cells version
  • Cells Client (cec)
    • cec
    • cec clear
    • cec completion
    • cec completion bash
    • cec completion zsh
    • cec config
    • cec config add
    • cec config add client-auth
    • cec config add oauth
    • cec config add token
    • cec config check-keyring
    • cec config ls
    • cec config rm
    • cec config use
    • cec cp
    • cec idm
    • cec idm list-acls
    • cec idm list-groups
    • cec idm list-roles
    • cec idm list-users
    • cec idm list-workspaces
    • cec info
    • cec ls
    • cec mkdir
    • cec mv
    • cec rm
    • cec scp
    • cec share
    • cec storage
    • cec storage list-datasources
    • cec storage resync-ds
    • cec update
    • cec version
  • Cells Sync
    • cells-sync
    • cells-sync autotest
    • cells-sync capture
    • cells-sync completion
    • cells-sync completion bash
    • cells-sync completion fish
    • cells-sync completion powershell
    • cells-sync completion zsh
    • cells-sync config
    • cells-sync config account
    • cells-sync config add
    • cells-sync config delete
    • cells-sync config edit
    • cells-sync doc
    • cells-sync service
    • cells-sync start
    • cells-sync systray
    • cells-sync version
    • cells-sync webview
  • Cells Enterprise
    • cells-enterprise
    • cells-enterprise admin
    • cells-enterprise admin acl
    • cells-enterprise admin acl create
    • cells-enterprise admin acl delete
    • cells-enterprise admin acl patch-recycle-personal
    • cells-enterprise admin acl search
    • cells-enterprise admin cert
    • cells-enterprise admin cert import
    • cells-enterprise admin clean
    • cells-enterprise admin clean acls
    • cells-enterprise admin clean activities
    • cells-enterprise admin clean logs
    • cells-enterprise admin clean reset-jobs
    • cells-enterprise admin clean resync
    • cells-enterprise admin config
    • cells-enterprise admin config check
    • cells-enterprise admin config copy
    • cells-enterprise admin config db
    • cells-enterprise admin config db add
    • cells-enterprise admin config db list
    • cells-enterprise admin config db move
    • cells-enterprise admin config db set
    • cells-enterprise admin config delete
    • cells-enterprise admin config history
    • cells-enterprise admin config list
    • cells-enterprise admin config set
    • cells-enterprise admin datasource
    • cells-enterprise admin datasource capture
    • cells-enterprise admin datasource migrate
    • cells-enterprise admin datasource rehash
    • cells-enterprise admin datasource resync
    • cells-enterprise admin datasource rethumb
    • cells-enterprise admin datasource snapshot
    • cells-enterprise admin file
    • cells-enterprise admin file create-bench
    • cells-enterprise admin file ls
    • cells-enterprise admin file meta-put
    • cells-enterprise admin file meta-read
    • cells-enterprise admin jobs
    • cells-enterprise admin jobs templates
    • cells-enterprise admin jobs unlock-public
    • cells-enterprise admin license
    • cells-enterprise admin license stats
    • cells-enterprise admin license update
    • cells-enterprise admin user
    • cells-enterprise admin user create
    • cells-enterprise admin user delete
    • cells-enterprise admin user search
    • cells-enterprise admin user set-profile
    • cells-enterprise admin user set-pwd
    • cells-enterprise admin user token
    • cells-enterprise admin user unlock
    • cells-enterprise configure
    • cells-enterprise configure sites
    • cells-enterprise configure sites add
    • cells-enterprise configure sites delete
    • cells-enterprise ctl
    • cells-enterprise ctl service-level
    • cells-enterprise start
    • cells-enterprise update
    • cells-enterprise version
• Cells Development
  • Developing on Cells
    • Setup dev environment
    • How to contribute
    • Vendoring
  • Microservices
    • Introduction
    • Discovery
    • Communication
    • Api gateway model
    • Architecture overview
  • Miscellaneous
    • Logging
    • Tracing
    • Javascript Frontend
  • Services categories
    • Identity managment
    • Broker
    • Data
    • Scheduler
    • Gateway
  • Security model
    • Role based security rules
    • Resource based security rules
  • Activity streams