Welcome to the Azure DevOps Node API documentation! This section will help you get up and running quickly with the API, whether you're building DevOps integrations, automated tools, or custom extensions.
The Azure DevOps Node API is a JavaScript/TypeScript client library that allows you to interact with Azure DevOps Services and Azure DevOps Server. It provides a convenient interface to work with:
| Guide | Description |
|---|---|
| Getting Started Guide | A step-by-step introduction to using the Azure DevOps Node API |
| Authentication Guide | Comprehensive guide to authentication methods |
| Authentication Cheat Sheet | Quick reference for authentication methods |
| OAuth Authentication | Detailed guide for implementing OAuth authentication |
| Security Best Practices | Best practices for securely using the API |
The Azure DevOps Node API package can be installed via npm:
npm install azure-devops-node-api
For TypeScript users, type definitions are included in the package.
Here's a quick example to get you started:
const azdev = require("azure-devops-node-api");
// Your organization URL and Personal Access Token
const orgUrl = "https://dev.azure.com/your-organization";
const token = process.env.AZURE_DEVOPS_PAT;
async function example() {
try {
// Create authentication handler
const authHandler = azdev.getPersonalAccessTokenHandler(token);
// Create a connection to Azure DevOps
const connection = new azdev.WebApi(orgUrl, authHandler);
// Get the Core API
const coreApi = await connection.getCoreApi();
// Get all projects
const projects = await coreApi.getProjects();
console.log(`Found ${projects.length} projects`);
// Get the Git API
const gitApi = await connection.getGitApi();
// Get all repositories
const repositories = await gitApi.getRepositories();
console.log(`Found ${repositories.length} repositories`);
} catch (error) {
console.error("Error:", error.message);
}
}
example();
If you're new to the Azure DevOps Node API, we recommend following this learning path:
If you encounter issues with the Azure DevOps Node API, check the Troubleshooting Connection Issues guide or refer to the specific API client documentation.