Versions Compared

Old Version 31

changes.mady.by.user Shavindri Dissanayake

Saved on

compared with

New Version Current

changes.mady.by.user Imesh Gunaratne

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Overview

DescriptionAdd a cartridge definition.
Resource Path

/cartridges

HTTP MethodPOST
Request/Response Format

application/json

Sample request

Excerpt Include
4.1.x Cartridge Resource Definition
4.1.x Cartridge Resource Definition
nopaneltrue

...

Tabs Container
directionhorizontal
Tabs Page
titleHTTP

> POST /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
> Content-Length: 1232
> Expect: 100-continue
>
< HTTP/1.1 100 Continue
< HTTP/1.1 201 Created
< Date: Sat, 21 Mar 2015 00:17:44 GMT
< Location: https://localhost:9443/api/cartridges/php
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
<
{"status":success,"message":"Cartridge added successfully: [cartridge-type] php"}

Tabs Page
titlecURL
Code Block
curl -X POST -H "Content-Type: application/json" -d @'<JSON_PAYLOAD>' -k -v -u admin:admin https://<STRATOS_HOST>:<STRATOS_HTTPS_PORT>/api/cartridges
  • The path to the JSON file that defines the cartridge needs to be defined as the <JSON_PAYLOAD> value.

Excerpt Include
4.1.x Adding a Deployment Policy via REST API
4.1.x Adding a Deployment Policy via REST API
nopaneltrue

For example:

Code Block
cd <STRATOS_SOURCE_HOME>/samples
curl -X POST -H "Content-Type: application/json" -d @'cartridges/mock/php.json' -k -v -u admin:admin https://localhost:9443/api/cartridges


Tabs Page
titleCLI
 
Excerpt Include
4.1.x Adding a Cartridge via CLI
4.1.x Adding a Cartridge via CLI
nopaneltrue

...

REST API response

HTTP status code

100, 201, 400, 409, 500
See the descriptions of the HTTP status codes here.

Location header URL

https://<STRATOS_HOST>:<STRATOS_HTTPS_PORT>/api/cartridges/<CARTRIDGE_TYPE>