Work In Progress!
These docs are still work in progress and will be made available soon!
The following sections illustrate the Stratos APIs that are used in version v4.1:
Operation | HTTP | Resource Path | Description | |
|---|---|---|---|---|
| Application | POST | /applications | Deploy an application. | |
GET | /applications | Retrieve list of applications. | ||
GET | /applications/{applicationId} | Retrieve details of a specific application. | ||
DELETE | /applications/{applicationId} | Undeploy an application. | ||
| Auto-scaling policy | POST | Deploy an auto-scaling policy. | ||
GET | /autoscalePolicies | Retrieve all auto-scaling policy details. | ||
PUT | /autoscalePolicies | Update an Auto-scaling policy. | ||
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/{filter}?criteria={event} | Retrieve details on all cartridges based on the filter. | ||
GET | /cartridges/{filter}/{cartridgeType} | Retrieve details of a specific cartridge based on the filter. | ||
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 | GET | Retrieve details on all the deployment policies. | ||
GET | /deploymentPolicies/{deploymentPolicyId} | Retrieve details of a specific deployment policy. | ||
GET | /deploymentPolicies/{deploymentPolicyId}/partitionGroup | Retrieve details of partition groups in a specific deployment policy. | ||
| Git repository | POST | Enable notifications to be received from the Git repository. | ||
POST | /repo/synchronize/{subscriptionAlias} | Manually synchronize the GIT repository for a subscription. | ||
| Kubernetes Hosts | POST | /kubernetesCluster | Deploy a Kubernetes-CoreOS group. | |
PUT | /kubernetesCluster/{kubernetesClusterId}/minion | Deploy a host (slave) to a Kubernetes-CoreOS group. | ||
PUT | /kubernetesCluster/{kubernetesClusterId}/master | Update the master node in a Kubernetes-CoreOS group. | ||
PUT | /kubernetes/update/host | Update the host node (slave node) in a Kubernetes-CoreOS group. | ||
GET | /kubernetesCluster | Retrieve detailed information on all Kubernetes-CoreOS groups. | ||
PUT | /kubernetesCluster/{kubernetesClusterId} | Retrieve detailed information on a specific Kubernetes-CoreOS group. | ||
GET | /kubernetesCluster/{kubernetesClusterId}/hosts | Retrieve detailed information on all the hosts (slave nodes) in a specific Kubernetes-CoreOS group. | ||
GET | /kubernetesCluster/{kubernetesClusterId}/master | Retrieve detailed information on the master node in a specific Kubernetes-CoreOS group. | ||
DELETE | /kubernetesCluster/{kubernetesClusterId} | Undeploy a Kubernetes-CoreOS group. | ||
DELETE | Undeploy a host in a Kubernetes-CoreOS group. | |||
| Login | GET | /init | Validate Stratos Manager URL in CLI. | |
GET | /session | Authenticate a session. | ||
| Service group | POST | /groups | Deploy a service group. | |
GET | Retrieve details of all the service groups that have been deployed. | |||
GET | /groups/{groupDefinitionName} | Retrieve details of a service group. | ||
DELETE | /groups/{groupDefinitionName} | Undeploy a service group. | ||
| Subscription | GET | /subscriptions/{applicationId} | List all subscriptions for an application. | |
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. | ||
PUT | /subscriptions/{subscriptionAlias}/properties | Update subscription properties. | ||
| Tenant | POST | Add a tenant. | ||
PUT | /tenants | Update a tenant. | ||
GET | List all the tenants. | |||
GET | /tenants/{tenantDomain} | Retrieve details on 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. | ||
| User | POST | /user | Add user. | |
PUT | /user | Update a user. | ||
GET | /user | List all users. | ||
DELETE | /users/{userName} | Delete a user. | ||
The corresponding methods for the above REST API resources can be viewed in the Apache Stratos Git repository in the following directory:
[stratos.git]/components/org.apache.stratos.rest.endpoint/src/main/java/org/apache/stratos/rest/endpoint/api/StratosApiV41.java Overview
Content Tools
Apps