Preview Preview

POST {{baseUrl}}/:organization/:project/_apis/pipelines/:pipelineId/preview?pipelineVersion=<integer>&api-version=<string>

Queues a dry run of the pipeline and returns an object containing the final yaml.

Request Params

KeyDatatypeRequiredDescription
pipelineVersionstringThe pipeline version.
api-versionstring(Required) Version of the API to use. This should be set to '6.1-preview.1' to use this version of the api.

Request Body

{"previewRun"=>"<boolean>", "resources"=>{"builds"=>"<object>", "containers"=>"<object>", "packages"=>"<object>", "pipelines"=>"<object>", "repositories"=>"<object>"}, "stagesToSkip"=>["<string>", "<string>"], "templateParameters"=>"<object>", "variables"=>"<object>", "yamlOverride"=>"<string>"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{&quot;finalYaml&quot;:&quot;\u003cstring\u003e&quot;}