API Gateway: ApiGatewayDeployment

Manage OCI API Gateway deployment routes and backend bindings. This page is generated from checked-in package metadata, CRD schemas, and sample manifests.

Resource Snapshot

Field	Value
Service	apigateway
Resource	ApiGatewayDeployment
API Version	apigateway.oracle.com/v1beta1
Package	API Gateway
Support Status	Preview
Latest Released Version	v2.0.0-alpha
Install Namespace	oci-service-operator-apigateway-system

Quick Links

• Resource Guide Index
• Setup Guide
• Package Page
• API Reference
• Spec Reference
• Status Reference

Spec Fields

This summary shows the top-level spec fields. Use the full API reference for nested fields, defaults, and enum values.

Field	Description	Type	Required
compartmentId	CompartmentId is the OCID of the compartment in which to create the deployment.	string	Yes
definedTags	-	map[string, map[string, string]]	No
displayName	DisplayName is a user-friendly name for the deployment.	string	No
freeformTags	-	map[string, string]	No
gatewayId	GatewayId is the OCID of the API Gateway to deploy to. Validation: gatewayId is immutable.	string	Yes
id	The OCID of an existing Deployment to bind to.	string	No
pathPrefix	PathPrefix is the path prefix for all routes in this deployment. Validation: pathPrefix is immutable.	string	Yes
routes	Routes is the list of API routes in this deployment.	list[object]	No

Status Fields

This summary shows the top-level status fields. Use the full API reference for nested fields, defaults, and enum values.

Field	Description	Type	Required
status	-	object	Yes

Sample Manifest

No checked-in sample manifest currently exists for this resource.