Method: projects.provisionOrganization

Provisions a new Apigee organization with a functioning runtime. This is the standard way to create trial organizations for a free Apigee trial.

HTTP request

POST https://apigee.googleapis.com/v1/{project=projects/*}:provisionOrganization

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Required. Name of the Google Cloud project with which to associate the Apigee organization.

Request body

The request body contains data with the following structure:

JSON representation
{
  "authorizedNetwork": string,
  "disableVpcPeering": boolean,
  "analyticsRegion": string,
  "runtimeLocation": string
}
Fields
authorizedNetwork

string

Compute Engine network used for Service Networking to be peered with Apigee runtime instances. See Getting started with the Service Networking API.

Apigee also supports shared VPC (that is, the host network project is not the same as the one that is peering with Apigee). See Shared VPC overview. To use a shared VPC network, use the following format: projects/{host-project-id}/{region}/networks/{network-name}. For example: projects/my-sharedvpc-host/global/networks/mynetwork

disableVpcPeering

boolean

Optional. Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee.

Required if an authorizedNetwork on the consumer project is not provided, in which case the flag should be set to true. The value must be set before the creation of any Apigee runtime instance and can be updated only when there are no runtime instances.

Note: Apigee will be deprecating the vpc peering model that requires you to provide 'authorizedNetwork', by making the non-peering model as the default way of provisioning Apigee organization in future. So, this will be a temporary flag to enable the transition. Not supported for Apigee hybrid.

analyticsRegion

string

Primary Cloud Platform region for analytics data storage. For valid values, see Create an organization. Defaults to us-west1.

runtimeLocation

string

Cloud Platform location for the runtime instance. Defaults to zone us-west1-a. If a region is provided, EVAL organizations will use the region for automatically selecting a zone for the runtime instance.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

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