Method: organizations.sites.apidocs.listPublishableProducts

Lists the APIs that can be published to the portal.

HTTP request

GET https://apigee.googleapis.com/v1/{parent=organizations/*/sites/*}/apidocs:listPublishableProducts

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Use the following structure in your request: organizations/{org}/sites/{site}/apidocs:listPublishableProducts

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{
  "status": string,
  "message": string,
  "requestId": string,
  "errorCode": string,
  "data": [
    {
      object (PortalApiProduct)
    }
  ]
}
Fields
status

string

Status of the operation.

message

string

Description of the operation.

requestId

string

ID that can be used to find request details in the log files.

errorCode

string

ID that can be used to find errors in the log files.

data[]

object (PortalApiProduct)

List of publishable API products.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

PortalApiProduct

JSON representation
{
  "name": string,
  "displayName": string,
  "description": string,
  "status": string,
  "rights": string,
  "approvalType": string,
  "proxies": [
    string
  ],
  "isChecked": boolean,
  "isPublic": boolean
}
Fields
name

string

Name of the API product.

displayName

string

Display name for the API product used in the UI.

description

string

Description of the API product.

status

string

Status of the API product.

rights

string

Not used by Apigee hybrid.

approvalType

string

Approval type (automatic or manual).

proxies[]

string

List of API proxies available in the API product.

isChecked

boolean

Not used by Apigee hybrid.

isPublic

boolean

Boolean flag that specifies whether the API product is public or private.