Try WSO2 Cloud for Free
Sign in

All docs This doc

Versions Compared

Key

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

...

Description

Log in to the Integration Cloud

URI

https://integration.cloud.wso2.com/appmgt/site/blocks/user/login/ajax/login.jag

URI Parameters

action:login, userName, password

HTTP Methods

POST

Example

curl -c cookies -v -X POST -k https://integration.cloud.wso2.com/appmgt/site/blocks/user/login/ajax/login.jag   -d 'action=login&userName=<user_name>&password=<password>'

The <user name> should be email@organization_key. For example, if the e-mail is jhon@gamil.com , the <user name> should be jhon@gmail.com@organization_key. You can find the organization_key on the Manage page of the cloud.

Logout

Description

Log out of the Integration Cloud

URI

  https://i ntegration.cloud.wso2.com/ appmgt/site/blocks/user/logout/ajax/logout.jag  

URI Parameters

action:logout

HTTP Methods

POST

Example

curl -b cookies -v -X POST -k https://i ntegration.cloud.wso2.com/ appmgt/site/blocks/user/logout/ajax/logout.jag -d 'action=logout'

Create Application/Version

Description

Create a new application or add a version to an existing application

URI

https://integration.cloud.wso2.com/appmgt/site/blocks/application/application.jag

URI Parameters

Parameter

Description

action: createApplication


applicationName

Valid characters are alphanumerics and - (dash)

Spaces are not allowed

Not case sensitive

applicationDescription


appTypeName

Application's type.

Values: [war, mss, php, jaggery, wso2dataservice]

runtime

Give the ID of the runtime of the application

  Values: [1, 2, 3, 4, 5, 6, 7]

applicationRevision

Version of the application

format major.minor.patch

uploadedFileName

Name of the archive file that you uploaded

runtimeProperties

Runtime properties as a JSON array of key-value pairs. For example, {"key":"enableAnalytics","value":"true"}

tags

Tags for the instance or application as a JSON array of key-value pairs. For example, {"key":"lifecycle","value":"development"}

fileupload

Should start with @

isFileAttached

This has to be true when using REST APIs to create application/version. Values: [true, false]

conSpec

Set the container specification f or the application. Values: [1, 2, 3, 4, 5, 6, 7, 8]

isNewVersion

Whether or not you are creating a new version of an API. Values: [true, false]

appCreationMethod

Different ways in which the app can be created. You can upload an archive (which is the default option), give a URL or download from Github. 

Values:   [default, url, github]

artifactUrl

If appCreationMethod above is URL, then specify the GitHub repository URL.

gitRepoUrl

If appCreationMethod above is GGithub, then specify the URL to download the artifact from.

gitRepoBranch

Specify GitHub repository branch

projectRoot

Specify project root

setDefaultVersion

Set to true to make this the default version when there are multiple versions for an API.

applicationContext

Set a URL context for the application. This field is enabled only for Java Web apps, PHP and Jaggery apps.

appIcon

Icon file data. Optional parameter.

Supported runtimes and app creation methods per app type:


App Type

Supported Runtime

Supported App Creation Method

1

war

1, 6

default, url

2

mss

2, 8

default, url

3

php

3

default, url, github

4

jaggery

5

default, url, github

5

wso2dataservice

7

default, url

Supported container specifications per runtime:


Runtimes

Supported Container Specs

1

Apache Tomcat 8.0.28 / WSO2 Application Server 6.0.0-M1

3, 4

2

OpenJDK 8 + WSO2 MSF4J 1.0.0

2, 3, 4

3

Apache 2.4.10

1, 2, 3

4

Carbon 4.2.0


5

Jaggery 0.11.0

3, 4

6

Apache Tomcat 8.0.28 / WSO2 Application Server 6.0.0-M2

3, 4

7

WSO2 Data Services Server - 3.5.0

3, 4

8

OpenJDK 8 + WSO2 MSF4J 2.0.0

2, 3, 4

 Container Specifications 

Spec Id

Spec Name

CPU

Memory

1

128MB RAM and 0.1x vCPU

100

128

2

256MB RAM and 0.2x vCPU

200

256

3

512MB RAM and 0.3x vCPU

300

512

4

1024MB RAM and 0.5x vCPU

500

1024

HTTP Methods

POST

Example

curl -v -b cookies -X POST https://integration.cloud.wso2.com/appmgt/site/blocks/application/application.jag  -F action=createApplication -F applicationName=app1 -F applicationDescription=desc -F runtime=1 -F appTypeName=war -F applicationRevision=1.0.0 -F uploadedFileName=sample.war -F runtimeProperties=[] -F tags=[] -F fileupload=@<path to the file>/sample.war -F isFileAttached=true -F conSpec=3 -F isNewVersion=false -F appCreationMethod=default -F setDefaultVersion=true

getApplicationList

Description

Get a JSON object with details of the application list metadata

URI

https://integration.cloud.wso2.com/appmgt/site/blocks/index/ajax/index.jag

URI Parameters

  • action:getApplicationList

HTTP Methods

GET

Example

curl -v -b cookies -X POST  https://integration.cloud.wso2.com/appmgt/site/blocks/index/ajax/index.jag -d 'action=getApplicationList'


Anchor
getApplication
getApplication

getApplication

Description

Get a JSON object with details of the application's metadata

URI

https://integration.cloud.wso2.com/appmgt/site/blocks/application/application.jag

URI Parameters

  • action:getApplication
  • applicationName

HTTP Methods

POST

Example

curl -v -b cookies -X POST  https://integration.cloud.wso2.com/appmgt/site/blocks/application/application.jag -d 'action=getApplication&applicationName=app001'

...

Description

Change the default version of an application.

URI

https://integration.cloud.wso2.com/appmgt/site/blocks/settings/settings.jag

URI Parameters

  • action:updateDefaultVersion
  • applicationName
  • defaultVersion

HTTP Methods

POST

Example

curl -v -b cookies -X POST https://integration.cloud.wso2.com/appmgt/site/blocks/settings/settings.jag - d 'action=updateDefaultVersion&applicationName=app1&defaultVersion=2.0.0'

...

getVersionHashId

getVersionHashId

Description

Get the unique key used in the other restapisto represent a specific version ofapplication

URI

https://integration.cloud.wso2.com/appmgt/site/blocks/application/application.jag

URI Parameters

  • action:getVersionHashId
  • applicationName
  • applicationRevision

HTTP Methods

POST

Example

curl -v -b cookies -X POST  https://integration.cloud.wso2.com/appmgt/site/blocks/application/application.jag -d 'action=getVersionHashId&applicationName=app001&applicationRevision=1.0.0'

...

URI

https://integration.cloud.wso2.com/appmgt/site/blocks/updateVersion/updateVersion.jag

URI Parameters

  • action:"updateApplication"
  • description
  • applicationName
  • versionHashId
  • version
  • applicationHashId
  • conSpecCpu
  • conSpecMemory
  • uploadMethod

HTTP Methods

POST

Example

curl -v -b cookies -X POST https://integration.cloud.wso2.com/appmgt/site/blocks/updateVersion/updateVersion.jag -F action=updateApplication -F description=<UPDATE_NAME/DESCRIPTION> -F applicationName=<APPLICATION_NAME> -F versionHashId=<VERSION_HASH_ID> -F appTypeName=wso2esb -F version=<APPLICATION_VERSION> -F applicationHashId=<APPLICATION_HASH_ID> -F conSpecCpu=<CON_SPEC_CPU> -F conSpecMemory=<CON_SPEC_MEMORY> -F uploadMethod=default

Tip

You can obtain appropriate values for the placeholders in the above curl command via the response from getVersionHashIdgetApplication.