REST API Guide

The following sections illustrate the REST APIs that are used in Private PaaS:

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-deploymentpolicy.json>'

Operation Type	Description	URL
Tenant operations	Adding a tenant	`/admin/tenant`
Tenant operations	Listing all the tenants	`/admin/tenant/list`
Partition Operations	Deploying a partition	`/admin/policy/deployment/partition`
Partition Operations	Listing all the partitions	`/admin/partition`
Auto-scaling policy operations	Deploying an auto-scaling policy definition	`/admin/policy/autoscale`
Auto-scaling policy operations	Listing the auto-scaling policies	`/admin/policy/autoscale`
Deployment policy operations	Deploying a deployment policy definition	`/admin/policy/deployment`
Deployment policy operations	Listing deployment policies	`/admin/policy/deployment`
Multi-tenant service cluster deployment	Deploying a multi-tenant service cluster	`/admin/service/definition`
Multi-tenant service cluster deployment	Undeploying a multi-tenant service cluster	`admin/service/definition/<SERVICE_TYPE>`
Cartridge Operations	Deploying a cartridge definition	`/admin/cartridge/definition`
	Undeploying a cartridge definition	`/admin/cartridge/definition/<CARTRIDGE_TYPE>`
	Listing all the available cartridges (single tenant and multi-tenant)	`/admin/cartridge/list`
	Subscribing to a cartridge	`/admin/cartridge/subscribe`
	Listing all the subscribed cartridges	`/admin/cartridge/list/subscribed`
	Retrieving information on a cartridge that is already subscribed to by a user	`/admin/cartridge/info/<CARTRIDGE_ALIAS>`
	Retrieving cluster details of a specific cluster	`/admin/cluster/clusterId/<CLUSTER_ID>`
	Unsubscribing from a cartridge	`/admin/cartridge/unsubscribe`
	Manually synchronizing the GIT repository for subscribed cartridges	`/admin/cartridge/sync`