Projects - Create

Queues a project to be created. Use the GetOperation to periodically check for create project status.

POST https://dev.azure.com/{organization}/_apis/projects?api-version=4.1

URI Parameters

Name In Required Type Description
organization
path True
  • string

The name of the Azure DevOps organization.

api-version
query True
  • string

Version of the API to use. This should be set to '4.1' to use this version of the api.

Request Body

Name Type Description
_links

The links to other objects related to this object.

abbreviation
  • string

Project abbreviation.

capabilities
  • object

Set of capabilities this project has (such as process template & version control).

defaultTeam

The shallow ref to the default team.

description
  • string

The project's description (if any).

id
  • string

Project identifier.

name
  • string

Project name.

revision
  • integer

Project revision.

state

Project state.

url
  • string

Url to the full version of the object.

visibility

Project visibility.

Responses

Name Type Description
200 OK

successful operation

Examples

Sample Request

POST https://dev.azure.com/fabrikam/_apis/projects?api-version=4.1
{
  "name": "FabrikamTravel",
  "description": "Frabrikam travel app for Windows Phone",
  "capabilities": {
    "versioncontrol": {
      "sourceControlType": "Git"
    },
    "processTemplate": {
      "templateTypeId": "6b724908-ef14-45cf-84f8-768b5384da45"
    }
  }
}

Sample Response

{
  "id": "066488b8-b14e-43d1-befc-a2e655266e2b",
  "status": "queued",
  "url": "https://dev.azure.com/fabrikam/_apis/operations/066488b8-b14e-43d1-befc-a2e655266e2b"
}

Definitions

OperationReference

Reference for an async operation.

OperationStatus

The current status of the operation.

ProjectState
ProjectVisibility
ReferenceLinks

The class to represent a collection of REST reference links.

TeamProject

Represents a Team Project object.

WebApiTeamRef

OperationReference

Reference for an async operation.

Name Type Description
id
  • string

Unique identifier for the operation.

pluginId
  • string

Unique identifier for the plugin.

status

The current status of the operation.

url
  • string

URL to get the full operation object.

OperationStatus

The current status of the operation.

Name Type Description
cancelled
  • string

The operation was cancelled by the user.

failed
  • string

The operation completed with a failure.

inProgress
  • string

The operation is in progress.

notSet
  • string

The operation does not have a status set.

queued
  • string

The operation has been queued.

succeeded
  • string

The operation completed successfully.

ProjectState

Name Type Description
all
  • string

All projects regardless of state.

createPending
  • string

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

deleted
  • string

Project has been deleted.

deleting
  • string

Project is in the process of being deleted.

new
  • string

Project is in the process of being created.

unchanged
  • string

Project has not been changed.

wellFormed
  • string

Project is completely created and ready to use.

ProjectVisibility

Name Type Description
private
  • string
public
  • string

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.

TeamProject

Represents a Team Project object.

Name Type Description
_links

The links to other objects related to this object.

abbreviation
  • string

Project abbreviation.

capabilities
  • object

Set of capabilities this project has (such as process template & version control).

defaultTeam

The shallow ref to the default team.

description
  • string

The project's description (if any).

id
  • string

Project identifier.

name
  • string

Project name.

revision
  • integer

Project revision.

state

Project state.

url
  • string

Url to the full version of the object.

visibility

Project visibility.

WebApiTeamRef

Name Type Description
id
  • string

Team (Identity) Guid. A Team Foundation ID.

name
  • string

Team name

url
  • string

Team REST API Url