This documentation is for WSO2 Private PaaS 4.1.0. View documentation for the latest release.
Signing up to an Application - WSO2 Private PaaS 4.1.0 - WSO2 Documentation
Skip to end of metadata
Go to start of metadata

You can sign up to an application using the CLI tool, REST API or the PPaaS Console as shown below:

After signing up to the application you can access the multi-tenant application via the designated application URL.



Signing up to an application via the CLI

CLI command


DescriptionAdd an application sign up.
Command format
add-application-signup <APPLICATION_ID> -p <JSON_FILE_PATH>

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 optionLong optionDescriptionRequiredExample value
-p--resource-pathFolder path where the JSON file that defines the cartridge is stored.Yes<PRIVATE_PAAS_CARTRIDGES>/wso2am/1.9.0/samples/
N/AN/AApplication ID.Yeswso2am-190-application

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

add-application-signup wso2am-190-application -p <PRIVATE_PAAS_CARTRIDGES>/wso2am/1.9.0/samples/application-sign-up.json
Sample output
Successfully signed up for: [application] wso2am-190-application

Signing up to an application via the REST API

DescriptionAdd one or more domain mappings for a cluster.
Resource Path


Request/Response Format


Command format
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
  • 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.

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

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
> 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.

Signing up to an application via the PPaaS Console

Follow the instructions below to deploy an application:

  1. Click Applications on the home page.
  2. Hover your mouse pointer over the deployed application that you wish to sign up to for the Sign up button to appear.
  3. Click Sign up.
  4. Click on a cartridge to add the sign up details. For more details on the application sign up definitions, see Application Sign Up Resource Definition.
  5. Click Update.
    Repeat step 4 and 5 until you have finished adding sign up details for all the cartridges that correspond to the application. 
  6. Click Add Sign up.


Sample application sign up JSON

  "artifactRepositories": [
      "alias": "wso2as-521-worker",
      "privateRepo": false,
      "repoUrl": "",
      "repoUsername": "",
      "repoPassword": ""
      "alias": "wso2as-521-manager",
      "privateRepo": false,
      "repoUrl": "",
      "repoUsername": "",
      "repoPassword": ""
  • No labels