The following sections illustrate the Stratos APIs that are used in version v4.1:
Entity/Process | HTTP | Resource Path | Description |
|---|---|---|---|
| Application | POST | /applications | Add an application definition. |
GET | /applications | Retrieve all application details. | |
GET | /applications/{applicationId} | Retrieve details of a specific application. | |
DELETE | /applications/{applicationId} | Delete an application. | |
| Application deployment | POST | /applications/{applicationId}/deploy/{applicationPolicyId} | Deploy an application. |
POST | /applications/{applicationId}/undeploy | Undeploy an application. | |
GET | /applications/{applicationId}/runtime | Retrieve the runtime topology of an application. | |
| Application policy | POST | /applicationPolicies | Add an application policy definition. |
PUT | /applicationPolicies | Update an application policy definition. | |
| Retrieve details of application policies. | ||
| Retrieve details of a specific application policy. | ||
DELETE | /applicationPolicies/{applicationPolicyId} | Delete an application policy. | |
| Application sign up | POST | /applications/{applicationId}/signup | Sign up to a multi-tenant application. |
GET | /applications/{applicationId}/signup | Retrieve sign up details of a specific application. | |
DELETE | Delete sign up details that correspond to a specific application. | ||
| Auto-scaling policy | POST | Add an auto-scaling policy. | |
PUT | /autoscalingPolicies | Update an Auto-scaling policy. | |
GET | /autoscalingPolicies | Retrieve all auto-scaling policy details. | |
GET | Retrieve details of a specific auto-scaling policy. | ||
DELETE | /autoscalingPolicies/{autoscalingPolicyId} | Delete an auto-scaling policy. | |
| Cartridge | POST | Add a cartridge. | |
PUT | /cartridges | Update a cartridge. | |
GET | /cartridges | List all the available cartridges (single tenant and multi-tenant). | |
GET | /cartridges/{cartridgeType} | Retrieve details of a specific cartridge. | |
GET | /cartridges/filter/{filter}?criteria={value} | Retrieve details on all cartridges based on the filter. | |
DELETE | /cartridges/{cartridgeType} | Undeploy a cartridge. | |
| Cartridge group | POST | /cartridgeGroups | Add a cartridge group. |
GET | Retrieve details of all the cartridge groups that have been deployed. | ||
GET | /cartridgeGroups/{groupDefinitionName} | Retrieve details of a cartridge group. | |
DELETE | /cartridgeGroups/{groupDefinitionName} | Undeploy a cartridge group. | |
| Deployment policy
| POST | /deploymentPolicies | Add a deployment policy. |
PUT | /deploymentPolicies | Update a deployment policy. | |
| Retrieve details of all the deployment policies. | ||
| Retrieve details of a specific deployment policy. | ||
DELETE | /deploymentPolicies/{deploymentPolicyId} | Delete a deployment policy. | |
| Domain Mapping | POST | /applications/{applicationId}/domainMappings | Add one or more domain mappings for a cluster. |
GET | /applications/{applicationId}/domainMappings | Retrieve domain mapping details of a cluster. | |
DELETE | /applications/{applicationId}/domainMappings | Delete the domain mappings of a cluster. | |
| 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 Cluster/Hosts | POST | /kubernetesCluster | Add a Kubernetes-CoreOS group. |
PUT | /kubernetesClusters/{kubernetesClusterId}/minion | Add a host (slave) to a Kubernetes-CoreOS group. | |
PUT | /kubernetesClusters/{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 | /kubernetesClusters | Retrieve detailed information on all Kubernetes-CoreOS groups. | |
GET | /kubernetesClusters/{kubernetesClusterId} | Retrieve detailed information on a specific Kubernetes-CoreOS group. | |
GET | /kubernetesClusters/{kubernetesClusterId}/hosts | Retrieve detailed information on all the hosts (slave nodes) in a specific Kubernetes-CoreOS group. | |
GET | /kubernetesClusters/{kubernetesClusterId}/master | Retrieve detailed information on the master node in a specific Kubernetes-CoreOS group. | |
DELETE | /kubernetesClusters/{kubernetesClusterId} | Delete a Kubernetes-CoreOS group. | |
DELETE | Delete a host in a Kubernetes-CoreOS group. | ||
| Network partition | POST | /networkPartitions | Add a network partition. |
PUT | /networkPartitions | Update a specific network partition. | |
GET | /networkPartitions | Retrieve details of all the network partitions. | |
GET | /networkPartitions/{networkPartitionId} | Retrieve details of a specific network partition. | |
DELETE | /networkPartitions/{networkPartitionId} | Delete a specific network partition. | |
| Subscriptions | GET | /subscriptions/{applicationId} | Retrieve all subscriptions for an application. |
GET | /subscriptions/cartridges/groups/{serviceGroupId} | List of subscribed cartridges for a specific service group. | |
| Tenant | POST | Add a tenant. | |
PUT | /tenants | Update a tenant. | |
GET | Retrieving details of all the tenants. | ||
GET | /tenants/{tenantDomain} | Retrieve details on a tenant. | |
POST | /tenants/activate/{tenantDomain} | Activate a specific deactivated tenant. | |
POST | /tenants/deactivate/{tenantDomain} | Deactivate a specific activated tenant. | |
GET | /tenants/search/{tenantDomain} | Search for tenants. | |
| User | POST | /users | Add user. |
PUT | /users | Update a user. | |
GET | /users | Retrieve details of all the users. | |
DELETE | /users/{userName} | Delete a user. | |
| Basic Authentication | GET | /init | Validate Stratos Manager URL. |
GET | /session | Authenticate a client's session. | |
The corresponding methods for the above REST API resources can be viewed in the Apache Stratos Git repository in the
StratosApiV41.java file.Overview
Content Tools
Apps