For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI ReferenceRelease notes
DocumentationAPI ReferenceRelease notes
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Integration API routes
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • GETGenerate documentation for adapters
        • GETGenerate documentation for applications
        • GETGenerate documentation for brokers
        • GETGenerate OpenAPI v3 document
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceHelp

Generate OpenAPI v3 document

GET
http://localhost:3000/help/openapi
GET
/help/openapi
$curl http://localhost:3000/help/openapi \
>     -u "<username>:<password>"
1{}
Generates an OpenAPI v3.1.0 document for Itential Platform.
Was this page helpful?
Previous

Create a collection's indexes in mongo

Next
Built with

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Query parameters

urlstringOptional
url

Response

An OpenAPI v3 document containing all IAP routes

Errors

500
Internal Server Error