EnvironmentsResource
A RESTful resource for managing environments.
The following resources are applicable:
/environments
Mount Point: /environments
GET
Gets all environments.
Response Body
| element: | (custom) |
| media types: | application/xml text/xml application/json |
The list of all environments
POST
Creates an environment.
Request Body
| element: | environment |
| media types: | application/xml text/xml application/json |
The environment to create
Response Body
| element: | environment |
| media types: | application/xml text/xml application/json |
The newly created environment
/environments/{id}
Mount Point: /environments/{id}
The following operations are supported on this resource:
GET
Gets the environment for the given ID.
Parameters
| name | description | type | default |
|---|---|---|---|
| id | The ID of the environment to find | path |
Response Body
| element: | environment |
| media types: | application/xml text/xml application/json |
The environment found
PUT
Updates an environment with the given ID.
Parameters
| name | description | type | default |
|---|---|---|---|
| id | The ID of the environment to update | path |
Request Body
| element: | environment |
| media types: | application/xml text/xml application/json |
The environment to update
DELETE
Deletes an environment with the given ID.
Parameters
| name | description | type | default |
|---|---|---|---|
| id | The ID of the environment to delete | path |
/environments/{id}/latest-deployed
Mount Point: /environments/{id}/latest-deployed
GET
Gets the latest change set deployed to the given environment.
Parameters
| name | description | type | default |
|---|---|---|---|
| id | The ID of the environment | path |
Response Body
| element: | changeSet |
| media types: | application/xml text/xml application/json |
The latest deployed change set
/environments/name/{name}
Mount Point: /environments/name/{name}
GET
Gets the environment for the given name.
Parameters
| name | description | type | default |
|---|---|---|---|
| name | The name of the environment to find | path |
Response Body
| element: | environment |
| media types: | application/xml text/xml application/json |
The environment found