Adding the wiki/Home into the Description automatically

Question

Hello! I hope you're doing well.

I'm currently creating a wiki/Home page automatically using the Azure DevOps API. I'm successfully adding the HTML content I need to the body, and the page is being created in wiki/home without any issues.

However, I'm struggling with creating the relationship between the wiki page and the project description. When I create the wiki page via API, it doesn't automatically appear in the project description section. Currently, I have to manually save the wiki relationship through the DevOps UI, but I'd like to automate this process.

I haven't been able to find any endpoint in the official documentation that handles this association. Is it possible to do this automatically via API?

Answer 1

Hi @Gomes Bruno (CaP/ETS2)

Thank you for reaching out to Microsoft Q&A.

Adding Wiki in the Project Description with Rest API is not yet supported.

According to this MS Document: https://learn.microsoft.com/en-us/rest/api/azure/devops/core/projects/update?view=azure-devops-rest-7.1

HTTP

PATCH https://dev.azure.com/{organization}/_apis/projects/{projectId}?api-version=7

Project Update API supports updating project‑level metadata such as name, visibility, abbreviation, description (string only)

As documented: description: string supports plain text only and not markdown, html or linked to Wiki content.

Even this Wiki Update Rest API: https://learn.microsoft.com/en-us/rest/api/azure/devops/wiki/wikis/update?view=azure-devops-rest-7.1&tabs=HTTP

HTTP

PATCH https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}?api-version=7.1

only operates on: Wiki name, Wiki repository metadata, Wiki configuration and it does not interact with project overview settings at all.

The Wiki APIs are scoped strictly to the Wiki service.

When you manually select About → Wiki in the Azure DevOps UI:

Azure DevOps stores an internal UI configuration. This configuration: is not part of the Project object, is not part of the Wiki object, is not exposed via REST or Azure CLI

The _links object in the Projects API is read‑only and cannot be modified

Therefore:

You cannot create or update this association programmatically

Neither REST APIs nor Azure CLI support it

This is a platform limitation, not a documentation gap.

As a workaround:

You can manually set the wiki in the Project as it will be a onetime process.

If full automation is required with zero manual steps:

Add a README.md to the default repository

Azure DevOps automatically renders it in Project Overview

README files are fully automatable via Git APIs

Hi @Gomes Bruno (CaP/ETS2)

Thank you for reaching out to Microsoft Q&A.

Adding Wiki in the Project Description with Rest API is not yet supported.

According to this MS Document: https://learn.microsoft.com/en-us/rest/api/azure/devops/core/projects/update?view=azure-devops-rest-7.1

HTTP

PATCH https://dev.azure.com/{organization}/_apis/projects/{projectId}?api-version=7

Project Update API supports updating project‑level metadata such as name, visibility, abbreviation, description (string only)

As documented: description: string supports plain text only and not markdown, html or linked to Wiki content.

Even this Wiki Update Rest API: https://learn.microsoft.com/en-us/rest/api/azure/devops/wiki/wikis/update?view=azure-devops-rest-7.1&tabs=HTTP

HTTP

PATCH https://dev.azure.com/{organization}/{project}/_apis/wiki/wikis/{wikiIdentifier}?api-version=7.1

only operates on: Wiki name, Wiki repository metadata, Wiki configuration and it does not interact with project overview settings at all.

The Wiki APIs are scoped strictly to the Wiki service.

When you manually select About → Wiki in the Azure DevOps UI:

Azure DevOps stores an internal UI configuration. This configuration: is not part of the Project object, is not part of the Wiki object, is not exposed via REST or Azure CLI

The _links object in the Projects API is read‑only and cannot be modified

Therefore:

You cannot create or update this association programmatically

Neither REST APIs nor Azure CLI support it

This is a platform limitation, not a documentation gap.

As a workaround:

You can manually set the wiki in the Project as it will be a onetime process.

If full automation is required with zero manual steps:

Add a README.md to the default repository

Azure DevOps automatically renders it in Project Overview

README files are fully automatable via Git APIs

If the resolution was helpful, kindly take a moment to click on and click on Yes for was this answer helpful. And, if you have any further query do let us know.