--- title: "POST /v1/organizations" method: POST path: "/v1/organizations" tags: ["organizations"] --- # POST /v1/organizations `POST /v1/organizations` Creates an Apigee organization. See [Create an Apigee organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org). ## Query parameters - `parent` string ## Request body - GoogleCloudApigeeV1Organization - `runtimeDatabaseEncryptionKeyName` string — Optional. Cloud KMS key name used for encrypting the data that is stored and replicated across runtime instances. Update is not allowed after the organization is created. If not specified or [RuntimeType](#RuntimeType) is `TRIAL`, a Google-Managed encryption key will be used. For example: "projects/foo/locations/us/keyRings/bar/cryptoKeys/baz". **Note:** Not supported for Apigee hybrid. - `apiConsumerDataLocation` string — Optional. This field is needed only for customers using non-default data residency regions. Apigee stores some control plane data only in single region. This field determines which single region Apigee should use. For example: "us-west1" when control plane is in US or "europe-west2" when control plane is in EU. - `customerName` string — Not used by Apigee. - `authorizedNetwork` string — Optional. Compute Engine network used for Service Networking to be peered with Apigee runtime instances. See [Getting started with the Service Networking API](https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started). Valid only when [RuntimeType](#RuntimeType) is set to `CLOUD`. The value must be set before the creation of a runtime instance and can be updated only when there are no runtime instances. For example: `default`. When changing authorizedNetwork, you must reconfigure VPC peering. After VPC peering with previous network is deleted, [run the following command](https://cloud.google.com/sdk/gcloud/reference/services/vpc-peerings/delete): `gcloud services vpc-peerings delete --network=NETWORK`, where `NETWORK` is the name of the previous network. This will delete the previous Service Networking. Otherwise, you will get the following error: `The resource 'projects/...-tp' is already linked to another shared VPC host 'projects/...-tp`. 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](https://cloud.google.com/vpc/docs/shared-vpc). 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` **Note:** Not supported for Apigee hybrid. - `expiresAt` string, int64 — Output only. Time that the Apigee organization is scheduled for deletion. - `networkEgressRestricted` boolean — Optional. Flag that specifies if internet egress is restricted for VPC Service Controls. Valid only when runtime_type is `CLOUD` and disable_vpc_peering is `true`. - `runtimeType` 'RUNTIME_TYPE_UNSPECIFIED' | 'CLOUD' | 'HYBRID' — Required. Runtime type of the Apigee organization based on the Apigee subscription purchased. - `subscriptionPlan` 'SUBSCRIPTION_PLAN_UNSPECIFIED' | 'SUBSCRIPTION_2021' | 'SUBSCRIPTION_2024' — Output only. Subscription plan that the customer has purchased. Output only. - `state` 'STATE_UNSPECIFIED' | 'CREATING' | 'ACTIVE' | 'DELETING' | 'UPDATING' — Output only. State of the organization. Values other than ACTIVE means the resource is not ready to use. - `billingType` 'BILLING_TYPE_UNSPECIFIED' | 'SUBSCRIPTION' | 'EVALUATION' | 'PAYG' — Optional. Billing type of the Apigee organization. See [Apigee pricing](https://cloud.google.com/apigee/pricing). - `lastModifiedAt` string, int64 — Output only. Time that the Apigee organization was last modified in milliseconds since epoch. - `addonsConfig` GoogleCloudApigeeV1AddonsConfig — Add-on configurations for the Apigee organization. - `integrationConfig` GoogleCloudApigeeV1IntegrationConfig — Configuration for the Integration add-on. - `enabled` boolean — Flag that specifies whether the Integration add-on is enabled. - `monetizationConfig` GoogleCloudApigeeV1MonetizationConfig — Configuration for the Monetization add-on. - `enabled` boolean — Flag that specifies whether the Monetization add-on is enabled. - `advancedApiOpsConfig` GoogleCloudApigeeV1AdvancedApiOpsConfig — Configuration for the Advanced API Ops add-on. - `enabled` boolean — Flag that specifies whether the Advanced API Ops add-on is enabled. - `connectorsPlatformConfig` GoogleCloudApigeeV1ConnectorsPlatformConfig — Configuration for the Connectors Platform add-on. - `expiresAt` string, int64 — Output only. Time at which the Connectors Platform add-on expires in milliseconds since epoch. If unspecified, the add-on will never expire. - `enabled` boolean — Flag that specifies whether the Connectors Platform add-on is enabled. - `analyticsConfig` GoogleCloudApigeeV1AnalyticsConfig — Configuration for the Analytics add-on. - `updateTime` string, google-datetime — Output only. The latest update time. - `enabled` boolean — Whether the Analytics add-on is enabled. - `state` 'ADDON_STATE_UNSPECIFIED' | 'ENABLING' | 'ENABLED' | 'DISABLING' | 'DISABLED' — Output only. The state of the Analytics add-on. - `expireTimeMillis` string, int64 — Output only. Time at which the Analytics add-on expires in milliseconds since epoch. If unspecified, the add-on will never expire. - `apiSecurityConfig` GoogleCloudApigeeV1ApiSecurityConfig — Configurations of the API Security add-on. - `enabled` boolean — Flag that specifies whether the API security add-on is enabled. - `expiresAt` string, int64 — Output only. Time at which the API Security add-on expires in milliseconds since epoch. If unspecified, the add-on will never expire. - `apigeeProjectId` string — Output only. Apigee Project ID associated with the organization. Use this project to allowlist Apigee in the Service Attachment when using private service connect with Apigee. - `createdAt` string, int64 — Output only. Time that the Apigee organization was created in milliseconds since epoch. - `controlPlaneEncryptionKeyName` string — Optional. Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Only used for the data residency region "US" or "EU". If not specified or [BillingType](#BillingType) is `EVALUATION`, a Google-Managed encryption key will be used. Format: `projects/*/locations/*/keyRings/*/cryptoKeys/*` - `type` 'TYPE_UNSPECIFIED' | 'TYPE_TRIAL' | 'TYPE_PAID' | 'TYPE_INTERNAL' — Not used by Apigee. - `disableVpcPeering` boolean — Optional. Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee. Valid only when RuntimeType is set to CLOUD. 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. - `caCertificate` string, byte — Output only. Deprecated: Use `ca_certificates` instead. Base64-encoded public certificate for the root CA of the Apigee organization. Valid only when [RuntimeType](#RuntimeType) is `CLOUD`. - `displayName` string — Optional. Display name for the Apigee organization. Unused, but reserved for future use. - `subscriptionType` 'SUBSCRIPTION_TYPE_UNSPECIFIED' | 'PAID' | 'TRIAL' — Output only. DEPRECATED: This will eventually be replaced by BillingType. Subscription type of the Apigee organization. Valid values include trial (free, limited, and for evaluation purposes only) or paid (full subscription has been purchased). See [Apigee pricing](https://cloud.google.com/apigee/pricing/). - `environments` string[] — Output only. List of environments in the Apigee organization. - `attributes` string[] — Not used by Apigee. - `portalDisabled` boolean — Optional. Configuration for the Portals settings. - `analyticsRegion` string — Required. DEPRECATED: This field will eventually be deprecated and replaced with a differently-named field. Primary Google Cloud region for analytics data storage. For valid values, see [Create an Apigee organization](https://cloud.google.com/apigee/docs/api-platform/get-started/create-org). - `description` string — Optional. Description of the Apigee organization. - `projectId` string — Output only. Project ID associated with the Apigee organization. - `name` string — Output only. Name of the Apigee organization. - `caCertificates` string[] — Output only. Base64-encoded public certificates for the root CA of the Apigee organization. Valid only when [RuntimeType](#RuntimeType) is `CLOUD`. Multiple certificates are used to support certificate rotation. - `properties` GoogleCloudApigeeV1Properties — Message for compatibility with legacy Edge specification for Java Properties object in JSON. - `property` GoogleCloudApigeeV1Property[] — List of all properties in the object - `name` string — The property key - `value` string — The property value - `apiConsumerDataEncryptionKeyName` string — Optional. Cloud KMS key name used for encrypting API consumer data. If not specified or [BillingType](#BillingType) is `EVALUATION`, a Google-Managed encryption key will be used. Format: `projects/*/locations/*/keyRings/*/cryptoKeys/*` ## 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)