This Confluence has been LDAP enabled, if you are an ASF Committer, please use your LDAP Credentials to login. Any problems file an INFRA jira ticket please.

Child pages
  • 4.1.x Getting Details of Cartridges via REST API
Skip to end of metadata
Go to start of metadata


DescriptionList all the available cartridges (single tenant and multi-tenant).
Resource Path


Request/Response Format


> GET /api/cartridges HTTP/1.1
> Authorization: Basic YWRtaW46YWRtaW4=
> User-Agent: curl/7.24.0 (x86_64-apple-darwin12.0) libcurl/7.24.0 OpenSSL/0.9.8| zlib/1.2.5
> Host: localhost:9443
> Accept: */*
> Content-Type: application/json
< HTTP/1.1 200 OK
< Date: Sat, 21 Mar 2015 00:38:08 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
[{"category":"data","description":"tomcat Cartridge","displayName":"tomcat","host":"","metadataKeys":["url"],"multiTenant":false,"provider":"apache","public":false,"type":"tomcat","version":7},{"category":"data","description":"php Cartridge","displayName":"php","host":"","multiTenant":false,"provider":"apache","public":false,"type":"php","version":7}]
curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://<STRATOS_HOST>:<STRATOS_HTTPS_PORT>/api/cartridges

  • By default, <STRATOS_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
  • By default, <STRATOS_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.

For example:

curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/cartridges
CLI command
DescriptionList all the available cartridges (single-tenant and multi-tenant).
Command format

REST API response

HTTP status code

200, 500

See the descriptions of the HTTP status codes here.

Sample JSON response

    "category": "data",
    "description": "tomcat Cartridge",
    "displayName": "tomcat",
    "host": "",
    "metadataKeys": [
    "multiTenant": false,
    "provider": "apache",
    "public": false,
    "type": "tomcat",
    "version": 7
    "category": "data",
    "description": "php Cartridge",
    "displayName": "php",
    "host": "",
    "multiTenant": false,
    "provider": "apache",
    "public": false,
    "type": "php",
    "version": 7

For information on all the properties that can be used in a cartridge definition, see the Cartridge Property Definitions.

  • No labels