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.

...

Tip

Note: When you access any API other than the login and logout APIs through an external REST client such as cURL, first invoke the login API to ensure that user is authenticated. When the login API is invoked, the system stores the generated session cookie in a file, which we use in the next API invocations.

Login

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://integration.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://integration.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 for 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'



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'

updateDefaultVersion

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

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'

getApplicationHashIdByName

Description

Get the unique key used in the other rest API to represent a specific application

URI

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

URI Parameters

  • action:getApplicationHashIdByName
  • applicationName

HTTP Methods

POST

Example

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

stopApplication

Description

Stop the instance of a running application

URI

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

URI Parameters

  • action:stopApplication
  • applicationName
  • applicationRevision
  • versionKey

HTTP Methods

POST

Example

curl -v -b cookies -X POST https://integration.cloud.wso2.com/appmgt/site/blocks/application/application.jag -d 'action=stopApplication&applicationName=app001&applicationRevision=1.0.0& versionKey =<version hash of the application version> '

startApplication

Description

Start an instance of a stopped application

URI

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

URI Parameters

  • action:startApplication
  • applicationName
  • applicationRevision
  • versionKey

HTTP Methods

POST

Example

curl -v -b cookies -X POST  https://integration.cloud.wso2.com/appmgt/site/blocks/application/application.jag -d 'action=startApplication&applicationName=app001&applicationRevision=1.0.0& versionKey =<version hash of the application version>'

redeployApplication

Description

Restart the instance of a running application

URI

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

URI Parameters

  • action:redeployApplication
  • applicationName
  • applicationRevision
  • versionKey

HTTP Methods

POST

Example

curl -v -b cookies -X POST  https://integration.cloud.wso2.com/appmgt/site/blocks/application/application.jag -d 'action=redeployApplication&applicationName=app001&applicationRevision=1.0.0& versionKey =<version hash of the application version>'

addUserToTenant

Description

Create a new user

URI

https://cloudmgt.cloud.wso2.com/cloudmgt/site/blocks/tenant/users/add/ajax/add.jag

URI Parameters

  • action: addUserToTenant
  • userEmail: Email address of the user
  • password: User's password should meet at least three of the below criteria:
    • Uppercase letters
    • Lowercase letters
    • Numbers
    • Special characters
  • firstName: User's first name (alphanumeric characters      only)
  • lastName: User's last name (alphanumeric characters only)
  • roles: User's roles. Can take one or more of the following roles in a comma-separated list: appclouduser, subscriber, publisher, admin     

HTTP Methods

POST

Example

curl -k -v -X POST https://cloudmgt.cloud.wso2.com/cloudmgt/site/blocks/tenant/users/add/ajax/add.jag -b cookies -H 'Content­Type:application/x­www­form­urlencoded' -H 'Accept­Language:en­US,en;q=0.5' -­d 'action=addUserToTenant&userEmail=myemail@ wso2.com &password=testPassword&firstName=testFirstName&lastName=testLastName&roles=subscriber'  

deleteUserFromTenant

Description

Delete an existing user

URI

https://cloudmgt.cloud.wso2.com/cloudmgt/site/blocks/tenant/users/add/ajax/add.jag
 

URI Parameters

  • action: deleteUserFromTenant
  • userName: Email address of the user

HTTP Methods

POST

Example

curl -­b cookies -­k -v -X POST  https://cloudmgt.cloud.wso2.com/cloudmgt/site/blocks/tenant/users/add/ajax/add.jag - ­H 'Content­Type:application/x­www­form­urlencoded' -H 'Accept­Language:en­US,en;q=0.5'   -d 'action=deleteUserFromTenant&userName= myemail@ wso2.com '  

getEnvVariablesOfVersion

Description

Get a JSON array of environment variable key-value pairs

URI

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

URI Parameters

  • action:getEnvVariablesOfVersion
  • versionKey

HTTP Methods

POST

Example

curl -v -b cookies -X POST  https://integration.cloud.wso2.com/appmgt/site/blocks/application/application.jag -d 'action=getEnvVariablesOfVersion&versionKey=<version hash of the application version>'

addRuntimeProperty

Description

Add a new runtime property

URI

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

URI Parameters

HTTP Methods

POST

Example

curl -v -b cookies -X POST  https://integration.cloud.wso2.com/appmgt/site/blocks/application/application.jag  -d 'action=addRuntimeProperty&versionKey=<version hash of the application version>&key=prop&value=val'

updateRuntimeProperty

Description

Update a runtime property

URI

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

URI Parameters

  • action:updateRuntimeProperty
  • versionKey:hash of the application version
  • prevKey:key of the property that you want to update
  • newKey:new key for the property
  • newValue:new value for the property

HTTP Methods

POST

Example

curl -v -b cookies -X POST  https://integration.cloud.wso2.com/appmgt/site/blocks/application/application.jag -d 'action= updateRuntimeProperty&versionKey=<version hash of the application version>&prevKey=prop1&newKey=prop2&newValue=val1'

deleteRuntimeProperty

Description

Delete a runtime property

URI

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

URI Parameters

  • action:deleteRuntimeProperty
  • versionKey
  • key

HTTP Methods

POST

Example

curl -v -b cookies -X POST  https://integration.cloud.wso2.com/appmgt/site/blocks/application/application.jag -d 'action=deleteRuntimeProperty&versionKey=<version hash of the application version>&key=<key for the property>'

addTag

Description

Add a new tag

URI

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

URI Parameters

  • action:addTag
  • versionKey:hash of the application version
  • key:key for the tag
  • value:value for the tag

HTTP Methods

POST

Example

curl -v -b cookies -X POST  https://integration.cloud.wso2.com/appmgt/site/blocks/application/application.jag -d 'action=addTag&versionKey=<hash of the application version>&key=tag&value=val'

getTags

Description

Get all tags of a version

URI

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

URI Parameters

  • action:getTags
  • versionKey:hash of the application version

HTTP Methods

POST

Example

curl -v -b cookies -X POST  https://integration.cloud.wso2.com/appmgt/site/blocks/application/application.jag -d 'action=getTags&versionKey=<hash of the application version>'

updateTag

Description

Update a tag

URI

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

URI Parameters

  • action:updateTag
  • versionKey:hash of the application version
  • prevKey:key of the tag to update
  • newKey:new key for the tag
  • newValue:new value for the tag

HTTP Methods

POST

Example

curl -v -b cookies -X POST  https://integration.cloud.wso2.com/appmgt/site/blocks/application/application.jag -d 'action=updateTag&versionKey=<version hash of the application version>&prevKey=tag1&newKey=tag2&newValue=val1'

delete Tag

Description

Delete a tag

URI

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

URI Parameters

  • action:deleteTag
  • versionKey:hash of the application version
  • key:key of the tag

HTTP Methods

POST

Example

curl -v -b cookies -X POST  https://integration.cloud.wso2.com/appmgt/site/blocks/application/application.jag -d 'action=deleteTag&versionKey=<version hash of the application version>&key=tag'

deleteVersion

Description

Delete a given version of an application

URI

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

URI Parameters

  • action:"deleteVersion"
  • versionKey

HTTP Methods

POST

Example

curl -v -b cookies -X POST https://integration.cloud.wso2.com/appmgt/site/blocks/application/application.jag -d 'action=deleteVersion&versionKey =<version hash of the application version>'

deleteApplication

Description

Delete an application

URI

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

URI Parameters

  • action:"deleteApplication"
  • applicationKey

HTTP Methods

POST

Example

curl -v -b cookies -X POST https://integration.cloud.wso2.com/appmgt/site/blocks/application/application.jag -d 'action=deleteApplication&applicationKey=<application hash id>'