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

# POST /v1/{+parent}/instances

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

Creates an Apigee runtime instance. The instance is accessible from the authorized network configured on the organization. **Note:** Not supported for Apigee hybrid.

## Path parameters

- `parent` string, required

## Request body

- GoogleCloudApigeeV1Instance — Apigee runtime instance.
  - `diskEncryptionKeyName` string — Optional. Customer Managed Encryption Key (CMEK) used for disk and volume encryption. If not specified, a Google-Managed encryption key will be used. Use the following format: `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`
  - `maintenanceUpdatePolicy` GoogleCloudApigeeV1MaintenanceUpdatePolicy — MaintenanceUpdatePolicy specifies the preferred window to perform maintenance on the instance (day of the week and time of day).
    - `maintenanceChannel` 'MAINTENANCE_CHANNEL_UNSPECIFIED' | 'WEEK1' | 'WEEK2' — Optional. Maintenance channel to specify relative scheduling for maintenance.
    - `maintenanceWindows` GoogleCloudApigeeV1MaintenanceUpdatePolicyMaintenanceWindow[] — Optional. Preferred windows to perform maintenance. Currently limited to 1.
      - `day` 'DAY_OF_WEEK_UNSPECIFIED' | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY' — Required. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.
      - `startTime` GoogleTypeTimeOfDay — Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.
        - `seconds` integer — Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
        - `hours` integer — Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
        - `nanos` integer — Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
        - `minutes` integer — Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
  - `peeringCidrRange` 'CIDR_RANGE_UNSPECIFIED' | 'SLASH_16' | 'SLASH_17' | 'SLASH_18' | 'SLASH_19' | 'SLASH_20' | 'SLASH_22' | 'SLASH_23' — Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support `SLASH_16` to `SLASH_20` and defaults to `SLASH_16`. Evaluation organizations support only `SLASH_23`.
  - `location` string — Required. Compute Engine location where the instance resides.
  - `port` string — Output only. Port number of the exposed Apigee endpoint.
  - `displayName` string — Optional. Display name for the instance.
  - `runtimeVersion` string — Output only. Version of the runtime system running in the instance. The runtime system is the set of components that serve the API Proxy traffic in your Environments.
  - `serviceAttachment` string — Output only. Resource name of the service attachment created for the instance in the format: `projects/*/regions/*/serviceAttachments/*` Apigee customers can privately forward traffic to this service attachment using the PSC endpoints.
  - `isVersionLocked` boolean — Output only. Indicates whether the instance is version locked. If true, the instance will not be updated by automated runtime rollouts. This is only supported for Apigee X instances.
  - `createdAt` string, int64 — Output only. Time the instance was created in milliseconds since epoch.
  - `lastModifiedAt` string, int64 — Output only. Time the instance was last modified in milliseconds since epoch.
  - `accessLoggingConfig` GoogleCloudApigeeV1AccessLoggingConfig — Access logging configuration enables customers to ship the access logs from the tenant projects to their own project's cloud logging. The feature is at the instance level ad disabled by default. It can be enabled during CreateInstance or UpdateInstance.
    - `enabled` boolean — Optional. Boolean flag that specifies whether the customer access log feature is enabled.
    - `filter` string — Optional. Ship the access log entries that match the status_code defined in the filter. The status_code is the only expected/supported filter field. (Ex: status_code) The filter will parse it to the Common Expression Language semantics for expression evaluation to build the filter condition. (Ex: "filter": status_code >= 200 && status_code < 300 )
  - `name` string — Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`.
  - `host` string — Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service.
  - `state` 'STATE_UNSPECIFIED' | 'CREATING' | 'ACTIVE' | 'DELETING' | 'UPDATING' — Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use.
  - `ipRange` string — Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 used to create the Apigee instance. Providing CIDR ranges is optional. You can provide just /22 or /28 or both (or neither). Ranges you provide should be freely available as part of a larger named range you have allocated to the Service Networking peering. If this parameter is not provided, Apigee automatically requests an available /22 and /28 CIDR block from Service Networking. Use the /22 CIDR block for configuring your firewall needs to allow traffic from Apigee. Input formats: `a.b.c.d/22` or `e.f.g.h/28` or `a.b.c.d/22,e.f.g.h/28`
  - `consumerAcceptList` string[] — Optional. Customer accept list represents the list of projects (id/number) on customer side that can privately connect to the service attachment. It is an optional field which the customers can provide during the instance creation. By default, the customer project associated with the Apigee organization will be included to the list.
  - `scheduledMaintenance` GoogleCloudApigeeV1ScheduledMaintenance — Scheduled maintenance information for an instance.
    - `startTime` string, google-datetime — Output only. The start time (UTC) of the scheduled maintenance.
  - `description` string — Optional. Description of the instance.

## 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)