Documentation Index

Fetch the complete documentation index at: https://docs.turbo360.com/llms.txt

Use this file to discover all available pages before exploring further.

Azure Documenter API reference

  • 1 minute(s) read
Prev Next

Overview

The Azure Documenter API lets you programmatically manage document configurations, document groups, service principals, and document generation in Turbo360. Use it to integrate Azure documentation workflows into your automation pipelines, CI/CD processes, or custom tooling.

Business value

The Azure Documenter API removes the need to manage document configurations and groups manually through the portal. You can automate configuration lifecycle operations, trigger document generation on demand, and integrate service principal management into your deployment and governance workflows.

How it works

All Azure Documenter API requests are authenticated using an API key. API keys are generated in Settings > API keys and scoped to specific modules and allowed HTTP methods. To use the Azure Documenter API, your key must include Azure Documenter in its allowed modules.

The base URL for all API requests is your Turbo360 portal URL:

  • Cloud-hosted: https://portal.turbo360.com
  • Private hosting: Use the URL of your self-hosted Turbo360 instance.

Include your API key in the request header:

Authorization: <your-api-key>

You can explore and test all available endpoints using the Swagger UI at <your-portal-url>/swagger/index.html.

For full authentication setup, see Authentication.

Endpoint reference

Azure Documenter

Core operations for managing document configurations and initiating document generation.

Method Endpoint Description
GET /AzureDocumenter/{azureDocumenterGroupId}/GetDocumentConfigurations Get all document configurations
GET /AzureDocumenter/{azureDocumenterGroupId}/{configurationId}/GetDocumentGenerationHistory Get the document generation history for a configuration
GET /AzureDocumenter/{azureDocumenterGroupId}/{configurationId}/GetDocumentConfigurationById Get a document configuration
POST /AzureDocumenter/AddDocumentConfiguration Create a new document configuration
PUT /AzureDocumenter/UpdateDocumentConfiguration Update an existing document configuration
DELETE /AzureDocumenter/DeleteDocumentConfiguration Delete a document configuration
POST /AzureDocumenter/GenerateDocument Initiate a document generation

Azure Documenter - Group

Operations for managing document groups.

Method Endpoint Description
GET /AzureDocumenter/Group/{azureDocumenterGroupId}/Get Get a document group
POST /AzureDocumenter/Group/Create Create a document group
PUT /AzureDocumenter/Group/Update Update a document group
DELETE /AzureDocumenter/Group/Delete Delete a document group

Azure Documenter - Service principal

Operations for managing service principals linked to Azure Documenter.

Method Endpoint Description
GET /AzureDocumenter/ServicePrincipal/Get Get service principals
POST /AzureDocumenter/ServicePrincipal/Add Add a new service principal
DELETE /AzureDocumenter/ServicePrincipal/{clientId}/Remove Remove a service principal
PUT /AzureDocumenter/ServicePrincipal/Update Update a service principal

Related articles