General Settings - Get
Gets pipeline general settings.
GET https://dev.azure.com/{organization}/{project}/_apis/build/generalsettings?api-version=7.1URI 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 '7.1' to use this version of the api. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
successful operation |
Security
oauth2
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL:
https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer
Scopes
| Name | Description |
|---|---|
| vso.project | Grants the ability to read projects and teams. |
Definitions
PipelineGeneralSettings
Contains pipeline general settings.
| Name | Type | Description |
|---|---|---|
| auditEnforceSettableVar |
boolean |
If enabled, audit logs will be generated whenever someone queues a pipeline run and defines variables that are not marked as "Settable at queue time". |
| buildsEnabledForForks |
boolean |
Enable forked repositories to build pull requests. |
| disableClassicBuildPipelineCreation |
boolean |
Disable classic build pipelines creation. |
| disableClassicPipelineCreation |
boolean |
Disable classic pipelines creation. |
| disableClassicReleasePipelineCreation |
boolean |
Disable classic release pipelines creation. |
| enableShellTasksArgsSanitizing |
boolean |
Enable shell tasks args sanitizing. |
| enableShellTasksArgsSanitizingAudit |
boolean |
Enable shell tasks args sanitizing preview. |
| enforceJobAuthScope |
boolean |
If enabled, scope of access for all non-release pipelines reduces to the current project. |
| enforceJobAuthScopeForForks |
boolean |
Enforce job auth scope for builds of forked repositories. |
| enforceJobAuthScopeForReleases |
boolean |
If enabled, scope of access for all release pipelines reduces to the current project. |
| enforceNoAccessToSecretsFromForks |
boolean |
Enforce no access to secrets for builds of forked repositories. |
| 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. |
| forkProtectionEnabled |
boolean |
Enable settings that enforce certain levels of protection for building pull requests from forks globally. |
| isCommentRequiredForPullRequest |
boolean |
Make comments required to have builds in all pull requests. |
| publishPipelineMetadata |
boolean |
Allows pipelines to record metadata. |
| requireCommentsForNonTeamMemberAndNonContributors |
boolean |
Make comments required to have builds in pull requests from non-team members and non-contributors. |
| requireCommentsForNonTeamMembersOnly |
boolean |
Make comments required to have builds in pull requests from non-team members. |
| statusBadgesArePrivate |
boolean |
Anonymous users can access the status badge API for all pipelines unless this option is enabled. |