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 4.1.0:
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 |
|---|---|---|
| User | /user | Add user. |
/user | Update user. | |
/user | List users. | |
/user/<USERNAME> | Delete user. | |
| 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. | |
| Retrieve details on all the partitions. | ||
partition/<DEPLOYMENT__POLICY_ID>/<PARTITION_GROUP_ID> | Retrieve details on a specific partition group that has been defined in a deployment policy. | |
| Auto-scaling policy | Deploy an auto-scaling policy. | |
| List the auto-scaling policies. | ||
Deployment policy | Deploy a deployment policy. | |
| List deployment policies. | ||
| Cartridge
| Deploy a cartridge. | |
/cartridges/<CARTRIDGE_TYPE> | Undeploy a cartridge. | |
/cartridge/info/<CARTRIDGE_ALIAS> | Retrieve information on a cartridge that is already subscribed to by a user. | |
| Retrieve details on all the deployment policies that have been defined in a specific cartridge. | ||
/cartridges/multiTenant | List all the available multi-tenant cartridges. | |
/cartridges/singleTenant | List all the available single tenant cartridges. | |
/cartridges | List all the available cartridges (single tenant and multi-tenant). | |
/cartridges/<CARTRIDGE_TYPE>/singleTenant | Retrieve available single tenant cartridge details. | |
/cartridges/loadBalancer | Retrieve the list of available load balancer cartridges. | |
| Cluster | /cluster/clusterId/<CLUSTER_ID> | Retrieve cluster details of a specific cluster. |
| GitHub | Set a Webhook in GitHub. | |
/cartridge/sync | Synchronize the GIT repository for subscribed cartridges. | |
| Service group | /group/definition | Deploy a service group. |
/group/definition/<GROUP_DEFINITION_NAME> | Listing details of a service group. | |
/group | Listing all service groups. | |
/group/definition/<GROUP_DEFINITION_NAME> | Undeploy a service group. | |
| Application | /application/definition | Deploy an application. |
/application/definition/<APP_ID> | Undeploy an application. | |
Overview
Content Tools
Apps