Versions Compared

Key

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

You can add domain mappings using the CLI tool or , REST API or the Private PaaS console (UI) as shown below:

 

Localtabgroup
Localtab
activetrue
titleCLI

Signing up to an application via the CLI

Overview
CLI command

add-application-signup

DescriptionAdd 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 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/
application-sign-up.json
N/AN/AApplication ID.Yeswso2am-190-application
Example

Add the domain mappings defined in the <PRIVATE_PAAS_CARTRIDGES>/wso2am/1.9.0/samples/application-sign-up.json file to the application with the ID: wso2am-190-application.

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
titleREST API
Adding domain mappings

Signing up to an application via the REST API

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

/applications/{applicationId}/domainMappings

HTTP MethodPOST
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 domain mappings defined in the <PRIVATE_PAAS_CARTRIDGES>/wso2am/1.9.0/samples/domainmappings.json file to the application with the ID: wso2am-190-application. 

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 @'domain-mappings.json' -k -v -u admin:admin https://localhost:9443/api/applications/wso2am-190-application/domainMappings
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 adding an application:

HTTP status code

200, 500

See the descriptions of the HTTP status codes here.

Location header URL

https://<PRIVATE_PAAS_HOST>:<PRIVATE_PAAS_HTTPS_PORT>/api/applications/<APPLICATION_ID>/domainMappings

Localtab
titlePrivate PaaS console

Signing up to an application via the REST API

 

...

 

Excerpt
Panel
titleSample 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": ""
    }
  ]
}

...