---
title: "POST /v1/{+parent}/apidocs"
method: POST
path: "/v1/{+parent}/apidocs"
tags: ["organizations"]
---

# POST /v1/{+parent}/apidocs

`POST /v1/{+parent}/apidocs`

Creates a new catalog item.

## Path parameters

- `parent` string, required

## Request body

- GoogleCloudApigeeV1ApiDoc — `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 `api_product_name` field provides a link to a backing [API product] (/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). Through this link, portal users can create and manage developer apps linked to one or more API products.
  - `visibility` boolean — Optional. DEPRECATED: use the `published` field instead
  - `graphqlSchemaDisplayName` string — Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
  - `graphqlSchema` string — Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
  - `apiProductName` string — Required. Immutable. The `name` field of the associated [API product](/apigee/docs/reference/apis/apigee/rest/v1/organizations.apiproducts). A portal may have only one catalog item associated with a given API product.
  - `categoryIds` string[] — Optional. The IDs of the API categories to which this catalog item belongs.
  - `description` string — Optional. Description of the catalog item. Max length is 10,000 characters.
  - `edgeAPIProductName` string — Optional. Immutable. DEPRECATED: use the `apiProductName` field instead
  - `anonAllowed` boolean — Optional. Boolean flag that manages user access to the catalog item. When true, the catalog item has public visibility and can be viewed anonymously; otherwise, only registered users may view it. Note: when the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), and this flag is set to false, visibility is set to an indeterminate state and must be explicitly specified in the management UI (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)). Additionally, when enrolled in the audience management feature, updates to this flag will be ignored as visibility permissions must be updated in the management UI.
  - `published` boolean — Optional. Denotes whether the catalog item is published to the portal or is in a draft state. When the parent portal is enrolled in the [audience management feature](https://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-audience#enrolling_in_the_beta_release_of_the_audience_management_feature), the visibility can be set to public on creation by setting the anonAllowed flag to true or further managed in the management UI (see [Manage the visibility of an API in your portal](https://cloud.google.com/apigee/docs/api-platform/publish/portal/publish-apis#visibility)) before it can be visible to any users. If not enrolled in the audience management feature, the visibility is managed by the `anonAllowed` flag.
  - `modified` string, int64 — Output only. Time the catalog item was last modified in milliseconds since epoch.
  - `graphqlEndpointUrl` string — Optional. DEPRECATED: manage documentation through the `getDocumentation` and `updateDocumentation` methods
  - `requireCallbackUrl` boolean — Optional. Whether a callback URL is required when this catalog item's API product is enabled in a developer app. When true, a portal user will be required to input a URL when managing the app (this is typically used for the app's OAuth flow).
  - `specId` string — Optional. DEPRECATED: DO NOT USE
  - `imageUrl` string — Optional. Location of the image used for the catalog item in the catalog. This can be either an image with an external URL or a file path for [image files stored in the portal](/apigee/docs/api-platform/publish/portal/portal-files"), for example, `/files/book-tree.jpg`. When specifying the URL of an external image, the image won't be uploaded to your assets; additionally, loading the image in the integrated portal will be subject to its availability, which may be blocked or restricted by [content security policies](/apigee/docs/api-platform/publish/portal/csp). Max length of file path is 2,083 characters.
  - `siteId` string — Output only. The ID of the parent portal.
  - `id` string, int64 — Output only. The ID of the catalog item.
  - `title` string — Required. The user-facing name of the catalog item. `title` must be a non-empty string with a max length of 255 characters.

## Response `200`

Successful response

---

[API](https://skmtc.net/google/apis/apigee.md) · [All operations](https://skmtc.net/google/apis/apigee/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/apigee/versions/6e272fa448a7/schema)