This documentation is for WSO2 Private PaaS 4.1.0. View documentation for the latest release.
Adding Domain Mappings - WSO2 Private PaaS 4.1.0 - WSO2 Documentation
Skip to end of metadata
Go to start of metadata

You can add domain mappings using the CLI tool or REST API as shown below:

As the signup process takes place automatically when a single tenant application is deployed, domain mapping can be added straight after the application is deployed. However, if domain mapping is being added to a multi-tenant application, after the application is deployed, ensure to first carryout the application sign up process before adding the domain mappings.

Adding domain mappings via the CLI

CLI commandadd-domain-mapping
DescriptionAdd domain mappings for the subscribed cartridge.
Command format
add-domain-mappings <APPLICATION-ID> -p <JSON_FILE_PATH>

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

Parameter definition
Short optionLong optionDescriptionRequiredExample value
N/AN/AID of the application.Yes




Folder path where the JSON file that defines the domain mappings is stored.Yes

Add the domain mappings defined in the <TEST>/domainmappings.json file to the application with the ID: wso2am-190-application

add-domain-mappings wso2am-190-application -p <TEST_PATH>/domainmappings.json
Sample output

Adding domain mappings 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 domain mappings in the <TEST_PATH>/domainmappings.json file and add this domain mapping to the application with the ID: wso2am-190-application. 

curl -X POST -H "Content-Type: application/json" -d @'domain-mappings.json' -k -v -u admin:admin https://localhost:9443/api/applications/wso2am-190-application/domainMappings
Sample output

You will come across the following HTTP status codes while adding an application:

HTTP status code

200, 500

See the descriptions of the HTTP status codes here.

Location header URL



Sample domain mapping JSON

  "domainMappings": [
      "cartridgeAlias": "tomcat",
      "domainName": "",
      "contextPath": "/abc/app"
  • No labels