API Catalog API

ApiDoc represents an API catalog item. Catalog items are used in two ways in a portal:

  • Users can browse and interact with a visual representation of the API documentation.
  • The apiProductName field provides a link to a backing API product. Through this link, portal users can create and manage developer apps linked to one or more API products.

For more information, see Publish your APIs.

Resource Types

URIs are relative to https://api.enterprise.apigee.com/v1, unless otherwise noted.

ApiDoc

For more information, see ApiDoc.
MethodEndpointDescription
get/organizations/{org}/sites/{site}/apidocs

List the catalog items associated with a portal.

post/organizations/{org}/sites/{site}/apidocs

Creates a catalog item.

get/organizations/{org}/sites/{site}/apidocs/{apidoc}

Gets a catalog item.

put/organizations/{org}/sites/{site}/apidocs/{apidoc}

Updates a catalog item.

ApiDocDocumentation

For more information, see ApiDocDocumentation.
MethodEndpointDescription
get/organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation

Gets the documentation for the specified catalog item.

patch/organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation

Updates the documentation for the specified catalog item. Note that the documentation file contents will not be populated in the return message.

ApiDocDocumentionResponse

For more information, see ApiDocDocumentionResponse.
MethodEndpointDescription
get/organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation

Gets the documentation for the specified catalog item.

patch/organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation

Updates the documentation for the specified catalog item. Note that the documentation file contents will not be populated in the return message.

ApiDocListResponse

For more information, see ApiDocListResponse.
MethodEndpointDescription
get/organizations/{org}/sites/{site}/apidocs

List the catalog items associated with a portal.

ApiDocRequest

For more information, see ApiDocRequest.
MethodEndpointDescription
post/organizations/{org}/sites/{site}/apidocs

Creates a catalog item.

put/organizations/{org}/sites/{site}/apidocs/{apidoc}

Updates a catalog item.

ApiDocResponse

For more information, see ApiDocResponse.
MethodEndpointDescription
post/organizations/{org}/sites/{site}/apidocs

Creates a catalog item.

get/organizations/{org}/sites/{site}/apidocs/{apidoc}

Gets a catalog item.

put/organizations/{org}/sites/{site}/apidocs/{apidoc}

Updates a catalog item.

DeleteResponse

For more information, see DeleteResponse.
MethodEndpointDescription
delete/organizations/{org}/sites/{site}/apidocs/{apidoc}

Deletes a catalog item.

DocumentationFile

For more information, see DocumentationFile.
MethodEndpointDescription
get/organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation

Gets the documentation for the specified catalog item.

patch/organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation

Updates the documentation for the specified catalog item. Note that the documentation file contents will not be populated in the return message.

GraphqlDocumentation

For more information, see GraphqlDocumentation.
MethodEndpointDescription
get/organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation

Gets the documentation for the specified catalog item.

patch/organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation

Updates the documentation for the specified catalog item. Note that the documentation file contents will not be populated in the return message.

OASDocumentation

For more information, see OASDocumentation.
MethodEndpointDescription
get/organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation

Gets the documentation for the specified catalog item.

patch/organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation

Updates the documentation for the specified catalog item. Note that the documentation file contents will not be populated in the return message.