How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Oracle Platforms Virtual Network API

The virtualNetwork API from Oracle Platforms — 176 operation(s) for virtualnetwork.

Oracle Platforms Virtual Network API is one of 11 APIs that Oracle Platforms publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, rate-limit docs, and pricing.

This API exposes 267 operations across 176 paths, and defines 279 schemas. It is described by OpenAPI 3.2.0, at version 20160918.

Requests are made against a single base URL, /20160918.

267 operations 176 paths 279 schemas 29 DELETE102 GET103 POST33 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20160918
Base URL
https://iaas.{region}.oraclecloud.com
License
Oracle Corporation
Resource Areas
1

Paths & Operations 267

Across 176 paths, the API surfaces 267 operations — 29 DELETE, 102 GET, 103 POST, 33 PUT. Each is listed below with its method, path, parameters, and response codes.

virtualNetwork 267
GET
/allowedPeerRegionsForRemotePeering
ListAllowedPeerRegionsForRemotePeering
ListAllowedPeerRegionsForRemotePeering → 200401500default
GET
/byoasns
ListByoasns
ListByoasns 8 params → 200400401404429500default
POST
/byoasns
CreateByoasn
CreateByoasn 2 params body → 200400401404409429500default
DELETE
/byoasns/{byoasnId}
DeleteByoasn
DeleteByoasn 3 params → 204400401404412429500default
GET
/byoasns/{byoasnId}
GetByoasn
GetByoasn 2 params → 200400401404429500default
PUT
/byoasns/{byoasnId}
UpdateByoasn
UpdateByoasn 3 params body → 200400401404412429500default
POST
/byoasns/{byoasnId}/actions/changeCompartment
ChangeByoasnCompartment
ChangeByoasnCompartment 4 params body → 204401404409412429500default
POST
/byoasns/{byoasnId}/actions/validate
ValidateByoasn
ValidateByoasn 4 params → 202400401404409412429500
GET
/byoipRanges
ListByoipRanges
ListByoipRanges 8 params → 200400401404500default
POST
/byoipRanges
CreateByoipRange
CreateByoipRange 2 params body → 200400401404409500default
DELETE
/byoipRanges/{byoipRangeId}
DeleteByoipRange
DeleteByoipRange 3 params → 202400401404412500default
GET
/byoipRanges/{byoipRangeId}
GetByoipRange
GetByoipRange 2 params → 200400401404500default
PUT
/byoipRanges/{byoipRangeId}
UpdateByoipRange
UpdateByoipRange 3 params body → 200400401404412500default
POST
/byoipRanges/{byoipRangeId}/actions/advertise
AdvertiseByoipRange
AdvertiseByoipRange 2 params → 204400401500default
POST
/byoipRanges/{byoipRangeId}/actions/changeCompartment
ChangeByoipRangeCompartment
ChangeByoipRangeCompartment 3 params body → 204401404409412500default
POST
/byoipRanges/{byoipRangeId}/actions/setOrigin/byoasn
SetOriginAsn
SetOriginAsn 4 params body → 202400401404409412429500
POST
/byoipRanges/{byoipRangeId}/actions/setOrigin/oracleAsn
SetOriginAsnToOracle
SetOriginAsnToOracle 3 params → 200400401404409412429500
POST
/byoipRanges/{byoipRangeId}/actions/validate
ValidateByoipRange
ValidateByoipRange 2 params → 202400401404500default
POST
/byoipRanges/{byoipRangeId}/actions/withdraw
WithdrawByoipRange
WithdrawByoipRange 2 params → 204400401500default
GET
/byoipRanges/{byoipRangeId}/byoipAllocatedRanges
ListByoipAllocatedRanges
ListByoipAllocatedRanges 4 params → 200400401404500default
GET
/captureFilters
ListCaptureFilters
ListCaptureFilters 8 params → 200401404500default
POST
/captureFilters
CreateCaptureFilter
CreateCaptureFilter 2 params body → 200400401404409500default
DELETE
/captureFilters/{captureFilterId}
DeleteCaptureFilter
DeleteCaptureFilter 3 params → 204401404412500default
GET
/captureFilters/{captureFilterId}
GetCaptureFilter
GetCaptureFilter 2 params → 200401404412500default
PUT
/captureFilters/{captureFilterId}
UpdateCaptureFilter
UpdateCaptureFilter 3 params body → 200400401404409412500default
POST
/captureFilters/{captureFilterId}/actions/changeCompartment
ChangeCaptureFilterCompartment
ChangeCaptureFilterCompartment 4 params body → 202401404409412500default
GET
/cpeDeviceShapes
ListCpeDeviceShapes
ListCpeDeviceShapes 3 params → 200401404500default
GET
/cpeDeviceShapes/{cpeDeviceShapeId}
GetCpeDeviceShape
GetCpeDeviceShape 2 params → 200401404500default
GET
/cpes
ListCpes
ListCpes 3 params → 200404500default
POST
/cpes
CreateCpe
CreateCpe 1 param body → 200400401404409500default
DELETE
/cpes/{cpeId}
DeleteCpe
DeleteCpe 2 params → 204401404412500default
GET
/cpes/{cpeId}
GetCpe
GetCpe 1 param → 200401404500default
PUT
/cpes/{cpeId}
UpdateCpe
UpdateCpe 2 params body → 200400401404409412500default
POST
/cpes/{cpeId}/actions/changeCompartment
ChangeCpeCompartment
ChangeCpeCompartment 3 params body → 204400401404409412500default
GET
/cpes/{cpeId}/cpeConfigContent
GetCpeDeviceConfigContent
GetCpeDeviceConfigContent 2 params → 200400401404500default
GET
/crossConnectGroups
ListCrossConnectGroups
ListCrossConnectGroups 7 params → 200401404500default
POST
/crossConnectGroups
CreateCrossConnectGroup
CreateCrossConnectGroup 1 param body → 200400401409500default
DELETE
/crossConnectGroups/{crossConnectGroupId}
DeleteCrossConnectGroup
DeleteCrossConnectGroup 2 params → 204401404412500default
GET
/crossConnectGroups/{crossConnectGroupId}
GetCrossConnectGroups
GetCrossConnectGroup 1 param → 200401404500default
PUT
/crossConnectGroups/{crossConnectGroupId}
UpdateCrossConnectGroup
UpdateCrossConnectGroup 2 params body → 200400401404409412500default
POST
/crossConnectGroups/{crossConnectGroupId}/actions/changeCompartment
ChangeCrossConnectGroupCompartment
ChangeCrossConnectGroupCompartment 3 params body → 204400401404409412500default
GET
/crossConnectLocations
ListCrossConnectLocations
ListCrossConnectLocations 3 params → 200401404500default
GET
/crossConnectPortSpeedShapes
ListCrossConnectPortSpeedShapes
ListCrossconnectPortSpeedShapes 3 params → 200401404500default
GET
/crossConnects
ListCrossConnects
ListCrossConnects 8 params → 200401404500default
POST
/crossConnects
CreateCrossConnect
CreateCrossConnect 1 param body → 200400401409500default
DELETE
/crossConnects/{crossConnectId}
DeleteCrossConnect
DeleteCrossConnect 2 params → 204401404412500default
GET
/crossConnects/{crossConnectId}
GetCrossConnect
GetCrossConnect 1 param → 200401404500default
PUT
/crossConnects/{crossConnectId}
UpdateCrossConnect
UpdateCrossConnect 2 params body → 200400401404409412500default
POST
/crossConnects/{crossConnectId}/actions/changeCompartment
ChangeCrossConnectCompartment
ChangeCrossConnectCompartment 3 params body → 204400401404409412500default
GET
/crossConnects/{crossConnectId}/letterOfAuthority
Gets the Letter of Authority associated with the mentioned cross-connect.
GetCrossConnectLetterOfAuthority 1 param → 200400401404500default
GET
/crossConnects/{crossConnectId}/status
GetCrossConnectStatus
GetCrossConnectStatus 1 param → 200401404500default
GET
/dhcps
ListDhcpOptions
ListDhcpOptions 8 params → 200401404500default
POST
/dhcps
CreateDhcpOptions
CreateDhcpOptions 1 param body → 200400401404409500default
DELETE
/dhcps/{dhcpId}
DeleteDhcpOptions
DeleteDhcpOptions 2 params → 200401404412500default
GET
/dhcps/{dhcpId}
GetDhcpOptions
GetDhcpOptions 1 param → 200401404500default
PUT
/dhcps/{dhcpId}
UpdateDhcpOptions
UpdateDhcpOptions 2 params body → 200400401404409412500default
POST
/dhcps/{dhcpId}/actions/changeCompartment
ChangeDhcpOptionsCompartment
ChangeDhcpOptionsCompartment 3 params body → 204401404409412500default
GET
/drgAttachments
ListDrgAttachments
ListDrgAttachments 12 params → 200401404500default
POST
/drgAttachments
CreateDrgAttachment
CreateDrgAttachment 1 param body → 200400401404409500default
DELETE
/drgAttachments/{drgAttachmentId}
DeleteDrgAttachment
DeleteDrgAttachment 2 params → 204401404412500default
GET
/drgAttachments/{drgAttachmentId}
GetDrgAttachment
GetDrgAttachment 1 param → 200401404500default
PUT
/drgAttachments/{drgAttachmentId}
UpdateDrgAttachment
UpdateDrgAttachment 2 params body → 200400401404409412500default
POST
/drgAttachments/{drgAttachmentId}/actions/removeExportDrgRouteDistribution
RemoveExportDrgRouteDistribution
RemoveExportDrgRouteDistribution 3 params → 200401404409412500default
GET
/drgRouteDistributions
ListDrgRouteDistributionStatements
ListDrgRouteDistributions 7 params → 200400401404500default
POST
/drgRouteDistributions
CreateDrgRouteDistribution
CreateDrgRouteDistribution 1 param body → 200400401404409500default
DELETE
/drgRouteDistributions/{drgRouteDistributionId}
DeleteDrgRouteDistribution
DeleteDrgRouteDistribution 2 params → 204401404409412500default
GET
/drgRouteDistributions/{drgRouteDistributionId}
GetDrgRouteDistribution
GetDrgRouteDistribution 1 param → 200400401404500default
PUT
/drgRouteDistributions/{drgRouteDistributionId}
UpdateDrgRouteDistribution
UpdateDrgRouteDistribution 2 params body → 200400401404409412500default
POST
/drgRouteDistributions/{drgRouteDistributionId}/actions/addDrgRouteDistributionStatements
AddDrgRouteDistributionStatements
AddDrgRouteDistributionStatements 1 param body → 200400401404409500default
POST
/drgRouteDistributions/{drgRouteDistributionId}/actions/removeDrgRouteDistributionStatements
RemoveDrgRouteDistributionStatements
RemoveDrgRouteDistributionStatements 1 param body → 200400401404409500default
POST
/drgRouteDistributions/{drgRouteDistributionId}/actions/updateDrgRouteDistributionStatements
UpdateDrgRouteDistributionStatements
UpdateDrgRouteDistributionStatements 1 param body → 200400401404409500default
GET
/drgRouteDistributions/{drgRouteDistributionId}/drgRouteDistributionStatements
ListDrgRouteDistributionStatements
ListDrgRouteDistributionStatements 5 params → 200400401404500default
GET
/drgRouteTables
ListDrgRouteTables
ListDrgRouteTables 8 params → 200400401404500default
POST
/drgRouteTables
CreateDrgRouteTable
CreateDrgRouteTable 1 param body → 200400401404409500default
DELETE
/drgRouteTables/{drgRouteTableId}
DeleteDrgRouteTable
DeleteDrgRouteTable 2 params → 204401404409412500default
GET
/drgRouteTables/{drgRouteTableId}
GetDrgRouteTable
GetDrgRouteTable 1 param → 200400401404500default
PUT
/drgRouteTables/{drgRouteTableId}
UpdateDrgRouteTable
UpdateDrgRouteTable 2 params body → 200400401404409412500default
POST
/drgRouteTables/{drgRouteTableId}/actions/addDrgRouteRules
AddDrgRouteRules
AddDrgRouteRules 2 params body → 200400401404409500default
POST
/drgRouteTables/{drgRouteTableId}/actions/removeDrgRouteRules
RemoveDrgRouteRules
RemoveDrgRouteRules 1 param body → 200400401404409500default
POST
/drgRouteTables/{drgRouteTableId}/actions/removeImportDrgRouteDistribution
RemoveImportDrgRouteDistribution
RemoveImportDrgRouteDistribution 3 params → 200401404409412500default
POST
/drgRouteTables/{drgRouteTableId}/actions/updateDrgRouteRules
UpdateDrgRouteRules
UpdateDrgRouteRules 1 param body → 200400401404409500default
GET
/drgRouteTables/{drgRouteTableId}/drgRouteRules
ListDrgRouteRules
ListDrgRouteRules 4 params → 200400401404500default
GET
/drgs
ListDrgs
ListDrgs 3 params → 200401404500default
POST
/drgs
CreateDrg
CreateDrg 1 param body → 200400401404409500default
DELETE
/drgs/{drgId}
DeleteDrg
DeleteDrg 2 params → 204401404500default
GET
/drgs/{drgId}
GetDrg
GetDrg 1 param → 200401404412500default
PUT
/drgs/{drgId}
UpdateDrg
UpdateDrg 2 params body → 200400401404409412500default
POST
/drgs/{drgId}/actions/getAllDrgAttachments
GetAllDrgAttachments
GetAllDrgAttachments 6 params → 202401404409412500default
POST
/drgs/{drgId}/actions/upgrade
UpgradeDrg
UpgradeDrg 3 params → 202401404409412500default
GET
/drgs/{drgId}/actions/upgradeStatus
UpgradeStatus
GetUpgradeStatus 2 params → 200401404412500default
GET
/drgs/{drgId}/redundancyStatus
GetDrgRedundancyStatus
GetDrgRedundancyStatus 2 params → 200401404500default
GET
/fastConnectProviderServices
ListFastConnectProviderServices
ListFastConnectProviderServices 3 params → 200401404500default
GET
/fastConnectProviderServices/{providerServiceId}
GetFastConnectProviderService
GetFastConnectProviderService 1 param → 200400401404500default
GET
/fastConnectProviderServices/{providerServiceId}/providerServiceKeys/{providerServiceKeyName}
GetFastConnectProviderServiceKey
GetFastConnectProviderServiceKey 2 params → 200400401404500default
GET
/fastConnectProviderServices/{providerServiceId}/virtualCircuitBandwidthShapes
ListFastConnectProviderVirtualCircuitBandwidthShapes
ListFastConnectProviderVirtualCircuitBandwidthShapes 3 params → 200400401404500default
GET
/internetGateways
ListInternetGateways
ListInternetGateways 8 params → 200401404500default
POST
/internetGateways
CreateInternetGateway
CreateInternetGateway 1 param body → 200400401404409500default
DELETE
/internetGateways/{igId}
DeleteInternetGateway
DeleteInternetGateway 2 params → 204401404412500default
GET
/internetGateways/{igId}
GetInternetGateway
GetInternetGateway 1 param → 200401404500default
PUT
/internetGateways/{igId}
UpdateInternetGateway
UpdateInternetGateway 2 params body → 200400401404409412500default
POST
/internetGateways/{igId}/actions/changeCompartment
ChangeInternetGatewayCompartment
ChangeInternetGatewayCompartment 3 params body → 204401404409412500default
POST
/ipInventory
ListIpInventory
ListIpInventory 1 param body → 200400401404409429500default
GET
/ipInventory/subnets/{subnetId}
GetSubnetIpInventory
GetSubnetIpInventory 2 params → 200400401404409429500default
GET
/ipInventory/subnets/{subnetId}/cidrs
GetSubnetCidrUtilization
GetSubnetCidrUtilization 2 params → 200400401404409429500default
POST
/ipInventory/vcns/{vcnId}/overlaps
GetIpInventoryVcnOverlap
GetVcnOverlap 3 params body → 200400401404409429500default
GET
/ipinventory/DataRequestId/{dataRequestId}
GetResourceIpInventory
GetResourceIpInventory 2 params → 200400401404409429500default
GET
/ipsecAlgorithms
GetAllowedIkeIPSecParameters
GetAllowedIkeIPSecParameters 1 param → 200401404429500default
GET
/ipsecConnections
ListIPSecConnections
ListIPSecConnections 5 params → 200401404500default
POST
/ipsecConnections
CreateIPSecConnection
CreateIPSecConnection 1 param body → 200400401404409500default
DELETE
/ipsecConnections/{ipscId}
DeleteIPSecConnection
DeleteIPSecConnection 2 params → 204401404412500default
GET
/ipsecConnections/{ipscId}
GetIPSecConnection
GetIPSecConnection 1 param → 200401404500default
PUT
/ipsecConnections/{ipscId}
UpdateIPSecConnection
UpdateIPSecConnection 2 params body → 200400401404409412500default
POST
/ipsecConnections/{ipscId}/actions/changeCompartment
ChangeIPSecConnectionCompartment
ChangeIPSecConnectionCompartment 3 params body → 204400401404409412500default
GET
/ipsecConnections/{ipscId}/cpeConfigContent
GetIpsecCpeDeviceConfigContent
GetIpsecCpeDeviceConfigContent 2 params → 200400401404500default
GET
/ipsecConnections/{ipscId}/deviceConfig
GetIPSecConnectionDeviceConfig
GetIPSecConnectionDeviceConfig 1 param → 200401404500default
GET
/ipsecConnections/{ipscId}/deviceStatus
GetIPSecConnectionDeviceStatus
GetIPSecConnectionDeviceStatus 1 param → 200401404500default
GET
/ipsecConnections/{ipscId}/tunnels
ListIPSecConnectionTunnels
ListIPSecConnectionTunnels 3 params → 200401404500default
GET
/ipsecConnections/{ipscId}/tunnels/{tunnelId}
GetIPSecConnectionTunnel
GetIPSecConnectionTunnel 2 params → 200401404500default
PUT
/ipsecConnections/{ipscId}/tunnels/{tunnelId}
UpdateIPSecConnectionTunnelDetails
UpdateIPSecConnectionTunnel 4 params body → 200400401404409412500default
GET
/ipsecConnections/{ipscId}/tunnels/{tunnelId}/error
GetIPSecConnectionTunnelError
GetIPSecConnectionTunnelError 2 params → 200204401404429500default
GET
/ipsecConnections/{ipscId}/tunnels/{tunnelId}/routes
ListIPSecConnectionTunnelRoutes
ListIPSecConnectionTunnelRoutes 5 params → 200401404429500default
GET
/ipsecConnections/{ipscId}/tunnels/{tunnelId}/sharedSecret
GetIPSecConnectionTunnelSharedSecret
GetIPSecConnectionTunnelSharedSecret 2 params → 200401404500default
PUT
/ipsecConnections/{ipscId}/tunnels/{tunnelId}/sharedSecret
UpdateIPSecConnectionTunnelSharedSecret
UpdateIPSecConnectionTunnelSharedSecret 3 params body → 200400401404409412500default
GET
/ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelDeviceConfig
GetTunnelCpeDeviceConfig
GetTunnelCpeDeviceConfig 3 params → 200401404500default
PUT
/ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelDeviceConfig
UpdateTunnelCpeDeviceConfig
UpdateTunnelCpeDeviceConfig 5 params body → 200400401404409412500default
GET
/ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelDeviceConfig/content
GetTunnelCpeDeviceConfigContent
GetTunnelCpeDeviceConfigContent 3 params → 200400401404500default
GET
/ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelSecurityAssociations
ListIPSecConnectionTunnelSecurityAssociations
ListIPSecConnectionTunnelSecurityAssociations 4 params → 200401404429500default
GET
/ipv6
ListIpv6s
ListIpv6s 8 params → 200400401404500default
POST
/ipv6
CreateIpv6
CreateIpv6 2 params body → 200400401404409500default
POST
/ipv6/actions/bulkCreateIpv6s
BulkCreateIpv6s
BulkCreateIpv6s 2 params body → 202400401404409429500default
POST
/ipv6/actions/bulkDeleteIpv6s
BulkDeleteIpv6s
BulkDeleteIpv6s 2 params body → 202400401404409412429500
POST
/ipv6/actions/bulkDetachIpv6s
BulkDetachIpv6s
BulkDetachIpv6s 2 params body → 202400401404409429500default
POST
/ipv6/actions/bulkUpdateIpv6s
BulkUpdateIpv6s
BulkUpdateIpv6s 2 params body → 202400401404409429500default
DELETE
/ipv6/{ipv6Id}
DeleteIpv6
DeleteIpv6 3 params → 204401404412500default
GET
/ipv6/{ipv6Id}
GetIpv6
GetIpv6 2 params → 200401404500default
PUT
/ipv6/{ipv6Id}
UpdateIpv6
UpdateIpv6 3 params body → 200400401404412500default
POST
/ipv6/{ipv6Id}/actions/detach
Ipv6VnicDetach
Ipv6VnicDetach 4 params → 200400401404409412429500
GET
/localPeeringGateways
ListLocalPeeringGateways
ListLocalPeeringGateways 4 params → 200400401404500default
POST
/localPeeringGateways
CreateLocalPeeringGateway
CreateLocalPeeringGateway 1 param body → 200400401404409500default
DELETE
/localPeeringGateways/{localPeeringGatewayId}
DeleteLocalPeeringGateway
DeleteLocalPeeringGateway 2 params → 204400401404412500default
GET
/localPeeringGateways/{localPeeringGatewayId}
GetLocalPeeringGateway
GetLocalPeeringGateway 1 param → 200400401404500default
PUT
/localPeeringGateways/{localPeeringGatewayId}
UpdateLocalPeeringGateway
UpdateLocalPeeringGateway 2 params body → 200400401404409412500default
POST
/localPeeringGateways/{localPeeringGatewayId}/actions/changeCompartment
ChangeLocalPeeringGatewayCompartment
ChangeLocalPeeringGatewayCompartment 3 params body → 204401404412409500default
POST
/localPeeringGateways/{localPeeringGatewayId}/actions/connect
ConnectLocalPeeringGateways
ConnectLocalPeeringGateways 1 param body → 204400401404409412500default
GET
/natGateways
ListNatGateways
ListNatGateways 8 params → 200400401404500default
POST
/natGateways
CreateNatGateway
CreateNatGateway 1 param body → 200400401404409500default
DELETE
/natGateways/{natGatewayId}
DeleteNatGateway
DeleteNatGateway 2 params → 204401404412500default
GET
/natGateways/{natGatewayId}
GetNatGateway
GetNatGateway 1 param → 200400401404500default
PUT
/natGateways/{natGatewayId}
UpdateNatGateway
UpdateNatGateway 2 params body → 200400401404409412500default
POST
/natGateways/{natGatewayId}/actions/changeCompartment
ChangeNatGatewayCompartment
ChangeNatGatewayCompartment 3 params body → 204400401404409412500default
GET
/networkSecurityGroups
ListNetworkSecurityGroups
ListNetworkSecurityGroups 9 params → 200400401404500default
POST
/networkSecurityGroups
CreateNetworkSecurityGroup
CreateNetworkSecurityGroup 1 param body → 200400401404409500default
DELETE
/networkSecurityGroups/{networkSecurityGroupId}
DeleteNetworkSecurityGroup
DeleteNetworkSecurityGroup 2 params → 204401404412500default
GET
/networkSecurityGroups/{networkSecurityGroupId}
GetNetworkSecurityGroup
GetNetworkSecurityGroup 1 param → 200400401404500default
PUT
/networkSecurityGroups/{networkSecurityGroupId}
UpdateNetworkSecurityGroup
UpdateNetworkSecurityGroup 2 params body → 200400401404409412500default
POST
/networkSecurityGroups/{networkSecurityGroupId}/actions/addSecurityRules
AddNetworkSecurityGroupSecurityRules
AddNetworkSecurityGroupSecurityRules 1 param body → 200400401404409500default
POST
/networkSecurityGroups/{networkSecurityGroupId}/actions/changeCompartment
ChangeNetworkSecurityGroupCompartment
ChangeNetworkSecurityGroupCompartment 3 params body → 204401404409412500default
POST
/networkSecurityGroups/{networkSecurityGroupId}/actions/removeSecurityRules
RemoveNetworkSecurityGroupSecurityRules
RemoveNetworkSecurityGroupSecurityRules 1 param body → 200400401404409500default
POST
/networkSecurityGroups/{networkSecurityGroupId}/actions/updateSecurityRules
UpdateNetworkSecurityGroupSecurityRules
UpdateNetworkSecurityGroupSecurityRules 1 param body → 200400401404409500default
GET
/networkSecurityGroups/{networkSecurityGroupId}/securityRules
ListNetworkSecurityGroupSecurityRules
ListNetworkSecurityGroupSecurityRules 6 params → 200400401404500default
GET
/networkSecurityGroups/{networkSecurityGroupId}/vnics
ListNetworkSecurityGroupVnics
ListNetworkSecurityGroupVnics 5 params → 200400401404500default
GET
/networkingTopology
Get a Virtual Networking topology for the current region
GetNetworkingTopology 6 params → 200400401404429500default
GET
/privateIps
ListPrivateIps
ListPrivateIps 8 params → 200400401404500default
POST
/privateIps
CreatePrivateIp
CreatePrivateIp 1 param body → 200400401404409500default
POST
/privateIps/actions/bulkCreatePrivateIps
BulkCreatePrivateIps
BulkCreatePrivateIps 2 params body → 202400401404409412429500
POST
/privateIps/actions/bulkDeletePrivateIps
BulkDeletePrivateIps
BulkDeletePrivateIps 2 params body → 202400401404409412429500
POST
/privateIps/actions/bulkDetachPrivateIps
DetachPrivateIps
BulkDetachPrivateIps 2 params body → 202400401404409412429500
POST
/privateIps/actions/bulkUpdatePrivateIps
UpdatePrivateIps
BulkUpdatePrivateIps 2 params body → 202400401404409429500default
DELETE
/privateIps/{privateIpId}
DeletePrivateIp
DeletePrivateIp 2 params → 204400401404412500default
GET
/privateIps/{privateIpId}
GetPrivateIp
GetPrivateIp 1 param → 200400401404500default
PUT
/privateIps/{privateIpId}
UpdatePrivateIp
UpdatePrivateIp 2 params body → 200400401404412500default
POST
/privateIps/{privateIpId}/actions/detach
PrivateIpVnicDetach
PrivateIpVnicDetach 4 params → 200400401404409412429500
GET
/publicIpPools
ListPublicIpPools
ListPublicIpPools 8 params → 200400401404500default
POST
/publicIpPools
CreatePublicIpPool
CreatePublicIpPool 2 params body → 200400401500default
DELETE
/publicIpPools/{publicIpPoolId}
DeletePublicIpPool
DeletePublicIpPool 3 params → 204400401404412500default
GET
/publicIpPools/{publicIpPoolId}
GetPublicIpPool
GetPublicIpPool 2 params → 200400401404500default
PUT
/publicIpPools/{publicIpPoolId}
UpdatePublicIpPool
UpdatePublicIpPool 3 params body → 200400401404412500default
POST
/publicIpPools/{publicIpPoolId}/actions/addCapacity
AddPublicIpPoolCapacity
AddPublicIpPoolCapacity 3 params body → 200400401409500default
POST
/publicIpPools/{publicIpPoolId}/actions/changeCompartment
ChangePublicIpPoolCompartment
ChangePublicIpPoolCompartment 3 params body → 204401404409412500default
POST
/publicIpPools/{publicIpPoolId}/actions/removeCapacity
RemovePublicIpPoolCapacity
RemovePublicIpPoolCapacity 3 params body → 200400401500default
GET
/publicIps
ListPublicIps
ListPublicIps 7 params → 200400401404500default
POST
/publicIps
CreatePublicIp
CreatePublicIp 1 param body → 200400401404409500default
POST
/publicIps/actions/getByIpAddress
GetPublicIpByIpAddress
GetPublicIpByIpAddress body → 200400401404500default
POST
/publicIps/actions/getByPrivateIpId
GetPublicIpByPrivateIpId
GetPublicIpByPrivateIpId body → 200400401404500default
DELETE
/publicIps/{publicIpId}
DeletePublicIp
DeletePublicIp 2 params → 204400401404412500default
GET
/publicIps/{publicIpId}
GetPublicIp
GetPublicIp 1 param → 200400401404500default
PUT
/publicIps/{publicIpId}
UpdatePublicIp
UpdatePublicIp 2 params body → 200400401404412500default
POST
/publicIps/{publicIpId}/actions/changeCompartment
ChangePublicIpCompartment
ChangePublicIpCompartment 3 params body → 204401404409412500default
GET
/remotePeeringConnections
ListRemotePeeringConnections
ListRemotePeeringConnections 4 params → 200400401404500default
POST
/remotePeeringConnections
CreateRemotePeeringConnection
CreateRemotePeeringConnection 1 param body → 200400401404409500default
DELETE
/remotePeeringConnections/{remotePeeringConnectionId}
DeleteRemotePeeringConnection
DeleteRemotePeeringConnection 2 params → 204401404500default
GET
/remotePeeringConnections/{remotePeeringConnectionId}
GetRemotePeeringConnection
GetRemotePeeringConnection 1 param → 200401404500default
PUT
/remotePeeringConnections/{remotePeeringConnectionId}
UpdateRemotePeeringConnection
UpdateRemotePeeringConnection 2 params body → 200400401404409500default
POST
/remotePeeringConnections/{remotePeeringConnectionId}/actions/changeCompartment
ChangeRemotePeeringConnectionCompartment
ChangeRemotePeeringConnectionCompartment 3 params body → 204400401404409412500default
POST
/remotePeeringConnections/{remotePeeringConnectionId}/actions/connect
ConnectRemotePeeringConnections
ConnectRemotePeeringConnections 1 param body → 204400401404409412500default
GET
/routeTables
ListRouteTables
ListRouteTables 8 params → 200401404500default
POST
/routeTables
CreateRouteTable
CreateRouteTable 1 param body → 200400401404409500default
DELETE
/routeTables/{rtId}
DeleteRouteTable
DeleteRouteTable 2 params → 204401404412500default
GET
/routeTables/{rtId}
GetRouteTable
GetRouteTable 1 param → 200401404500default
PUT
/routeTables/{rtId}
UpdateRouteTable
UpdateRouteTable 2 params body → 200400401404409412500default
POST
/routeTables/{rtId}/actions/changeCompartment
ChangeRouteTableCompartment
ChangeRouteTableCompartment 3 params body → 204401404409412500default
GET
/securityLists
ListSecurityLists
ListSecurityLists 8 params → 200401404500default
POST
/securityLists
CreateSecurityList
CreateSecurityList 1 param body → 200400401404409500default
DELETE
/securityLists/{securityListId}
DeleteSecurityList
DeleteSecurityList 2 params → 204401404412500default
GET
/securityLists/{securityListId}
GetSecurityList
GetSecurityList 1 param → 200401404500default
PUT
/securityLists/{securityListId}
UpdateSecurityList
UpdateSecurityList 2 params body → 200400401404409412500default
POST
/securityLists/{securityListId}/actions/changeCompartment
ChangeSecurityListCompartment
ChangeSecurityListCompartment 3 params body → 204401404409412500default
GET
/serviceGateways
ListServiceGateways
ListServiceGateways 7 params → 200401404500default
POST
/serviceGateways
CreateServiceGateway
CreateServiceGateway 1 param body → 200400401404409500default
DELETE
/serviceGateways/{serviceGatewayId}
DeleteServiceGateway
DeleteServiceGateway 2 params → 204401404500default
GET
/serviceGateways/{serviceGatewayId}
GetServiceGateway
GetServiceGateway 1 param → 200401404412500default
PUT
/serviceGateways/{serviceGatewayId}
UpdateServiceGateway
UpdateServiceGateway 2 params body → 200400401404409500default
POST
/serviceGateways/{serviceGatewayId}/actions/attachService
AttachService
AttachServiceId 2 params body → 200400401404409500default
POST
/serviceGateways/{serviceGatewayId}/actions/changeCompartment
ChangeServiceGatewayCompartment
ChangeServiceGatewayCompartment 3 params body → 204400401404409500default
POST
/serviceGateways/{serviceGatewayId}/actions/detachService
DetachService
DetachServiceId 2 params body → 200400401404409500default
GET
/services
ListServices
ListServices 2 params → 200500default
GET
/services/{serviceId}
GetService
GetService 1 param → 200500default
GET
/subnetTopology
Get virtual network subnet topology
GetSubnetTopology 7 params → 200400401404429500default
GET
/subnets
ListSubnets
ListSubnets 8 params → 200401404500default
POST
/subnets
CreateSubnet
CreateSubnet 1 param body → 200400401404409500default
DELETE
/subnets/{subnetId}
DeleteSubnet
DeleteSubnet 2 params → 204401404412500default
GET
/subnets/{subnetId}
GetSubnet
GetSubnet 1 param → 200401404500default
PUT
/subnets/{subnetId}
UpdateSubnet
UpdateSubnet 2 params body → 200400401404409412500default
POST
/subnets/{subnetId}/actions/addIpv4Cidr
AddIpv4SubnetCidr
AddIpv4SubnetCidr 4 params body → 202400401404409412429500
POST
/subnets/{subnetId}/actions/addIpv6Cidr
AddIpv6SubnetCidr
AddIpv6SubnetCidr 4 params body → 202400401404409412500
POST
/subnets/{subnetId}/actions/changeCompartment
ChangeSubnetCompartment
ChangeSubnetCompartment 3 params body → 202400401404409500default
POST
/subnets/{subnetId}/actions/modifyIpv4Cidr
ModifyIpv4SubnetCidr
ModifyIpv4SubnetCidr 4 params body → 202400401404409412429500
POST
/subnets/{subnetId}/actions/removeIpv4Cidr
RemoveIpv4SubnetCidr
RemoveIpv4SubnetCidr 4 params body → 202400401404409412429500
POST
/subnets/{subnetId}/actions/removeIpv6Cidr
RemoveIpv6SubnetCidr
RemoveIpv6SubnetCidr 4 params body → 202400401404409412500
GET
/vcnTopology
Get Virtual Network VCN topology
GetVcnTopology 7 params → 200400401404429500default
GET
/vcns
ListVcns
ListVcns 7 params → 200401404500default
POST
/vcns
CreateVcn
CreateVcn 1 param body → 200400401404409500default
DELETE
/vcns/{vcnId}
DeleteVcn
DeleteVcn 2 params → 204401404409412500default
GET
/vcns/{vcnId}
GetVcn
GetVcn 1 param → 200401404500default
PUT
/vcns/{vcnId}
UpdateVcn
UpdateVcn 2 params body → 200400401404409412500default
POST
/vcns/{vcnId}/actions/addCidr
AddVcnCidr
AddVcnCidr 4 params body → 202400401404409412500
POST
/vcns/{vcnId}/actions/addIpv6Cidr
AddVcnIpv6Cidr
AddIpv6VcnCidr 4 params body → 202400401404409412500
POST
/vcns/{vcnId}/actions/changeCompartment
ChangeVcnCompartment
ChangeVcnCompartment 3 params body → 202400401404409500default
POST
/vcns/{vcnId}/actions/modifyCidr
ModifyVcnCidr
ModifyVcnCidr 4 params body → 202400401404412500
POST
/vcns/{vcnId}/actions/removeCidr
RemoveVcnCidr
RemoveVcnCidr 4 params body → 202400401404409412500
POST
/vcns/{vcnId}/actions/removeIpv6Cidr
RemoveIpv6VcnCidr
RemoveIpv6VcnCidr 4 params body → 202400401404409412500
GET
/virtualCircuitBandwidthShapes
ListVirtualCircuitBandwidthShapes
ListVirtualCircuitBandwidthShapes 3 params → 200401404500default
GET
/virtualCircuits
ListVirtualCircuits
ListVirtualCircuits 7 params → 200400401404500default
POST
/virtualCircuits
CreateVirtualCircuit
CreateVirtualCircuit 1 param body → 200400401409500default
DELETE
/virtualCircuits/{virtualCircuitId}
DeleteVirtualCircuit
DeleteVirtualCircuit 2 params → 204401404412500default
GET
/virtualCircuits/{virtualCircuitId}
GetVirtualCircuit
GetVirtualCircuit 1 param → 200401404500default
PUT
/virtualCircuits/{virtualCircuitId}
UpdateVirtualCircuit
UpdateVirtualCircuit 2 params body → 200400401403404409412500
POST
/virtualCircuits/{virtualCircuitId}/actions/bulkAddPublicPrefixes
BulkAddVirtualCircuitPublicPrefixes
BulkAddVirtualCircuitPublicPrefixes 1 param body → 204400401404500default
POST
/virtualCircuits/{virtualCircuitId}/actions/bulkDeletePublicPrefixes
BulkDeleteVirtualCircuitPublicPrefixes
BulkDeleteVirtualCircuitPublicPrefixes 1 param body → 204400401404500default
POST
/virtualCircuits/{virtualCircuitId}/actions/changeCompartment
ChangeVirtualCircuitCompartment
ChangeVirtualCircuitCompartment 3 params body → 204400401404409412500default
GET
/virtualCircuits/{virtualCircuitId}/associatedTunnels
ListVirtualCircuitAssociatedTunnels
ListVirtualCircuitAssociatedTunnels 3 params → 200401404429500default
GET
/virtualCircuits/{virtualCircuitId}/crossConnectMappings
ListCrossConnectMappings
ListCrossConnectMappings 2 params → 200401404500default
GET
/virtualCircuits/{virtualCircuitId}/publicPrefixes
ListVirtualCircuitPublicPrefixes
ListVirtualCircuitPublicPrefixes 2 params → 200401404500default
GET
/vlans
ListVlans
ListVlans 9 params → 200400401404500default
POST
/vlans
CreateVlan
CreateVlan 2 params body → 200400401404409500default
DELETE
/vlans/{vlanId}
DeleteVlan
DeleteVlan 3 params → 204401404412500default
GET
/vlans/{vlanId}
GetVlan
GetVlan 2 params → 200401404500default
PUT
/vlans/{vlanId}
UpdateVlan
UpdateVlan 3 params body → 200400401404409412500default
POST
/vlans/{vlanId}/actions/changeCompartment
ChangeVlanCompartment
ChangeVlanCompartment 4 params body → 202400401404409500default
GET
/vnics/{vnicId}
GetVnic
GetVnic 1 param → 200401404500default
PUT
/vnics/{vnicId}
UpdateVnic
UpdateVnic 2 params body → 200400401404409412500default
GET
/vtaps
ListVtaps
ListVtaps 13 params → 200400401404500default
POST
/vtaps
CreateVtap
CreateVtap 2 params body → 200400401404409500default
DELETE
/vtaps/{vtapId}
DeleteVtap
DeleteVtap 3 params → 202401404409412500default
GET
/vtaps/{vtapId}
GetVtap
GetVtap 2 params → 200401404412500default
PUT
/vtaps/{vtapId}
UpdateVtap
UpdateVtap 3 params body → 202400401404409412500default
POST
/vtaps/{vtapId}/actions/changeCompartment
ChangeVtapCompartment
ChangeVtapCompartment 4 params body → 202401404409412500default

Schemas 279

The contract defines 279 schemas that model the data the API accepts and returns. The most detailed are VirtualCircuit (31 properties), Subnet (23 properties), Vtap (22 properties), Vcn (21 properties). Each schema is shown below with its type and property counts.

VirtualCircuitAssociatedTunnelDetails
object
Detailed private tunnel info associated with the virtual circuit.
3 properties 2 required
BulkDeleteVirtualCircuitPublicPrefixesDetails
object
1 property 1 required
CreateServiceGatewayDetails
object
7 properties 3 required
Topology
object
Defines the representation of a virtual network topology.
5 properties 5 required
UpdateNatGatewayDetails
object
5 properties
PublicIpPool
object
A public IP pool is a set of public IP addresses represented as one or more IPv4 CIDR blocks. Resources like load balancers and compute instances can be alloca…
8 properties 3 required
DefaultDrgRouteTables
object
The default DRG route table for this DRG. Each network type has a default DRG route table. You can update a network type to use a different DRG route table, bu…
4 properties
ByoipRangeVcnIpv6AllocationSummary
object
A summary of IPv6 prefix subranges currently allocated to a VCN.
4 properties
CreateRemotePeeringConnectionDetails
object
5 properties 2 required
VirtualCircuit
object
For use with Oracle Cloud Infrastructure FastConnect. A virtual circuit is an isolated network path that runs over one or more physical network connections to…
31 properties
CreateDrgRouteDistributionDetails
object
Details used to create an import route distribution. You can't create a new export route distribution.
5 properties 2 required
RemotePeeringConnection
object
A remote peering connection (RPC) is an object on a DRG that lets the VCN that is attached to the DRG peer with a VCN in a different region. Peering means that…
13 properties 8 required
IpInventorySubnetResourceCollection
object
The results returned by a ListIpInventorySubnet operation.
5 properties
UpdateNetworkSecurityGroupDetails
object
3 properties
CaptureFilter
object
A capture filter contains a set of [rules](/en/iaas/latest/datatypes/CaptureFilterRuleDetails) governing what traffic is mirrored for a [VTAP](/en/iaas/latest/…
9 properties 3 required
ChangeByoipRangeCompartmentDetails
object
The configuration details for the move operation.
1 property 1 required
UpdateTunnelCpeDeviceConfigDetails
object
1 property
IcmpOptions
object
Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in: - [ICMP Parameters](http://www.iana.org/assignments/…
2 properties 1 required
ChangeVirtualCircuitCompartmentDetails
object
The configuration details for the move operation.
1 property 1 required
CreateRouteTableDetails
object
6 properties 3 required
ChangeNetworkSecurityGroupCompartmentDetails
object
1 property 1 required
RemovePublicIpPoolCapacityDetails
object
The information needed to remove capacity from a public IP pool.
1 property 1 required
SecurityList
object
A set of virtual firewall rules for your VCN. Security lists are configured at the subnet level, but the rules are applied to the ingress and egress traffic fo…
10 properties 8 required
ServiceIdResponseDetails
object
2 properties 2 required
UpdateVirtualCircuitDetails
object
15 properties
BgpSessionInfo
object
Information for establishing a BGP session for the IPSec tunnel.
8 properties
PeerRegionForRemotePeering
object
Details about a region that supports remote VCN peering. For more information, see [VCN Peering](/iaas/Content/Network/Tasks/VCNpeering.htm).
1 property 1 required
AddSecurityRuleDetails
object
A rule for allowing inbound (INGRESS) or outbound (EGRESS) IP packets.
11 properties 2 required
UpdateDrgRouteTableDetails
object
Details used in a request to update a DRG route table. You can't assign a table to a virtual circuit or IPSec tunnel attachment if there is a static route rule…
5 properties
SetOriginAsnDetails
object
Update Origin ASN of a BYOIP Range
2 properties 1 required
EgressSecurityRule
object
A rule for allowing outbound IP packets.
8 properties 2 required
BulkDeleteIpv6sItem
object
A secondary IPv6 object to delete as part of a bulk deletion.
1 property 1 required
UpdateRemotePeeringConnectionDetails
object
3 properties
ChangeDhcpOptionsCompartmentDetails
object
The configuration details for the move operation.
1 property 1 required
VirtualCircuitRedundancyMetadata
object
This resource provides redundancy level details for the virtual circuit. For more about redundancy, see [FastConnect Redundancy Best Practices](/iaas/Content/N…
3 properties
BulkAddVirtualCircuitPublicPrefixesDetails
object
1 property 1 required
AddDrgRouteRuleDetails
object
Details needed when adding a DRG route rule.
3 properties 3 required
TunnelCpeDeviceConfig
object
The set of CPE configuration answers for the tunnel, which the customer provides in [UpdateTunnelCpeDeviceConfig](/en/iaas/latest/TunnelCpeDeviceConfig/UpdateT…
1 property
NetworkSecurityGroup
object
A network security group (NSG) provides virtual firewall rules for a specific set of [VNICs](/en/iaas/latest/Vnic/) in a VCN. Compare NSGs with [SecurityLists]…
8 properties 5 required
AddVcnCidrDetails
object
Details used to add a CIDR block to a VCN.
1 property 1 required
UpdateDrgRouteDistributionStatementDetails
object
Route distribution statements to update in the route distribution.
3 properties 1 required
ConnectLocalPeeringGatewaysDetails
object
Information about the other local peering gateway (LPG).
1 property 1 required
CpeDeviceConfigAnswer
object
An individual answer to a CPE device question. The answers correlate to the questions that are specific to the CPE device type (see the parameters attribute of…
2 properties
ChangeRemotePeeringConnectionCompartmentDetails
object
The configuration details for the move operation.
1 property 1 required
CreateCpeDetails
object
7 properties 2 required
UpdateDrgAttachmentDetails
object
7 properties
RemoveVcnIpv6CidrDetails
object
Details used when removing ULA or private IPv6 prefix or an IPv6 GUA assigned by Oracle or BYOIPv6 prefix. You can only remove one of these per request.
1 property
CreateIPSecTunnelEncryptionDomainDetails
object
Request to enable a multi-encryption domain policy on the IPSec tunnel. There can't be more than 50 security associations in use at one time. See [Encryption d…
2 properties
UdpOptions
object
Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all d…
2 properties
TcpOptions
object
Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all d…
2 properties
UpdateVlanDetails
object
5 properties
PublicIp
object
A public IP is a conceptual term that refers to a public IP address and related properties. The publicIp object is the API representation of a public IP. There…
15 properties
UpdateMacsecProperties
object
Properties used to update MACsec settings.
4 properties 1 required
Subnet
object
A logical subdivision of a VCN. Each subnet consists of a contiguous range of IP addresses that do not overlap with other subnets in the VCN. Example: 172.16.1…
23 properties 8 required
IPSecConnectionTunnel
object
Information about a single IPSec tunnel in an IPSec connection. This object does not include the tunnel's shared secret (pre-shared key), which is found in the…
19 properties 3 required
RemoveDrgRouteDistributionStatementsDetails
object
Details request to remove statements from a route distribution.
1 property
RemoveIpv4SubnetCidrDetails
object
Details object for removing an IPv4 prefix from a subnet.
1 property 1 required
UpdateRouteTableDetails
object
4 properties
DrgRouteRule
object
A DRG route rule is a mapping between a destination IP address range and a DRG attachment. The map is used to route matching packets. Traffic will be routed ac…
9 properties 5 required
UpdateInternetGatewayDetails
object
5 properties
IpInventoryVcnOverlapSummary
object
Provides the VCN overlap details.
4 properties
UpdateDrgRouteRulesDetails
object
Details used to update route rules in a DRG route table.
1 property
PrivateIp
object
A private IP is a conceptual term that refers to an IPv4 private IP address and related properties. The privateIp object is the API representation of a private…
18 properties
IPSecConnection
object
A connection between a DRG and CPE. This connection consists of multiple IPSec tunnels. Creating this connection is one of the steps required when setting up a…
13 properties 5 required
CreateDrgRouteTableDetails
object
Details used in a request to create a DRG route table.
6 properties 1 required
VirtualCircuitPublicPrefix
object
A public IP prefix and its details. With a public virtual circuit, the customer specifies the customer-owned public IP prefixes to advertise across the connect…
2 properties 2 required
CreateCaptureFilterDetails
object
A capture filter contains a set of rules governing what traffic a VTAP mirrors or a VCN flow log collects.
6 properties 2 required
UpdateDhcpDetails
object
4 properties
SecurityRule
object
A security rule is one of the items in a [NetworkSecurityGroup](/en/iaas/latest/NetworkSecurityGroup/). It is a virtual firewall rule for the VNICs in the netw…
14 properties 2 required
PublicIpPoolCollection
object
Results of a ListPublicIpPool operation.
1 property 1 required
DpdConfig
object
These configuration details are used for dead peer detection (DPD). DPD periodically checks the stability of the connection to the customer premises (CPE), and…
2 properties
BulkDetachPrivateIpsDetails
object
An object used to detatch Secondary IPv4 addresses with a bulk operation.
2 properties 1 required
RemoveVcnCidrDetails
object
Details for removing a CIDR block from a VCN.
1 property 1 required
ChangeServiceGatewayCompartmentDetails
object
The configuration details for the move operation.
1 property 1 required
AddDrgRouteDistributionStatementDetails
object
Details used to add a route distribution statement.
3 properties 3 required
ChangeNatGatewayCompartmentDetails
object
The configuration details for the move operation.
1 property 1 required
SubnetTopology
Defines the visualization of a subnet in a VCN. See [Network Visualizer Documentation](/iaas/Content/Network/Concepts/networkvisualizer.htm) for more informati…
CreateLocalPeeringGatewayDetails
object
7 properties 2 required
BulkDeleteIpv6sDetails
object
A secondary IPv6 address bulk deletion object.
3 properties 1 required
PhaseTwoConfigDetails
object
Configuration details for IPSec phase two configuration parameters.
6 properties
TunnelSecurityAssociationSummary
object
A summary of the IPSec tunnel security association details.
5 properties
FastConnectProviderServiceKey
object
A provider service key and its details. A provider service key is an identifier for a provider's virtual circuit.
3 properties 1 required
MacsecKey
object
An object defining the Secrets-in-Vault OCIDs representing the MACsec key.
4 properties 2 required
AddIpv4SubnetCidrDetails
object
Details used when adding an IPv4 prefix to a subnet.
1 property 1 required
CreateVcnDetails
object
15 properties 1 required
Ipv6
object
An IPv6 is a conceptual term that refers to an IPv6 address and related properties. The IPv6 object is the API representation of an IPv6. You can create and as…
16 properties 7 required
IPSecConnectionTunnelErrorDetails
object
Details for an error on an IPSec tunnel.
6 properties 6 required
ByoasnByoipRange
object
Information about 'ByoipRange' that has byoasn as origin.
4 properties 1 required
TunnelStatus
object
Deprecated. For tunnel information, instead see [IPSecConnectionTunnel](/en/iaas/latest/IPSecConnectionTunnel/).
4 properties 1 required
RemoveSubnetIpv6CidrDetails
object
Details object for removing an IPv6 prefix from a subnet.
1 property 1 required
IpInventoryCidrUtilizationSummary
object
The CIDR utilization details of a subnet.
3 properties
Drg
object
A dynamic routing gateway (DRG) is a virtual router that provides a path for private network traffic between networks. You use it with other Networking Service…
9 properties 3 required
RemoveDrgRouteRulesDetails
object
Details used in a request to remove static routes from a DRG route table.
1 property
DrgAttachment
object
A DRG attachment serves as a link between a DRG and a network resource. A DRG can be attached to a VCN, IPSec tunnel, remote peering connection, or virtual cir…
14 properties 4 required
ChangeRouteTableCompartmentDetails
object
The configuration details for the move operation.
1 property 1 required
CrossConnect
object
For use with Oracle Cloud Infrastructure FastConnect. A cross-connect represents a physical connection between an existing network and Oracle. Customers who ar…
16 properties
RouteRule
object
A mapping between a destination IP address range and a virtual device to route matching packets to (a target).
6 properties 1 required
ChangeIPSecConnectionCompartmentDetails
object
The configuration details for the move operation.
1 property 1 required
AddNetworkSecurityGroupSecurityRulesDetails
object
1 property
DhcpOption
object
A single DHCP option according to [RFC 1533](https://tools.ietf.org/html/rfc1533). The two options available to use are [DhcpDnsOption](/en/iaas/latest/DhcpDns…
1 property 1 required
CreateVtapDetails
object
These details are included in a request to create a virtual test access point (VTAP).
18 properties 4 required
UpdateNetworkSecurityGroupSecurityRulesDetails
object
1 property
ByoasnCollection
object
The results returned by a ListByoasn operation.
1 property 1 required
BulkDeletePrivateIpsDetails
object
Details used tp delete Secondary IPv4 objects in a bulk operation.
4 properties 1 required
AddPublicIpPoolCapacityDetails
object
The information used to add capacity to an IP pool.
2 properties 2 required
NatGateway
object
A NAT (Network Address Translation) gateway, which represents a router that lets instances without public IPs contact the public internet without exposing the…
12 properties 7 required
ByoipRangeOriginAsn
object
Information about the origin asn.
3 properties 1 required
CreateSecurityListDetails
object
7 properties 4 required
InventoryIpAddressSummary
object
Provides the IP address and its corresponding VNIC ID, VNIC name, and DNS hostname.
4 properties
CreateVlanDetails
object
10 properties 4 required
Cpe
object
An object you create when setting up a Site-to-Site VPN between your on-premises network and VCN. The Cpe is a virtual representation of your customer-premises…
9 properties 3 required
ChangeInternetGatewayCompartmentDetails
object
The configuration details for the move operation.
1 property 1 required
ChangeCaptureFilterCompartmentDetails
object
These configuration details are used in the move operation when changing the compartment containing a capture filter.
1 property 1 required
IpInventoryVcnOverlapCollection
object
The details of the overlapping VCNs and compartments.
4 properties
CreateIPSecConnectionTunnelDetails
object
13 properties
BulkDetachPrivateIpItem
object
An object used to detatch secondary private IPv4 addresses with a bulk operation.
1 property 1 required
UpdateSubnetDetails
object
8 properties
Vnic
object
A virtual network interface card. Each VNIC resides in a subnet in a VCN. An instance attaches to a VNIC to obtain a network connection into the VCN through th…
20 properties 5 required
CrossConnectStatus
object
The status of the cross-connect.
6 properties 1 required
CreateIpv6Details
object
11 properties
RouteTable
object
A collection of RouteRule objects, which are used to route packets based on destination IP to a particular network entity. For more information, see [Overview…
9 properties 5 required
CpeDeviceConfigQuestion
object
An individual question that the customer can answer about the CPE device. The customer provides answers to these questions in [UpdateTunnelCpeDeviceConfig](/en…
3 properties
NetworkingTopology
Defines the representation of a virtual network topology for a region. See [Network Visualizer Documentation](/iaas/Content/Network/Concepts/networkvisualizer.…
RemoveNetworkSecurityGroupSecurityRulesDetails
object
1 property
ChangeCrossConnectGroupCompartmentDetails
object
The configuration details for the move operation.
1 property 1 required
UpdateCrossConnectGroupDetails
object
5 properties
ByoipRangeCollection
object
The results returned by a ListByoipRange operation.
1 property 1 required
IPSecConnectionTunnelSharedSecret
object
The tunnel's shared secret (pre-shared key).
1 property 1 required
UpdateDrgRouteDistributionStatementsDetails
object
Details request to update statements in a route distribution.
1 property 1 required
BulkUpdatePrivateIpsDetails
object
Details used for a secondary IPv4 address bulk update.
2 properties 1 required
AddedNetworkSecurityGroupSecurityRules
object
1 property
CrossConnectMappingDetails
object
For use with Oracle Cloud Infrastructure FastConnect. Each [VirtualCircuit](/en/iaas/latest/VirtualCircuit/) runs on one or more cross-connects or cross-connec…
10 properties
TunnelConfig
object
Deprecated. For tunnel information, instead see: [IPSecConnectionTunnel](/en/iaas/latest/IPSecConnectionTunnel/) [IPSecConnectionTunnelSharedSecret](/en/iaas/l…
3 properties 2 required
UpdateCaptureFilterDetails
object
These details can be included in a request to update a capture filter. A capture filter contains a set of rules governing what traffic a VTAP mirrors or a VCN…
4 properties
UpdatePublicIpDetails
object
4 properties
MacsecProperties
object
Properties used for MACsec (if capable).
4 properties 1 required
ChangeVlanCompartmentDetails
object
The configuration details for the move operation.
1 property 1 required
VirtualCircuitBandwidthShape
object
An individual bandwidth level for virtual circuits.
2 properties 1 required
BulkDetachIpv6sItem
object
A secondary IPv6 object to detach as part of a bulk detach operation.
1 property 1 required
IpInventoryCidrUtilizationCollection
object
The IP Inventory CIDR utilization details of a subnet.
5 properties
DrgRedundancyStatus
object
The redundancy status of the DRG. For more information, see [Redundancy Remedies](/iaas/Content/Network/Troubleshoot/drgredundancy.htm).
2 properties
DrgRouteDistribution
object
A route distribution establishes how routes get imported into DRG route tables and exported through the DRG attachments. A route distribution is a list of stat…
9 properties 6 required
ByoipRange
object
Oracle offers the ability to Bring Your Own IP (BYOIP), importing public IP addresses or IPv6 addresses that you currently own to Oracle Cloud Infrastructure.…
16 properties 5 required
AddVcnIpv6CidrDetails
object
Details used when adding a ULA or private IPv6 prefix or an IPv6 GUA assigned by Oracle or a BYOIPv6 prefix. You can add only one of these per request.
3 properties
UpdateIPSecConnectionTunnelSharedSecretDetails
object
1 property
PortRange
object
2 properties 2 required
TopologyEntityRelationship
object
Defines the relationship between Virtual Network topology entities.
3 properties 3 required
LocalPeeringGateway
object
A local peering gateway (LPG) is an object on a VCN that lets that VCN peer with another VCN in the same region. Peering means that the two VCNs can communicat…
16 properties 9 required
CpeDeviceInfo
object
Basic information about a particular CPE device type.
2 properties
Service
object
An object that represents one or multiple Oracle services that you can enable for a [ServiceGateway](/en/iaas/latest/ServiceGateway/). In the User Guide topic…
4 properties 4 required
CreateIPSecConnectionDetails
object
10 properties 3 required
UpgradeStatus
object
The upgrade status of a DRG.
3 properties 3 required
CreateNetworkSecurityGroupDetails
object
5 properties 2 required
UpdateSecurityListDetails
object
5 properties
UpdateIpv6Details
object
7 properties
UpdateServiceGatewayDetails
object
6 properties
CreateIPSecTunnelBgpSessionDetails
object
5 properties
DrgRouteTable
object
All routing inside the DRG is driven by the contents of DRG route tables. DRG route tables contain rules which route packets to a particular network destinatio…
10 properties 6 required
CreateVirtualCircuitPublicPrefixDetails
object
1 property 1 required
CpeDeviceShapeSummary
object
A summary of information about a particular CPE device type. Compare with [CpeDeviceShapeDetail](/en/iaas/latest/CpeDeviceShapeDetail/).
2 properties
BulkCreateIpv6sItem
object
Secondary IPv6 object to use as part of bulk IPv6 object creation.
9 properties
GetPublicIpByIpAddressDetails
object
IP address of the public IP.
1 property 1 required
BulkCreateIpv6sDetails
object
Details needed to create secondary IPv6 addresses with a bulk operation.
3 properties 1 required
Byoipv6CidrDetails
object
The list of one or more BYOIPv6 prefixes for the VCN that meets the following criteria: - The prefix must be from a BYOIPv6 range. - The IPv6 prefixes must be…
2 properties 2 required
CreateDrgDetails
object
4 properties 1 required
CreateMacsecProperties
object
Properties used to configure MACsec (if capable).
4 properties 1 required
IpInventoryCollection
object
The results returned by a ListIpInventory operation.
5 properties
IngressSecurityRule
object
A rule for allowing inbound IP packets.
8 properties 2 required
UpdateMacsecKey
object
An object defining the OCID of the Secret held in Vault that represent the MACsec key.
4 properties 4 required
TunnelPhaseOneDetails
object
IPSec tunnel details specific to ISAKMP phase one.
11 properties
InventoryResourceSummary
object
Lists resources and its properties under a given subnet.
6 properties
CreateCrossConnectGroupDetails
object
6 properties 1 required
BulkUpdateIpv6sItem
object
A secondary IPv6 object to update as part of a bulk update.
7 properties 1 required
GetPublicIpByPrivateIpIdDetails
object
Details of the private IP that the public IP is assigned to.
1 property 1 required
DrgRouteDistributionStatement
object
A single statement within a route distribution. All match criteria in a statement must be met for the action to take place.
4 properties 4 required
CrossConnectPortSpeedShape
object
An individual port speed level for cross-connects.
2 properties 2 required
ChangeSecurityListCompartmentDetails
object
The configuration details for the move operation.
1 property 1 required
FastConnectProviderService
object
A service offering from a supported provider. For more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).
12 properties 10 required
ModifyVcnCidrDetails
object
Details for updating a CIDR block.
2 properties 2 required
ChangeCpeCompartmentDetails
object
The configuration details for the move operation.
1 property 1 required
ChangeCrossConnectCompartmentDetails
object
The configuration details for the move operation.
1 property 1 required
CreateDhcpDetails
object
6 properties 3 required
DrgRouteDistributionMatchCriteria
object
The match criteria in a route distribution statement. The match criteria outlines which routes should be imported or exported.
1 property 1 required
ModifyIpv4SubnetCidrDetails
object
Details object for updating the specified Ipv4 CIDR block of a Subnet.
2 properties 2 required
InventoryVcnSummary
object
Provides the summary of a VCN's IP Inventory data under specified compartments.
8 properties
DeleteVirtualCircuitPublicPrefixDetails
object
1 property 1 required
CreateByoasnDetails
object
The information used to create a Byoasn resource.
5 properties 3 required
ByoipAllocatedRangeSummary
object
A summary of CIDR block subranges that are currently allocated to an IP pool.
2 properties
CreatePublicIpPoolDetails
object
The information used to create a public IP pool.
4 properties 1 required
ChangeByoasnCompartmentDetails
object
The configuration details for the move operation.
1 property 1 required
DrgAttachmentNetworkCreateDetails
object
2 properties 1 required
ChangePublicIpCompartmentDetails
object
The configuration details for the move operation.
1 property 1 required
AddressType
string
Address type of the CIDR/IP within a VCN or subnet
CreateNatGatewayDetails
object
8 properties 2 required
PublicIpPoolSummary
object
Summary information about a public IP pool.
7 properties
UpdateLocalPeeringGatewayDetails
object
5 properties
AllowedIkeIPSecParameters
object
Lists the current allowed and default IPSec tunnel parameters.
4 properties 4 required
ServiceGateway
object
Represents a router that lets your VCN privately access specific Oracle services such as Object Storage without exposing the VCN to the public internet. Traffi…
11 properties 6 required
CreateInternetGatewayDetails
object
7 properties 3 required
UpdateIPSecTunnelEncryptionDomainDetails
object
Request to update a multi-encryption domain policy on the IPSec tunnel. There can't be more than 50 security associations in use at one time. See [Encryption d…
2 properties
InventoryVcnCidrBlockSummary
object
Lists the CIDRs and utilization within a VCN.
2 properties
UpdatePublicIpPoolDetails
object
The data to update for a public IP pool.
3 properties
CreateVirtualCircuitDetails
object
20 properties 2 required
DrgAttachmentInfo
object
The DrgAttachmentInfo resource contains the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment.
1 property 1 required
AddSubnetIpv6CidrDetails
object
Details used when adding an IPv6 prefix to a subnet.
1 property 1 required
CreatePrivateIpDetails
object
12 properties
EncryptionDomainConfig
object
Configuration information used by the encryption domain policy.
2 properties
DrgAttachmentNetworkDetails
object
2 properties 1 required
PhaseOneConfigDetails
object
Configuration details for IKE phase one (ISAKMP) configuration parameters.
5 properties
ServiceIdRequestDetails
object
1 property 1 required
UpdateCrossConnectDetails
object
Update a CrossConnect
6 properties
Error
object
5 properties 2 required
UpdatedNetworkSecurityGroupSecurityRules
object
1 property
UpdateDrgRouteRuleDetails
object
Details used to update a route rule in the DRG route table.
4 properties 1 required
CrossConnectMappingDetailsCollection
object
An array of CrossConnectMappingDetails
1 property 1 required
BulkDeletePrivateIpItem
object
Secondary private IPv4 address object to delete as part of a bulk operation.
1 property 1 required
UpdateDrgRouteDistributionDetails
object
Details used in a request to update a route distribution. You cannot assign a table to a virtual circuit or IPSec tunnel attachment if there is a static route…
3 properties
CreatePublicIpDetails
object
7 properties 2 required
CrossConnectLocation
object
An individual FastConnect location.
2 properties 2 required
CrossConnectMapping
object
For use with Oracle Cloud Infrastructure FastConnect. Each [VirtualCircuit](/en/iaas/latest/VirtualCircuit/) runs on one or more cross-connects or cross-connec…
7 properties
IPSecConnectionDeviceConfig
object
Deprecated. For tunnel information, instead see: [IPSecConnectionTunnel](/en/iaas/latest/IPSecConnectionTunnel/) [IPSecConnectionTunnelSharedSecret](/en/iaas/l…
4 properties 2 required
CreateMacsecKey
object
Defines the secret [OCID](/iaas/Content/General/Concepts/identifiers.htm)s held in Vault that represent the MACsec key.
2 properties 2 required
UpdateVnicDetails
object
8 properties
ListIpInventoryDetails
object
Required input parameters for retrieving IP Inventory data within the specified compartments of a region.
12 properties 2 required
CreateSubnetDetails
object
15 properties 2 required
AddDrgRouteRulesDetails
object
Details used in a request to add static routes to a DRG route table.
1 property
TunnelPhaseTwoDetails
object
IPsec tunnel detail information specific to phase two.
12 properties
ByoipAllocatedRangeCollection
object
Results of a ListByoipAllocatedRanges operation.
1 property 1 required
ChangeVtapCompartmentDetails
object
These configuration details are used in the move operation when changing the compartment containing a virtual test access point (VTAP).
1 property 1 required
CrossConnectGroup
object
For use with Oracle Cloud Infrastructure FastConnect. A cross-connect group is a link aggregation group (LAG), which can contain one or more [CrossConnects](/e…
12 properties
DefaultPhaseTwoParameters
object
Default phase two parameters.
3 properties
GetIpInventoryVcnOverlapDetails
object
Lists the compartment to find VCN overlap.
2 properties 2 required
NetworkSecurityGroupVnic
object
Information about a VNIC that belongs to a network security group.
3 properties 1 required
VtapCaptureFilterRuleDetails
object
This resource contains the rules governing what traffic a VTAP mirrors.
8 properties 1 required
BulkUpdateIpv6sDetails
object
Address details to update for a Secondary IPv6 object.
2 properties 1 required
CpeDeviceShapeDetail
object
The detailed information about a particular CPE device type. Compare with [CpeDeviceShapeSummary](/en/iaas/latest/CpeDeviceShapeSummary/).
4 properties
DhcpOptions
object
A set of DHCP options. Used by the VCN to automatically provide configuration information to the instances when they boot up. There are two options you can set…
9 properties 6 required
UpdatePrivateIpDetails
object
7 properties
UpdateCpeDetails
object
4 properties
Vcn
object
A virtual cloud network (VCN). For more information, see [Overview of the Networking Service](/iaas/Content/Network/Concepts/overview.htm). To use any of the A…
21 properties 5 required
AllowedPhaseTwoParameters
object
Allowed phase two parameters.
3 properties
CreateCrossConnectDetails
object
13 properties 3 required
CreateDrgAttachmentDetails
object
8 properties 1 required
UpdateIPSecTunnelBgpSessionDetails
object
5 properties
CreateByoipRangeDetails
object
The information used to create a ByoipRange resource.
6 properties 1 required
ByoasnSummary
object
Information about a Byoasn resource.
9 properties 4 required
ChangeVcnCompartmentDetails
object
The configuration details for the move operation.
1 property 1 required
UpdateByoasnDetails
object
The information used to update a Byoasn resource.
3 properties
ByoipRangeSummary
object
Information about a ByoipRange resource.
11 properties
BulkDetachIpv6sDetails
object
Details needed to bulk detach secondary IPv6 addresses.
2 properties 1 required
InventorySubnetCidrBlockSummary
object
Lists CIDRs and utilization within a subnet.
2 properties
IPSecConnectionDeviceStatus
object
Deprecated. For tunnel information, instead see [IPSecConnectionTunnel](/en/iaas/latest/IPSecConnectionTunnel/).
4 properties 2 required
UpdateDrgDetails
object
4 properties
AllowedPhaseOneParameters
object
Allowed phase one parameters.
3 properties
DefaultPhaseOneParameters
object
Default phase one parameters.
3 properties
ChangeLocalPeeringGatewayCompartmentDetails
object
The configuration details for the move operation.
1 property 1 required
UpdateIPSecConnectionTunnelDetails
object
9 properties
UpdateVcnDetails
object
6 properties
AddDrgRouteDistributionStatementsDetails
object
Details request to add statements to a route distribution.
1 property 1 required
Byoasn
object
Oracle offers the ability to Bring Your Own Autonomous System Number (BYOASN), importing AS Numbers you currently own to Oracle Cloud Infrastructure. A Byoasn…
12 properties 6 required
Vtap
object
A virtual test access point (VTAP) provides a way to mirror all traffic from a designated source to a selected target in order to facilitate troubleshooting, s…
22 properties 6 required
TunnelRouteSummary
object
A summary of the routes advertised to and received from the on-premises network.
5 properties
ConnectRemotePeeringConnectionsDetails
object
Information about the other remote peering connection (RPC).
2 properties 2 required
UpdateSecurityRuleDetails
object
A rule for allowing inbound (direction= INGRESS) or outbound (direction= EGRESS) IP packets.
12 properties 3 required
DrgAttachmentNetworkUpdateDetails
object
1 property 1 required
IpInventorySubnetResourceSummary
object
Provides the IP Inventory details of a subnet and its associated resources.
13 properties
UpdateVtapDetails
object
These details can be included in a request to update a virtual test access point (VTAP).
16 properties
UpdateIPSecConnectionDetails
object
6 properties
InternetGateway
object
Represents a router that connects the edge of a VCN with the Internet. For an example scenario that uses an internet gateway, see [Typical Networking Service S…
10 properties 4 required
VcnTopology
Defines the representation of a virtual network topology for a VCN. See [Network Visualizer Documentation](/iaas/Content/Network/Concepts/networkvisualizer.htm…
Vlan
object
A resource to be used only with the Oracle Cloud VMware Solution. Conceptually, a virtual LAN (VLAN) is a broadcast domain that is created by partitioning and…
13 properties 5 required
LetterOfAuthority
object
The Letter of Authority for the cross-connect. You must submit this letter when requesting cabling for the cross-connect at the FastConnect location.
7 properties
BulkUpdatePrivateIpItem
object
A secondary private IPv4 address object to update as part of a bulk operation.
7 properties 1 required
UpdateByoipRangeDetails
object
The information used to update a ByoipRange resource.
3 properties
BulkCreatePrivateIpsDetails
object
Details used to create secondary private IPv4 addresses in a bulk operation.
4 properties 1 required
BulkCreatePrivateIpItem
object
An object used to create secondary private IPv4 addresses in a bulk operation.
9 properties
ChangePublicIpPoolCompartmentDetails
object
The configuration details for the move operation.
1 property 1 required
InventorySubnetSummary
object
Lists subnet and its associated resources.
8 properties
ChangeSubnetCompartmentDetails
object
The configuration details for the move operation.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-platforms-virtualnetwork-api-openapi.yml Raw ↑

Other APIs Oracle Platforms publishes across the network.

Oracle Fusion Cloud ERP API
Oracle APEX REST APIs
Oracle Platforms Analytics API
Oracle Platforms Blockstorage API
Oracle Platforms Compute API
Oracle Platforms Compute Management API
Oracle Platforms Database API
Oracle Platforms Data Science API
Oracle Platforms Integration Instance API
Oracle Platforms Oce Instance API
Where this information came from

This is an independent, third-party profile of Oracle Platforms Virtual Network API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.