PipelineEnvironmentsResource
A RESTful resource for managing pipeline environments. Note: the root-resource path specifies the pipeline ID.
The following resources are applicable:
- /pipelines/{pipe}/environments
- /pipelines/{pipe}/environments/{env}
- /pipelines/{pipe}/environments/{env}/previous/{prevenv}
/pipelines/{pipe}/environments
Mount Point: /pipelines/{pipe}/environments
GET
Gets the list of pipeline environments for a given pipeline ID.
Parameters
name | description | type | default |
---|---|---|---|
pipe | The pipeline ID this resource is managing | path |
Response Body
element: | pipelineEnvironments |
media types: | application/xml text/xml application/json |
The pipeline environments object
/pipelines/{pipe}/environments/{env}
Mount Point: /pipelines/{pipe}/environments/{env}
The following operations are supported on this resource:
GET
Gets the single pipeline environments for the given pipeline ID and environment ID.
Parameters
name | description | type | default |
---|---|---|---|
pipe | The pipeline ID this resource is managing | path | |
env | The environment to search for in the pipeline | path |
Response Body
element: | pipelineEnvironment |
media types: | application/xml text/xml application/json |
The pipeline environment object
POST
Inserts an environment into the start of a pipeline (no previous environment).
Parameters
name | description | type | default |
---|---|---|---|
pipe | The pipeline ID this resource is managing | path | |
env | The environment to add to the pipeline | path |
Request Body
element: | csrfToken |
media types: | */* application/xml |
The CSRF token
DELETE
Removes an environment from a pipeline.
Parameters
name | description | type | default |
---|---|---|---|
pipe | The pipeline ID this resource is managing | path | |
env | The environment to remove from the pipeline | path |
/pipelines/{pipe}/environments/{env}/previous/{prevenv}
Mount Point: /pipelines/{pipe}/environments/{env}/previous/{prevenv}
POST
Inserts an environment into the middle or end of a pipeline (specifying previous environment).
Parameters
name | description | type | default |
---|---|---|---|
pipe | The pipeline ID this resource is managing | path | |
env | The environment to add to the pipeline | path | |
prevenv | The previous environment in the pipeline | path |
Request Body
element: | csrfToken |
media types: | */* application/xml |
The CSRF token