Method: organizations.apis.create

Creates an API proxy. The API proxy created will not be accessible at runtime until it is deployed to an environment.

Create a new API proxy by setting the name query parameter to the name of the API proxy.

Import an API proxy configuration bundle stored in zip format on your local machine to your organization by doing the following:

  • Set the name query parameter to the name of the API proxy.
  • Set the action query parameter to import.
  • Set the Content-Type header to multipart/form-data.
  • Pass as a file the name of API proxy configuration bundle stored in zip format on your local machine using the file form field.

Note: To validate the API proxy configuration bundle only without importing it, set the action query parameter to validate.

When importing an API proxy configuration bundle, if the API proxy does not exist, it will be created. If the API proxy exists, then a new revision is created. Invalid API proxy configurations are rejected, and a list of validation errors is returned to the client.

HTTP request

POST https://apigee.googleapis.com/v1/{parent=organizations/*}/apis

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Name of the organization in the following format: organizations/{org}

Authorization requires the following IAM permission on the specified resource parent:

  • apigee.proxies.create

Query parameters

Parameters
name

string

Name of the API proxy. Restrict the characters used to: A-Za-z0-9._-
action

string

Action to perform when importing an API proxy configuration bundle. Set this parameter to one of the following values:

  • import to import the API proxy configuration bundle.
  • validate to validate the API proxy configuration bundle without importing it.
validate

boolean

Ignored. All uploads are validated regardless of the value of this field. Maintained for compatibility with Apigee Edge API.

Request body

The request body contains an instance of HttpBody.

Response body

If successful, the response body contains a newly created instance of ApiProxyRevision.

Authorization scopes

Requires the following OAuth scope:

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