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-test.json >'
| Entity | HTTP | Resource Path | Description |
|---|---|---|---|
| Application | /application/definition | Deploy an application. | |
/application/definition/<APP_ID> | Undeploy an application. | ||
| Auto-scaling policy | POST | Deploy an auto-scaling policy. | |
GET | /autoscalePolicies | Retrieve all auto-scaling policy details. | |
GET | Retrieve details of an auto-scaling policy. | ||
| Cartridge | POST | Deploy a cartridge. | |
GET | /cartridges | List all the available cartridges (single tenant and multi-tenant). | |
GET | /cartridges/singleTenant | List all the available single tenant cartridges. | |
GET | /cartridges/{cartridgeType}/singleTenant | Retrieve available single tenant cartridge details. | |
GET | /cartridges/multiTenant | List all the available multi-tenant cartridges. | |
GET | /cartridges/loadBalancer | Retrieve the list of available load balancer cartridges. | |
GET | Retrieve details on all the deployment policies that have been defined in a specific cartridge. | ||
DELETE | /cartridges/{cartridgeType} | Undeploy a cartridge. | |
| Cluster | GET | /clusters | List all the clusters. |
GET | /clusters/{cartridgeType} | List all the available clusters for a cartridge. | |
GET | /clusters/{subscriptionAlias} | Retrieve the cluster details for a specific subscription. | |
GET | /clusters/{clusterId} | Retrieve details of a specific cluster. | |
GET | /clusters/{subscriptionAlias}/loadBalancer | Retrieve details of a Load Balancer cluster for a specific subscription. | |
Deployment policy | POST | Deploy a deployment policy. | |
PUT | Update a deployment policy. | ||
GET | Retrieve details on all the deployment policies. | ||
GET | /deploymentPolicies/{deploymentPolicyId} | Retrieve details of a specific deployment policy. | |
| GitHub | Set a Webhook in GitHub. | ||
/cartridge/sync | Synchronize the GIT repository for subscribed cartridges. | ||
| Partition
| POST | Deploy a partition. | |
GET | Retrieve details on all the partitions. | ||
GET | /partitions/{partitionId} | Retrieve the details of a partition. | |
| Partition group | GET | /deploymentPolicies/{deploymentPolicyId}/partition | Retrieve details of partitions in a specific deployment policy. |
GET | /deploymentPolicies/{deploymentPolicyId}/partitionGroup | Retrieve details of partition groups in a specific deployment policy. | |
GET | /deploymentPolicies/{deploymentPolicyId}/partitionGroup/{partitionGroupId} | Retrieve details on a specific partition group that has been defined in a deployment policy. | |
| 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. | ||
| Subscription | GET | /subscriptions/cartridges | Retrieve list of all subscribed cartridges. |
GET | /subscriptions/cartridges/groups/{serviceGroup} | List of subscribed cartridges for a specific service group. | |
GET | /subscriptions/{subscriptionAlias}/cartridges | Retrieve details on a specific subscribed cartridge. | |
GET | /subscriptions/{subscriptionAlias}/cartridges/{cartridgeType}/active | Retrieve the active member count of a subscribed cartridge. | |
POST | Add subscription domains. | ||
GET | /subscriptions/{subscriptionAlias}/domains | Retrieve details on subscription domains. | |
GET | /subscriptions/{subscriptionAlias}/domains/{domainName} | Retrieve details on a subscription domain. | |
DELETE | /subscriptions/{subscriptionAlias}/domains/{domainName} | Remove a subscription domain. | |
| Tenant | POST | Add a tenant. | |
PUT | /tenants | Update a tenant. | |
GET | List all the tenants. | ||
GET | /tenants/{tenantDomain} | Retrieve details of a tenant. | |
DELETE | /tenants/{tenantDomain} | Delete a tenant. | |
POST | tenants/activate/{tenantDomain} | Activate a tenant. | |
POST | /tenants/deactivate/{tenantDomain} | Deactivate a tenant. | |
GET | /tenants/search/{tenantDomain} | Search for tenants. | |
GET | /tenants/availability/{tenantDomain} | Check tenant domain availability. | |
| User | POST | /user | Add user. |
PUT | /user | Update user. | |
GET | /user | List users. | |
DELETE | /user/<USERNAME> | Delete user. | |
Overview
Content Tools
Apps