You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 61 Next »

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:

Entity/Process

HTTP
Method

Resource PathDescription
Application
POST /applications Create an application.
GET /applications Retrieve list of applications.
GET /applications/{applicationId} Retrieve details of a specific application.
DELETE /applications/{applicationId} Delete an application.
Application Deployment
POST /applications/{applicationId}/deploy Deploy an application with a deployment policy.
POST /applications/{applicationId}/undeploy Undeploy an application.
GET /applications/{applicationId}/deploymentPolicy Retrieve the deployment policy of an application.
GET /applications/{applicationId}/runtime Retrieve the runtime topology of an application.
Auto-scaling policyPOST

/autoscalePolicies

Add an auto-scaling policy.
GET /autoscalePolicies Retrieve all auto-scaling policy details.
PUT /autoscalePolicies Update an Auto-scaling policy.
GET

/autoscalePolicies/{autoscalePolicyId}

Retrieve details of an auto-scaling policy.
Cartridge




POST

/cartridges

Create a cartridge.
GET /cartridges List all the available cartridges (single tenant and multi-tenant).
GET/cartridges/filter/{filter}?criteria={event} Retrieve details on all cartridges based on the filter.
GET /cartridges/filter/{filter}/{cartridgeType} Retrieve details of a specific cartridge based on the filter.
DELETE /cartridges/{cartridgeType} Undeploy a cartridge.
Cartridge GroupPOST /groups Create a cartridge group.
GET

/groups

Retrieve details of all the cartridge groups that have been deployed.
GET /groups/{groupDefinitionName} Retrieve details of a cartridge group.
DELETE /groups/{groupDefinitionName} Undeploy a cartridge group.
Cluster

GET /clusters List all the clusters.
GET /clusters/{cartridgeType} List all the available clusters for a cartridge.
GET /clusters/{clusterId} Retrieve details of a specific cluster.
Git repositoryPOST

/repo/notify

Enable notifications to be received from the Git repository.
POST /repo/synchronize/{subscriptionAlias} Manually synchronize the GIT repository for a subscription.
Kubernetes Cluster/HostsPOST /kubernetesCluster Deploy a Kubernetes-CoreOS group.
PUT /kubernetesClusters/{kubernetesClusterId}/minion Deploy a host (slave) to a Kubernetes-CoreOS group.
PUT /kubernetesClusters/{kubernetesClusterId}/master Update the master node in a Kubernetes-CoreOS group.
PATCH /kubernetesClusters/{kubernetesClusterId}/minion/{minionId} 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} Undeploy a Kubernetes-CoreOS group.
DELETE

/kubernetesClusters/{kubernetesClusterId}/hosts/{hostId}

Undeploy a host in a Kubernetes-CoreOS group.
LoginGET /init Validate Stratos Manager URL in CLI.
GET /session Authenticate a session.
Subscriptions  GET /subscriptions/{applicationId} Retrieve all subscriptions for an application.
 GET /subscriptions/cartridges/groups/{serviceGroupId} List of subscribed cartridges for a specific service group.
TenantPOST

/tenants

Add a tenant.
PUT /tenants Update a tenant.
GET

/tenants

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.
UserPOST /users Add user.
PUT /users Update a user.
GET /users Retrieve all user details
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  
  • No labels