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 >'
REST API versioning is maintained in Stratos. The default API version will always point to the latest REST API version.
- If you wish to use a specific Stratos REST API version, add the version in the HTTP request after
/api/as follows:
For example:curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin <STRATOS_HOST>:9443/api/<REST_API_VERSION>/application/<APP_ID>curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://175.41.153.66:9443/api/v4.1/application/test_app_3
- If you wish to use the default REST API version, do not add a REST API version.
For example:curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://175.41.153.66:9443/api/application/test_app_3
| Operation Type | URL | Description |
|---|---|---|
| Tenant operations | 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 operations | Deploy a partition | |
| List all the partitions | ||
| Auto-scaling policy operations | Deploy an auto-scaling policy definition | |
| List the auto-scaling policies | ||
Deployment policy operations | Deploy a deployment policy definition | |
| List deployment policies | ||
| Multi-tenant service cluster deployment | Deploy a multi-tenant service cluster | |
/service/definition/{service-type} | Undeploy a multi-tenant service cluster | |
| Cartridge operations | Deploy a cartridge definition | |
/cartridge/definition/{cartridge-type} | Undeploy a cartridge definition | |
/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 | |
Overview
Content Tools
Apps