Overview

DescriptionRetrieve details of a specific cartridge.
Resource Path

/cartridges/{cartridgeType}

HTTP MethodGET
Request/Response Format

application/json

> GET /api/cartridges/php 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:41:58 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
<
{"category":"data","description":"php Cartridge","displayName":"php","host":"php.stratos.org","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/{cartridgeType}

  • 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/php
CLI command
describe-cartridge
DescriptionRetrieve details of a specific cartridge.
Command format
describe-cartridge <CARTRIDGE_TYPE>

REST API response

HTTP status code

200, 500

See the descriptions of the HTTP status codes here.

Sample JSON response

{
  "category": "data",
  "description": "php Cartridge",
  "displayName": "php",
  "host": "php.stratos.org",
  "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