Skip to content

integration.oracle.com/v1beta1

Back to API Reference

APIVersion: integration.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

No customer-visible package currently exposes integration.oracle.com/v1beta1.

Resources

Kind Scope Sample Packages
IntegrationInstance Namespaced Sample -

IntegrationInstance

Manage OCI Integration instances.

  • Plural: integrationinstances
  • Scope: Namespaced
  • APIVersion: integration.oracle.com/v1beta1
  • Sample: Sample (config/samples/integration_v1beta1_integrationinstance.yaml)
  • Packages: Not currently exposed by a customer-visible package.

Spec

IntegrationInstanceSpec defines the desired state of IntegrationInstance.

Field Description Type Required Default Enum
alternateCustomEndpoints A list of alternate custom endpoints to be used for the integration instance URL (contact Oracle for alternateCustomEndpoints availability for a specific instance). list[object] No - -
compartmentId Compartment Identifier. string Yes - -
consumptionModel Optional parameter specifying which entitlement to use for billing purposes. Only required if the account possesses more than one entitlement. string No - -
customEndpoint IntegrationInstanceCustomEndpoint defines nested fields for IntegrationInstance.CustomEndpoint. object No - -
definedTags Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
displayName Integration Instance Identifier. string Yes - -
domainId The OCID of the identity domain, that will be used to determine the corresponding Idcs Stripe and create an Idcs application within the stripe. This parameter is mutually exclusive with parameter: idcsAt, i.e only one of two parameters should be specified. string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
idcsAt IDCS Authentication token. This is required for all realms with IDCS. Its optional as its not required for non IDCS realms. string No - -
integrationInstanceType Standard or Enterprise type, Oracle Integration Generation 2 uses ENTERPRISE and STANDARD, Oracle Integration 3 uses ENTERPRISEX and STANDARDX string Yes - -
isByol Bring your own license. boolean Yes - -
isDisasterRecoveryEnabled Is Disaster Recovery enabled or not. boolean No - -
isFileServerEnabled The file server is enabled or not. boolean No - -
isVisualBuilderEnabled Visual Builder is enabled or not. boolean No - -
messagePacks The number of configured message packs integer Yes - -
networkEndpointDetails IntegrationInstanceNetworkEndpointDetails defines nested fields for IntegrationInstance.NetworkEndpointDetails. object No - -
securityAttributes Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} map[string, map[string, string]] No - -
shape Shape string No - -

Spec.alternateCustomEndpoints[]

Back to IntegrationInstance spec

IntegrationInstanceAlternateCustomEndpoint defines nested fields for IntegrationInstance.AlternateCustomEndpoint.

Field Description Type Required Default Enum
certificateSecretId Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname. All certificates should be stored in a single base64 encoded secret Note the update will fail if this is not a valid certificate. string No - -
hostname A custom hostname to be used for the integration instance URL, in FQDN format. string Yes - -

Spec.customEndpoint

Back to IntegrationInstance spec

IntegrationInstanceCustomEndpoint defines nested fields for IntegrationInstance.CustomEndpoint.

Field Description Type Required Default Enum
certificateSecretId Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname. All certificates should be stored in a single base64 encoded secret Note the update will fail if this is not a valid certificate. string No - -
hostname A custom hostname to be used for the integration instance URL, in FQDN format. string Yes - -

Spec.networkEndpointDetails

Back to IntegrationInstance spec

IntegrationInstanceNetworkEndpointDetails defines nested fields for IntegrationInstance.NetworkEndpointDetails.

Field Description Type Required Default Enum
allowlistedHttpIps Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. list[string] No - -
allowlistedHttpVcns Virtual Cloud Networks allowed to access this network endpoint. list[object] No - -
designTime IntegrationInstanceNetworkEndpointDetailsDesignTime defines nested fields for IntegrationInstance.NetworkEndpointDetails.DesignTime. object No - -
isIntegrationVcnAllowlisted The Integration service's VCN is allow-listed to allow integrations to call back into other integrations boolean No - -
jsonData - string No - -
networkEndpointType - string No - -
runtime IntegrationInstanceNetworkEndpointDetailsRuntime defines nested fields for IntegrationInstance.NetworkEndpointDetails.Runtime. object No - -

Spec.networkEndpointDetails.allowlistedHttpVcns[]

Back to IntegrationInstance spec

IntegrationInstanceNetworkEndpointDetailsAllowlistedHttpVcn defines nested fields for IntegrationInstance.NetworkEndpointDetails.AllowlistedHttpVcn.

Field Description Type Required Default Enum
allowlistedIps Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. list[string] No - -
id The Virtual Cloud Network OCID. string Yes - -

Spec.networkEndpointDetails.designTime

Back to IntegrationInstance spec

IntegrationInstanceNetworkEndpointDetailsDesignTime defines nested fields for IntegrationInstance.NetworkEndpointDetails.DesignTime.

Field Description Type Required Default Enum
allowlistedHttpIps Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. list[string] No - -
allowlistedHttpVcns Virtual Cloud Networks allowed to access this network endpoint. list[object] No - -

Spec.networkEndpointDetails.designTime.allowlistedHttpVcns[]

Back to IntegrationInstance spec

IntegrationInstanceNetworkEndpointDetailsDesignTimeAllowlistedHttpVcn defines nested fields for IntegrationInstance.NetworkEndpointDetails.DesignTime.AllowlistedHttpVcn.

Field Description Type Required Default Enum
allowlistedIps Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. list[string] No - -
id The Virtual Cloud Network OCID. string Yes - -

Spec.networkEndpointDetails.runtime

Back to IntegrationInstance spec

IntegrationInstanceNetworkEndpointDetailsRuntime defines nested fields for IntegrationInstance.NetworkEndpointDetails.Runtime.

Field Description Type Required Default Enum
allowlistedHttpIps Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. list[string] No - -
allowlistedHttpVcns Virtual Cloud Networks allowed to access this network endpoint. list[object] No - -

Spec.networkEndpointDetails.runtime.allowlistedHttpVcns[]

Back to IntegrationInstance spec

IntegrationInstanceNetworkEndpointDetailsRuntimeAllowlistedHttpVcn defines nested fields for IntegrationInstance.NetworkEndpointDetails.Runtime.AllowlistedHttpVcn.

Field Description Type Required Default Enum
allowlistedIps Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. list[string] No - -
id The Virtual Cloud Network OCID. string Yes - -

Status

IntegrationInstanceStatus defines the observed state of IntegrationInstance.

Field Description Type Required Default Enum
alternateCustomEndpoints A list of alternate custom endpoints used for the integration instance URL. list[object] No - -
attachments A list of associated attachments to other services list[object] No - -
compartmentId Compartment Identifier. string No - -
consumptionModel The entitlement used for billing purposes. string No - -
customEndpoint IntegrationInstanceCustomEndpoint defines nested fields for IntegrationInstance.CustomEndpoint. object No - -
dataRetentionPeriod Data retention period set for given integration instance string No - -
definedTags Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace": {"bar-key": "value"}} map[string, map[string, string]] No - -
disasterRecoveryDetails IntegrationInstanceDisasterRecoveryDetails defines nested fields for IntegrationInstance.DisasterRecoveryDetails. object No - -
displayName Integration Instance Identifier, can be renamed. string No - -
freeformTags Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} map[string, string] No - -
id Unique identifier that is immutable on creation. string No - -
idcsInfo IntegrationInstanceIdcsInfo defines nested fields for IntegrationInstance.IdcsInfo. object No - -
instanceDesignTimeUrl The Integration Instance Design Time URL string No - -
instanceUrl The Integration Instance URL. string No - -
integrationInstanceType Standard or Enterprise type, Oracle Integration Generation 2 uses ENTERPRISE and STANDARD, Oracle Integration 3 uses ENTERPRISEX, STANDARDX and HEALTHCARE string No - -
isByol Bring your own license. boolean No - -
isDisasterRecoveryEnabled Is Disaster Recovery enabled for the integrationInstance boolean No - -
isFileServerEnabled The file server is enabled or not. boolean No - -
isVisualBuilderEnabled VisualBuilder is enabled or not. boolean No - -
lifecycleDetails Additional details of lifecycleState or substates string No - -
lifecycleState The current state of the integration instance. string No - -
logGroupId OCID of LogAnalytics LogGroup, enabled for given integration instance string No - -
messagePacks The number of configured message packs (if any) integer No - -
networkEndpointDetails IntegrationInstanceNetworkEndpointDetails defines nested fields for IntegrationInstance.NetworkEndpointDetails. object No - -
privateEndpointOutboundConnection IntegrationInstancePrivateEndpointOutboundConnection defines nested fields for IntegrationInstance.PrivateEndpointOutboundConnection. object No - -
securityAttributes Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}} map[string, map[string, string]] No - -
shape Shape string No - -
stateMessage An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. string No - -
status - object Yes - -
systemTags Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated The time the the IntegrationInstance was created. An RFC3339 formatted datetime string. string No - -
timeUpdated The time the IntegrationInstance was updated. An RFC3339 formatted datetime string. string No - -

Status.alternateCustomEndpoints[]

Back to IntegrationInstance status

IntegrationInstanceAlternateCustomEndpoint defines nested fields for IntegrationInstance.AlternateCustomEndpoint.

Field Description Type Required Default Enum
certificateSecretId Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname. All certificates should be stored in a single base64 encoded secret Note the update will fail if this is not a valid certificate. string No - -
hostname A custom hostname to be used for the integration instance URL, in FQDN format. string Yes - -

Status.attachments[]

Back to IntegrationInstance status

IntegrationInstanceAttachment defines nested fields for IntegrationInstance.Attachment.

Field Description Type Required Default Enum
isImplicit * If role == PARENT, the attached instance was created by this service instance * If role == CHILD, this instance was created from attached instance on behalf of a user boolean No - -
targetId The OCID of the target instance (which could be any other OCI PaaS/SaaS resource), to which this instance is attached. string No - -
targetInstanceUrl The dataplane instance URL of the attached instance string No - -
targetRole The role of the target attachment. * PARENT - The target instance is the parent of this attachment. * CHILD - The target instance is the child of this attachment. string No - -
targetServiceType The type of the target instance, such as "FUSION". string No - -

Status.customEndpoint

Back to IntegrationInstance status

IntegrationInstanceCustomEndpoint defines nested fields for IntegrationInstance.CustomEndpoint.

Field Description Type Required Default Enum
certificateSecretId Optional OCID of a vault/secret containing a private SSL certificate bundle to be used for the custom hostname. All certificates should be stored in a single base64 encoded secret Note the update will fail if this is not a valid certificate. string No - -
hostname A custom hostname to be used for the integration instance URL, in FQDN format. string Yes - -

Status.disasterRecoveryDetails

Back to IntegrationInstance status

IntegrationInstanceDisasterRecoveryDetails defines nested fields for IntegrationInstance.DisasterRecoveryDetails.

Field Description Type Required Default Enum
crossRegionIntegrationInstanceDetails IntegrationInstanceDisasterRecoveryDetailsCrossRegionIntegrationInstanceDetails defines nested fields for IntegrationInstance.DisasterRecoveryDetails.CrossRegionIntegrationInstanceDetails. object No - -
regionalInstanceUrl Region specific instance url for the integration instance in the region string No - -
role Role of the integration instance in the region string No - -

Status.disasterRecoveryDetails.crossRegionIntegrationInstanceDetails

Back to IntegrationInstance status

IntegrationInstanceDisasterRecoveryDetailsCrossRegionIntegrationInstanceDetails defines nested fields for IntegrationInstance.DisasterRecoveryDetails.CrossRegionIntegrationInstanceDetails.

Field Description Type Required Default Enum
id Cross region integration instance identifier string No - -
region Cross region where integration instance is created string No - -
role Role of the integration instance in the region string No - -
timeRoleChanged Time when cross region integration instance role was changed string No - -

Status.idcsInfo

Back to IntegrationInstance status

IntegrationInstanceIdcsInfo defines nested fields for IntegrationInstance.IdcsInfo.

Field Description Type Required Default Enum
idcsAppDisplayName The IDCS application display name associated with the instance string No - -
idcsAppId The IDCS application ID associated with the instance string No - -
idcsAppLocationUrl URL for the location of the IDCS Application (used by IDCS APIs) string No - -
idcsAppName The IDCS application name associated with the instance string No - -
instancePrimaryAudienceUrl The URL used as the primary audience for integration flows in this instance type: string string No - -

Status.networkEndpointDetails

Back to IntegrationInstance status

IntegrationInstanceNetworkEndpointDetails defines nested fields for IntegrationInstance.NetworkEndpointDetails.

Field Description Type Required Default Enum
allowlistedHttpIps Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. list[string] No - -
allowlistedHttpVcns Virtual Cloud Networks allowed to access this network endpoint. list[object] No - -
designTime IntegrationInstanceNetworkEndpointDetailsDesignTime defines nested fields for IntegrationInstance.NetworkEndpointDetails.DesignTime. object No - -
isIntegrationVcnAllowlisted The Integration service's VCN is allow-listed to allow integrations to call back into other integrations boolean No - -
jsonData - string No - -
networkEndpointType - string No - -
runtime IntegrationInstanceNetworkEndpointDetailsRuntime defines nested fields for IntegrationInstance.NetworkEndpointDetails.Runtime. object No - -

Status.networkEndpointDetails.allowlistedHttpVcns[]

Back to IntegrationInstance status

IntegrationInstanceNetworkEndpointDetailsAllowlistedHttpVcn defines nested fields for IntegrationInstance.NetworkEndpointDetails.AllowlistedHttpVcn.

Field Description Type Required Default Enum
allowlistedIps Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. list[string] No - -
id The Virtual Cloud Network OCID. string Yes - -

Status.networkEndpointDetails.designTime

Back to IntegrationInstance status

IntegrationInstanceNetworkEndpointDetailsDesignTime defines nested fields for IntegrationInstance.NetworkEndpointDetails.DesignTime.

Field Description Type Required Default Enum
allowlistedHttpIps Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. list[string] No - -
allowlistedHttpVcns Virtual Cloud Networks allowed to access this network endpoint. list[object] No - -

Status.networkEndpointDetails.designTime.allowlistedHttpVcns[]

Back to IntegrationInstance status

IntegrationInstanceNetworkEndpointDetailsDesignTimeAllowlistedHttpVcn defines nested fields for IntegrationInstance.NetworkEndpointDetails.DesignTime.AllowlistedHttpVcn.

Field Description Type Required Default Enum
allowlistedIps Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. list[string] No - -
id The Virtual Cloud Network OCID. string Yes - -

Status.networkEndpointDetails.runtime

Back to IntegrationInstance status

IntegrationInstanceNetworkEndpointDetailsRuntime defines nested fields for IntegrationInstance.NetworkEndpointDetails.Runtime.

Field Description Type Required Default Enum
allowlistedHttpIps Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. list[string] No - -
allowlistedHttpVcns Virtual Cloud Networks allowed to access this network endpoint. list[object] No - -

Status.networkEndpointDetails.runtime.allowlistedHttpVcns[]

Back to IntegrationInstance status

IntegrationInstanceNetworkEndpointDetailsRuntimeAllowlistedHttpVcn defines nested fields for IntegrationInstance.NetworkEndpointDetails.Runtime.AllowlistedHttpVcn.

Field Description Type Required Default Enum
allowlistedIps Source IP addresses or IP address ranges ingress rules. (ex: "168.122.59.5", "10.20.30.0/26") An invalid IP or CIDR block will result in a 400 response. list[string] No - -
id The Virtual Cloud Network OCID. string Yes - -

Status.privateEndpointOutboundConnection

Back to IntegrationInstance status

IntegrationInstancePrivateEndpointOutboundConnection defines nested fields for IntegrationInstance.PrivateEndpointOutboundConnection.

Field Description Type Required Default Enum
isAllOutboundTrafficPrivate Indicates if all traffic should go through configured outbound connection boolean No - -
jsonData - string No - -
nsgIds One or more Network security group Ids. This is an optional argument. list[string] No - -
outboundConnectionType - string No - -
subnetId Customer Private Network VCN Subnet OCID. This is a required argument. string No - -

Status.status

Back to IntegrationInstance 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 IntegrationInstance 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 IntegrationInstance 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 IntegrationInstance status

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