General Settings - Update

Service:

Build

API Version:

6.0-preview.1

Updates pipeline general settings.

PATCH https://dev.azure.com/{organization}/{project}/_apis/build/generalsettings?api-version=6.0-preview.1

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
project	path	True	string	Project ID or project name
api-version	query	True	string	Version of the API to use. This should be set to '6.0-preview.1' to use this version of the api.

Request Body

Name	Type	Description
enforceJobAuthScope	boolean	If enabled, scope of access for all pipelines reduces to the current project.
enforceReferencedRepoScopedToken	boolean	Restricts the scope of access for all pipelines to only repositories explicitly referenced by the pipeline.
enforceSettableVar	boolean	If enabled, only those variables that are explicitly marked as "Settable at queue time" can be set at queue time.
publishPipelineMetadata	boolean	Allows pipelines to record metadata.
statusBadgesArePrivate	boolean	Anonymous users can access the status badge API for all pipelines unless this option is enabled.

Responses

Name	Type	Description
200 OK	PipelineGeneralSettings	successful operation

Security

accessToken

Personal access token. Use any value for the user name and the token as the password.

Type: basic

Definitions

PipelineGeneralSettings

Contains pipeline general settings.

Name	Type	Description
enforceJobAuthScope	boolean	If enabled, scope of access for all pipelines reduces to the current project.
enforceReferencedRepoScopedToken	boolean	Restricts the scope of access for all pipelines to only repositories explicitly referenced by the pipeline.
enforceSettableVar	boolean	If enabled, only those variables that are explicitly marked as "Settable at queue time" can be set at queue time.
publishPipelineMetadata	boolean	Allows pipelines to record metadata.
statusBadgesArePrivate	boolean	Anonymous users can access the status badge API for all pipelines unless this option is enabled.