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
- 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/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/versioning/{Uuid}
- POST /a/config/virtualnodes/{Uuid}
- PUT /a/config/directories/{ConfigId}
- PUT /a/config/oauth2clients/{ClientID}
- 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}
- GET /a/scheduler/templates/docs/{Type}
- POST /a/scheduler/templates/actions
- POST /a/scheduler/templates/jobs
- POST /a/scheduler/templates/playground
- POST /a/scheduler/templates/selectors
- PUT /a/scheduler/jobs
- PUT /a/scheduler/templates/actions
- PUT /a/scheduler/templates/jobs/{Name}
- PUT /a/scheduler/templates/selectors
- [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 clean
- cells admin clean activities
- cells admin clean logs
- cells admin config
- cells admin config delete
- cells admin config history
- cells admin config list
- cells admin config set
- cells admin datasource
- cells admin datasource migrate
- cells admin datasource resync
- cells admin datasource snapshot
- cells admin files
- cells admin files create-bench
- cells admin files ls
- cells admin files meta-put
- cells admin files meta-read
- cells admin resync
- 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 cluster
- cells cluster start
- cells configure
- cells configure db
- cells configure db add
- cells configure db list
- cells configure db set
- cells configure sites
- cells configure sites add
- cells configure sites delete
- cells ps
- cells start
- cells tools
- cells tools completion
- cells tools completion bash
- cells tools completion zsh
- cells tools import-config
- 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 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 clean
- cells-enterprise admin clean activities
- cells-enterprise admin clean logs
- cells-enterprise admin config
- 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 migrate
- cells-enterprise admin datasource resync
- cells-enterprise admin datasource snapshot
- cells-enterprise admin files
- cells-enterprise admin files create-bench
- cells-enterprise admin files ls
- cells-enterprise admin files meta-put
- cells-enterprise admin files meta-read
- cells-enterprise admin jobs
- cells-enterprise admin jobs tpl-docs
- cells-enterprise admin jobs unlock-public
- cells-enterprise admin license-stats
- cells-enterprise admin resync
- 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 cluster
- cells-enterprise cluster start
- cells-enterprise configure
- cells-enterprise configure db
- cells-enterprise configure db add
- cells-enterprise configure db list
- cells-enterprise configure db set
- cells-enterprise configure license
- cells-enterprise configure sites
- cells-enterprise configure sites add
- cells-enterprise configure sites delete
- cells-enterprise ps
- cells-enterprise start
- cells-enterprise tools
- cells-enterprise tools completion
- cells-enterprise tools completion bash
- cells-enterprise tools completion zsh
- cells-enterprise tools find-duplicate
- cells-enterprise tools import-config
- cells-enterprise tools shard-personal
- 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: