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
- 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/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
- 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}
- POST /a/scheduler/templates/actions
- POST /a/scheduler/templates/jobs
- 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
- Command line reference
- Cells Binary
- cells
- cells acl
- cells acl create
- cells acl delete
- cells acl patch-recycle-personal
- cells acl search
- cells completion
- cells completion bash
- cells completion zsh
- cells config
- cells config db
- cells config db add
- cells config db list
- cells config db set
- cells config delete
- cells config list
- cells config proxy
- cells config proxy tls
- cells config proxy url
- cells config set
- cells config versions
- cells data
- cells data sync
- cells doc
- cells doc commands
- cells doc deps
- cells doc i18n
- cells doc i18n count
- cells doc openapi
- cells install
- cells meta
- cells meta put
- cells meta read
- cells ps
- cells start
- cells stop
- cells update
- cells user
- cells user create
- cells user delete
- cells user search
- cells user set-profile
- cells user set-pwd
- cells user unlock
- cells version
- Cells Client (cec)
- cec
- cec clear
- cec completion
- cec completion bash
- cec completion zsh
- cec configure
- cec configure client-auth
- cec configure oauth
- cec cp
- cec doc
- cec idm
- cec idm list-groups
- cec idm list-roles
- cec idm list-users
- cec idm list-workspaces
- cec ls
- cec mkdir
- cec mv
- cec rm
- cec scp
- 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 acl
- cells-enterprise acl create
- cells-enterprise acl delete
- cells-enterprise acl patch-recycle-personal
- cells-enterprise acl search
- cells-enterprise clean-recycle
- cells-enterprise completion
- cells-enterprise completion bash
- cells-enterprise completion zsh
- cells-enterprise config
- cells-enterprise config db
- cells-enterprise config db add
- cells-enterprise config db list
- cells-enterprise config db set
- cells-enterprise config delete
- cells-enterprise config list
- cells-enterprise config proxy
- cells-enterprise config proxy tls
- cells-enterprise config proxy url
- cells-enterprise config set
- cells-enterprise config versions
- cells-enterprise data
- cells-enterprise data sync
- cells-enterprise dl-meta
- cells-enterprise doc
- cells-enterprise doc commands
- cells-enterprise doc deps
- cells-enterprise doc i18n
- cells-enterprise doc i18n count
- cells-enterprise doc openapi
- cells-enterprise install
- cells-enterprise meta
- cells-enterprise meta put
- cells-enterprise meta read
- cells-enterprise ps
- cells-enterprise start
- cells-enterprise stop
- cells-enterprise update
- cells-enterprise user
- cells-enterprise user create
- cells-enterprise user delete
- cells-enterprise user search
- cells-enterprise user set-profile
- cells-enterprise user set-pwd
- cells-enterprise user unlock
- cells-enterprise version
- Cells Binary
- Supported SDKs
- 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: