Work In Progress!
These docs are still work in progress and will be made available soon!
The following sections illustrate the REST APIs that are used in Apache Stratos:
It is recommended to save the request in a separate file. Thereafter, the path of the request file should be referred to in the REST API command.
For example:
-d @'<PATH-TO-deploymentpolicy.json >'
| Operation Type | Resource Path | Description |
|---|---|---|
| Tenant | Add a tenant | |
/tenant | Update a tenant | |
/tenant/activate/<TENANT_DOMAIN> | Activate a tenant | |
/tenant/deactivate/<TENANT_DOMAIN> | Deactivate a tenant | |
/tenant/<TENANT_DOMAIN> | Retrieve tenant details | |
/tenant/search/<TENANT_DOMAIN> | Search for tenants | |
| List all the tenants | ||
/tenant/<TENANT_DOMAIN> | Delete a tenant | |
| Partition | Deploy a partition | |
| List all the partitions | ||
| Auto-scaling policy | Deploy an auto-scaling policy | |
| List the auto-scaling policies | ||
Deployment policy | Deploy a deployment policy | |
| List deployment policies | ||
| Multi-tenant service cluster | Deploy a multi-tenant service cluster | |
/service/definition/{service-type} | Undeploy a multi-tenant service cluster | |
| Cartridge | Deploy a cartridge | |
/cartridge/definition/{cartridge-type} | Undeploy a cartridge | |
/cartridge/list | List all the available cartridges (single tenant and multi-tenant) | |
/cartridge/list/subscribed | List all the subscribed cartridges | |
/cartridge/info/{cartridge-alias} | Used to retrieve information on a cartridge that is already subscribed to by a user | |
/cluster/clusterId/{cluster-id} | Retrieve cluster details of a specific cluster | |
/cartridge/sync | Synchronize the GIT repository for subscribed cartridges | |
| Service group | /group/definition | Deploy a service group |
/group/definition/<GROUP_NAME> | Update a service group | |
/group/definition/<GROUP_NAME> | Undeploy a service group | |
| Application | /application/definition | Deploy an application |
/application/definition/<APP_ID> | Undeploy an application | |
Overview
Content Tools
Apps