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


DescriptionAdd a cartridge group.
Resource Path/cartridgeGroups
Request/Response Formatapplication/json

Sample requests

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

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

> POST /api/cartridgeGroups 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
> Content-Length: 273
* upload completely sent off: 273 out of 273 bytes
< HTTP/1.1 201 Created
< Date: Mon, 23 Mar 2015 09:26:12 GMT
< Location: https://localhost:9443/api/cartridgeGroups/esb-php-group
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
{"status":"success","message":"Cartridge Group added successfully: [cartridge-group] esb-php-group"}
curl -X POST -H "Content-Type: application/json" -d @'<JSON_PAYLOAD>' -k -v -u admin:admin https://<STRATOS_HOST>:<STRATOS_HTTPS_PORT>/api/cartridgeGroups
  • The path to the JSON file that defines the cartridge group needs to be defined as the <JSON_PAYLOAD> value.

  • 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 POST -H "Content-Type: application/json" -d @'cartridge-groups/esb-php-group.json' -k -v -u admin:admin https://localhost:9443/api/cartridgeGroups

CLI commandadd-cartridge-group
DescriptionAdd a cartridge group.
Command format

add-cartrdige-group -p <JSON_FILE_PATH>

The path to the JSON file that defines the cartridge group needs to be defined as the <JSON_FILE_PATH> value.

REST API response

HTTP status code

201, 400, 409, 500

See the descriptions of the HTTP status codes here.

Location header URLhttps://<STRATOS_HOST>:<STRATOS_HTTPS_PORT>/api/cartridgeGroups/<CARTRIDGE_GROUP_NAME>
  • No labels