Share via


Folders - Create

Creates a new folder.

PUT https://dev.azure.com/{organization}/{project}/_apis/build/folders?path={path}&api-version=7.1-preview.2

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 '7.1-preview.2' to use this version of the api.

path
query True

string

The full path of the folder.

Request Body

Name Type Description
createdBy

IdentityRef

The process or person who created the folder.

createdOn

string (date-time)

The date the folder was created.

description

string

The description.

lastChangedBy

IdentityRef

The process or person that last changed the folder.

lastChangedDate

string (date-time)

The date the folder was last changed.

path

string

The full path.

project

TeamProjectReference

The project.

Responses

Name Type Description
200 OK

Folder

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.build_execute Grants the ability to access build artifacts, including build results, definitions, and requests, and the ability to queue a build, update build properties, and the ability to receive notifications about build events via service hooks.

Definitions

Name Description
Folder

Represents a folder that contains build definitions.

IdentityRef
ProjectState

Project state.

ProjectVisibility

Project visibility.

ReferenceLinks

The class to represent a collection of REST reference links.

TeamProjectReference

Represents a shallow reference to a TeamProject.

Folder

Represents a folder that contains build definitions.

Name Type Description
createdBy

IdentityRef

The process or person who created the folder.

createdOn

string (date-time)

The date the folder was created.

description

string

The description.

lastChangedBy

IdentityRef

The process or person that last changed the folder.

lastChangedDate

string (date-time)

The date the folder was last changed.

path

string

The full path.

project

TeamProjectReference

The project.

IdentityRef

Name Type Description
_links

ReferenceLinks

This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.

descriptor

string

The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.

directoryAlias

string

Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary

displayName

string

This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.

id

string

imageUrl

string

Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary

inactive

boolean

Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary

isAadIdentity

boolean

Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)

isContainer

boolean

Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)

isDeletedInOrigin

boolean

profileUrl

string

Deprecated - not in use in most preexisting implementations of ToIdentityRef

uniqueName

string

Deprecated - use Domain+PrincipalName instead

url

string

This url is the full route to the source resource of this graph subject.

ProjectState

Project state.

Value Description
all

All projects regardless of state except Deleted.

createPending

Project has been queued for creation, but the process has not yet started.

deleted

Project has been deleted.

deleting

Project is in the process of being deleted.

new

Project is in the process of being created.

unchanged

Project has not been changed.

wellFormed

Project is completely created and ready to use.

ProjectVisibility

Project visibility.

Value Description
private

The project is only visible to users with explicit access.

public

The project is visible to all.

The class to represent a collection of REST reference links.

Name Type Description
links

object

The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.

TeamProjectReference

Represents a shallow reference to a TeamProject.

Name Type Description
abbreviation

string

Project abbreviation.

defaultTeamImageUrl

string

Url to default team identity image.

description

string

The project's description (if any).

id

string (uuid)

Project identifier.

lastUpdateTime

string (date-time)

Project last update time.

name

string

Project name.

revision

integer (int64)

Project revision.

state

ProjectState

Project state.

url

string

Url to the full version of the object.

visibility

ProjectVisibility

Project visibility.