Page Comparison

You can sign up to an application using the CLI tool, REST API or the Private PaaS console (UI) PPaaS Console as shown below:

Localtabgroup

Localtab

active	true
title	CLI

Signing up to an application via the CLI

Overview

CLI command

add-application-signup

Description Add an application sign up.

Command format

Code Block
add-application-signup <APPLICATION_ID> -p <JSON_FILE_PATH>

Info
The path to the JSON file that defines the application sign up needs to be defined as the `<JSON_FILE_PATH>` value.

Parameter definition

Short option	Long option	Description	Required	Example value
`-p`	`--resource-path`	Folder path where the `JSON` file that defines the cartridge is stored.	Yes	`<PRIVATE_PAAS_CARTRIDGES>/wso2am/1.9.0/samples/ application-signup.json`
N/A	N/A	Application ID.	Yes	`wso2am-190-application`

Example

Add the application-signup.json file that is defined in <PRIVATE_PAAS_CARTRIDGES>/wso2am/1.9.0/samples/application-signup.json.

Code Block
add-application-signup wso2am-190-application -p <PRIVATE_PAAS_CARTRIDGES>/wso2am/1.9.0/samples/application-sign-up.json

Sample output

Code Block
Successfully signed up for: [application] wso2am-190-application

Localtab

title	REST API

Signing up to an application via the REST API

Overview

Description Add one or more domain mappings for a cluster.

Resource Path

/applications/{applicationId}/domainMappings

HTTP Method POST

Request/Response Format

application/json

Command format

Code Block

curl -X POST -H "Content-Type: application/json" -d @'<JSON_PAYLOAD>' -k -v -u <USERNAME>:<PASSWORD> https://<PRIVATE_PAAS_HOST>:<PRIVATE_PAAS_HTTPS_PORT>/api/applications/{applicationId}/domainMappings

Info

The path to the JSON file that defines the application needs to be defined as the <JSON_PAYLOAD> value.
By default, <USERNAME>:<PASSWORD> is admin:admin.
By default, <PRIVATE_PAAS_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
By default, <PRIVATE_PAAS_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.

Example

Add the application-signup.json file that is defined in <PRIVATE_PAAS_CARTRIDGES>/wso2am/1.9.0/samples/application-signup.json.

Code Block

cd <PRIVATE_PAAS_CARTRIDGES>/wso2am/1.9.0/samples/applications/wso2am-190-application/artifacts/
curl -X POST -H "Content-Type: application/json" -d @'application-signup.json' -k -v -u admin:admin https://localhost:9443/api/applications/wso2am-190-application/signup

Sample output

Code Block

> POST /api/applications/wso2am-190-application/signup HTTP/1.1
> Host: localhost:9443
> Authorization: Basic YWRtaW46YWRtaW4=
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Content-Length: 334
> 
< HTTP/1.1 201 Created
< Date: Tue, 13 Oct 2015 05:47:07 GMT
< Location: https://localhost:9443/api/applications/wso2am-190-application/signup/wso2am-190-application
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
< 
{"status":"success","message":"Successfully signed up for: [application] wso2am-190-application"}

You will come across the following HTTP status codes while signing up to an application:

HTTP status code

200, 404, 500

See the descriptions of the HTTP status codes here.

Localtab

title	Private PaaS consolePPaaS Console

Signing up to an application via the

REST API

PPaaS Console

...

Excerpt

Panel

title	Sample application JSON

Code Block

{
  "artifactRepositories": [
    {
      "alias": "wso2as-521-worker",
      "privateRepo": false,
      "repoUrl": "https://github.com/imesh/stratos-php-applications.git",
      "repoUsername": "",
      "repoPassword": ""
    },
    {
      "alias": "wso2as-521-manager",
      "privateRepo": false,
      "repoUrl": "https://github.com/imesh/stratos-tomcat-applications.git",
      "repoUsername": "",
      "repoPassword": ""
    }
  ]
}

...

Versions Compared

Old Version 5

New Version 6

Key

Signing up to an application via the CLI

Overview

Parameter definition

Example

Sample output

Signing up to an application via the REST API

Overview

Example

Sample output

Signing up to an application via the

PPaaS Console