v5

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-07-0330110112.1 KB

API Documentations

Get one API Documentation page

Get an API Documentation page using HRID

get/organizations/{orgId}/environments/{envId}/apis/{apiHrid}/documentations/{hrid}

Documentation successfully retrieved

hridstring required

A unique human readable id identifying this resource

namestring required

Display name of the documentation page

type'GRAVITEE_MARKDOWN' | 'OPENAPI' | 'ASYNCAPI' required

The type of documentation page

contentstring required

The content of the documentation page

locationstring

The path in the navigation hierarchy where this page should appear.

orderinteger

Display order relative to siblings at the same location

idstring

Resource UUID.

environmentIdstring

The environment ID.

organizationIdstring

The organization ID.

portalHridstring

The HRID of the portal this documentation page belongs to (when attached to a portal).

apiHridstring

The HRID of the API this documentation page belongs to (when attached to an API).

{
  "hrid": "demo_api",
  "name": "Getting Started",
  "location": "/projects/alpha/docs"
}