oci-service-operator

apigateway.oracle.com/v1beta1

Back to API Reference

APIVersion: apigateway.oracle.com/v1beta1

This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.

Packages

Package	Support	Latest release	Resources
API Gateway	preview	v2.1.0-alpha	ApiGateway, ApiGatewayDeployment

Resources

Kind	Scope	Sample	Packages
ApiGateway	Namespaced	-	API Gateway (v2.1.0-alpha)
ApiGatewayDeployment	Namespaced	-	API Gateway (v2.1.0-alpha)

ApiGateway

Manage OCI API Gateway gateway resources.

• Plural: apigateways
• Scope: Namespaced
• APIVersion: apigateway.oracle.com/v1beta1
• Sample: No checked-in sample manifest currently exists.
• Packages: API Gateway (v2.1.0-alpha)

Spec

ApiGatewaySpec defines the desired state of ApiGateway.

Field	Description	Type	Required	Default	Enum
certificateId	CertificateId is the OCID of a certificate resource to use for HTTPS.	string	No	-	-
compartmentId	CompartmentId is the OCID of the compartment in which to create the gateway.	string	Yes	-	-
definedTags	-	map[string, map[string, string]]	No	-	-
displayName	DisplayName is a user-friendly name for the gateway.	string	No	-	-
endpointType	EndpointType is the gateway endpoint type. Validation: endpointType is immutable.	string	Yes	-	PRIVATE, PUBLIC
freeformTags	-	map[string, string]	No	-	-
id	The OCID of an existing ApiGateway to bind to.	string	No	-	-
networkSecurityGroupIds	NetworkSecurityGroupIds is an optional list of NSG OCIDs associated with the gateway.	list[string]	No	-	-
subnetId	SubnetId is the OCID of the subnet in which the gateway is created. Validation: subnetId is immutable.	string	Yes	-	-

Status

ApiGatewayStatus defines the observed state of ApiGateway.

Field	Description	Type	Required	Default	Enum
status	-	object	Yes	-	-

Status.status

Back to ApiGateway status

Field	Description	Type	Required	Default	Enum
async	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	object	No	-	-
conditions	-	list[object]	No	-	-
createdAt	-	string (date-time)	No	-	-
deletedAt	-	string (date-time)	No	-	-
message	-	string	No	-	-
ocid	-	string	No	-	-
opcRequestId	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	string	No	-	-
reason	-	string	No	-	-
requestedAt	-	string (date-time)	No	-	-
updatedAt	-	string (date-time)	No	-	-

Status.status.async

Back to ApiGateway status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
current	-	object	No	-	-

Status.status.async.current

Back to ApiGateway status

Field	Description	Type	Required	Default	Enum
message	-	string	No	-	-
normalizedClass	-	string	Yes	-	attention, canceled, failed, pending, succeeded, unknown
percentComplete	-	number	No	-	-
phase	-	string	Yes	-	create, delete, update
rawOperationType	-	string	No	-	-
rawStatus	-	string	No	-	-
source	-	string	Yes	-	lifecycle, none, workrequest
updatedAt	-	string (date-time)	Yes	-	-
workRequestId	-	string	No	-	-

Status.status.conditions[]

Back to ApiGateway status

Field	Description	Type	Required	Default	Enum
lastTransitionTime	-	string (date-time)	No	-	-
message	-	string	No	-	-
reason	-	string	No	-	-
status	-	string	Yes	-	-
type	-	string	Yes	-	-

ApiGatewayDeployment

Manage OCI API Gateway deployment routes and backend bindings.

• Plural: apigatewaydeployments
• Scope: Namespaced
• APIVersion: apigateway.oracle.com/v1beta1
• Sample: No checked-in sample manifest currently exists.
• Packages: API Gateway (v2.1.0-alpha)

Spec

ApiGatewayDeploymentSpec defines the desired state of ApiGatewayDeployment.

Field	Description	Type	Required	Default	Enum
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	-	-

Spec.routes[]

Back to ApiGatewayDeployment spec

ApiGatewayRoute defines a single route in a deployment specification.

Field	Description	Type	Required	Default	Enum
backend	Backend defines where the route sends traffic.	object	Yes	-	-
methods	Methods is the list of HTTP methods.	list[string]	No	-	-
path	Path is the route path.	string	Yes	-	-

Spec.routes[].backend

Back to ApiGatewayDeployment spec

Backend defines where the route sends traffic.

Field	Description	Type	Required	Default	Enum
body	Body is the response body for STOCK_RESPONSE_BACKEND.	string	No	-	-
functionId	FunctionId is the OCID of the Oracle Function for ORACLE_FUNCTIONS_BACKEND.	string	No	-	-
status	Status is the HTTP status code for STOCK_RESPONSE_BACKEND.	integer	No	-	-
type	Type is the backend type.	string	Yes	-	HTTP_BACKEND, ORACLE_FUNCTIONS_BACKEND, STOCK_RESPONSE_BACKEND
url	Url is the backend URL for HTTP_BACKEND.	string	No	-	-

Status

ApiGatewayDeploymentStatus defines the observed state of ApiGatewayDeployment.

Field	Description	Type	Required	Default	Enum
status	-	object	Yes	-	-

Status.status

Back to ApiGatewayDeployment status

Field	Description	Type	Required	Default	Enum
async	Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.	object	No	-	-
conditions	-	list[object]	No	-	-
createdAt	-	string (date-time)	No	-	-
deletedAt	-	string (date-time)	No	-	-
message	-	string	No	-	-
ocid	-	string	No	-	-
opcRequestId	OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact.	string	No	-	-
reason	-	string	No	-	-
requestedAt	-	string (date-time)	No	-	-
updatedAt	-	string (date-time)	No	-	-

Status.status.async

Back to ApiGatewayDeployment status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field	Description	Type	Required	Default	Enum
current	-	object	No	-	-

Status.status.async.current

Back to ApiGatewayDeployment status

Field	Description	Type	Required	Default	Enum
message	-	string	No	-	-
normalizedClass	-	string	Yes	-	attention, canceled, failed, pending, succeeded, unknown
percentComplete	-	number	No	-	-
phase	-	string	Yes	-	create, delete, update
rawOperationType	-	string	No	-	-
rawStatus	-	string	No	-	-
source	-	string	Yes	-	lifecycle, none, workrequest
updatedAt	-	string (date-time)	Yes	-	-
workRequestId	-	string	No	-	-

Status.status.conditions[]

Back to ApiGatewayDeployment status

Field	Description	Type	Required	Default	Enum
lastTransitionTime	-	string (date-time)	No	-	-
message	-	string	No	-	-
reason	-	string	No	-	-
status	-	string	Yes	-	-
type	-	string	Yes	-	-

This site is open source. Improve this page.