Skip to content

REST: Environments related API

bugzmanov edited this page Aug 1, 2012 · 29 revisions

List existing environments

Path: /rest/projects/(projectId)/envs
Type: GET
Path parameters

Parameter Type Description
projectId Number project id of the project envs belong to

Request parameters

Parameter Type Mandatory Description
filter String N Sets filter's values. Currently possible filtering on the status of the environment.

Example: filter=statuses[Destroyed,Broken]

Example results

[
    {
        "name":"test",
        "status":"Ready",
        "creator":"genesis",
        "templateName":"ErlangAmazon",
        "templateVersion":"0.1"
    }
]

Create a new environment

Path: /rest/projects/(projectId)/envs

Type: POST

Parameter Type Description
projectId Number project id the created env should belong to


Request body structure
Request body consists form a single JSON map contains the following entries:

Entry name Type Description
envName String Environment name
creator String Environment creator name. Parameter is optional. Service uses current user identity to set creator.
templateName String Name of the Environment template to use
templateVersion String Version of the Environment template to use
variables Map of String pairs Creation workflow variable values customized by user
Clone this wiki locally