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 a Cartridge Group via REST API
Skip to end of metadata
Go to start of metadata


DescriptionRetrieve details of a cartridge group.
Resource Path/cartridgeGroups/{groupDefinitionName}
Request/Response Formatapplication/json
> GET /api/cartridgeGroups/esb-php-group 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: Tue, 24 Mar 2015 04:20:54 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://<STRATOS_HOST>:<STRATOS_HTTPS_PORT>/api/cartridgeGroups/{groupDefinitionName}

  • 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/cartridgeGroups/esb-php-group
CLI commanddescribe-cartridge-group
DescriptionRetrieve details of a specific cartridge group.
Command formatdescribe-cartridge-group <CARTRIDGE_GROUP_NAME>

REST API response

HTTP status code

200, 404, 500

See the descriptions of the HTTP status codes here.

Sample JSON response

  "cartridges": [
  "dependencies": {
    "startupOrders": [
    "terminationBehaviour": "terminate-none"
  "groupScalingEnabled": true,
  "name": "esb-php-group"

For information on all the properties that can be used in a cartridge group definition, see the Cartridge Group Resource Definition.

  • No labels