||
Skip to end of metadata
Go to start of metadata

The following sections illustrate the Private PaaS APIs that are used in version v4.1:

In the following table the processes have been arranged according to the sequence in which they are executed in WSO2 Private PaaS.

Entity/Process

HTTP
Method

Resource PathDescription
Tenant
POST

/tenants

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

/tenants

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.
Kubernetes Cluster/Host
POST /kubernetesCluster Add a Kubernetes-CoreOS group.
PUT /kubernetesClusters/{kubernetesClusterId}/minion Add a host (slave) to an existing Kubernetes-CoreOS cluster.
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

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

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.
Deployment policy
POST /deploymentPolicies Add a deployment policy.
PUT /deploymentPolicies Update a deployment policy.

GET

/deploymentPolicies

Retrieve details of all the deployment policies.

GET

/deploymentPolicies/{deploymentPolicyId}

Retrieve details of a specific deployment policy.
DELETE /deploymentPolicies/{deploymentPolicyId} Delete a deployment policy.
Auto-scaling policy
POST

/autoscalingPolicies

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

/autoscalingPolicies/{autoscalingPolicyId}

Retrieve details of a specific auto-scaling policy.
DELETE /autoscalingPolicies/{autoscalingPolicyId}   Delete an auto-scaling policy.
Cartridge
POST

/cartridges

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.
DELETE /cartridges/{cartridgeType} Undeploy a cartridge.
Cartridge group
POST /cartridgeGroups Add a cartridge group.
PUT/cartridgeGroups Update a cartridge group.
GET

/cartridgeGroups

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.
Application policy
POST/applicationPolicies Add an application policy definition.
PUT/applicationPolicies Update an application policy definition.

GET

/applicationPolicies

Retrieve details of application policies.

GET

/applicationPolicies/{applicationPolicyId}

Retrieve details of a specific application policy.
DELETE /applicationPolicies/{applicationPolicyId}     Delete an application policy.
Application
POST /applications Add an application definition.
PUT /applicationsUpdate 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.
POST /applications/{applicationId}/undeploy?force=true Forceful termination of an application.
GET /applications/{applicationId}/runtime Retrieve the runtime topology of an application.
Application sign up
POST /applications/{applicationId}/signupSign up to a multi-tenant application.
GET /applications/{applicationId}/signup Retrieve sign up details of a specific application.
DELETE

/applications/{applicationId}/signup

Delete sign up details that correspond to a specific application.
Domain Mapping
POST /applications/{applicationId}/domainMappings Add one or more domain mappings for a cluster.
GET /applications/{applicationId}/domainMappingsRetrieve domain mapping details of a cluster.
DELETE /applications/{applicationId}/domainMappings Delete the domain mappings of a cluster.
Git repository
POST

/repo/notify

Enable notifications to be received from the Git repository.

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.
  • No labels