API Documentation and Developer Guide
API's are first-class citizen in the Cells world and can be extremely useful to automate workflows and interact with your server. This document provides extensive description of the APIs, how to consume them, and also a brief introduction to the code internals for developing on Cells.
Transparent Background:
- Introduction
- Clients / SDKs
- Rest API
- ACL Service
- Activity Service
- Admin Tree Service
- 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}
- Frontend Service
- Graph Service
- Install Service
- Jobs Service
- Log Service
- Mailer Service
- Meta Service
- Policy Service
- Role Service
- Search Service
- Share Service
- Templates Service
- Token Service
- Tree Service
- Update Service
- UserMeta Service
- Users Service
- Workspace Service
- [Enterprise] Audit Service
- [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
- [Enterprise] License Service
- [Enterprise] Log Service
- [Enterprise] Policy Service
- [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
- [Enterprise] Templates Service
- [Enterprise] Token Service
- Command line reference
- Cells
- 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-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
- cec version isgreater
- cec version isrelease
- cec version isvalid
- Cells Sync
- cells-sync
- cells-sync add
- 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 delete
- cells-sync doc
- cells-sync edit
- 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 tpl-docs
- 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
- Cells Development
Help us improve this doc!
As the rest of our code, this documentation is open source and you can contribute to make it better. It is published under the Creative Common BY-SA 3 and you can find the source under our Github organization. The source is using Markdown and a specific page hierarchy to be then integrated in this website. Please submit Pull Requests to propose your changes to the community.
Transparent Background:
Transparent Background: