{ "opencollection": "1.0.0", "info": { "name": "Core Services Virtual Network API", "version": "20160918" }, "items": [ { "info": { "name": "virtualNetwork", "type": "folder" }, "items": [ { "info": { "name": "ListAllowedPeerRegionsForRemotePeering", "type": "http" }, "http": { "method": "GET", "url": "/20160918/allowedPeerRegionsForRemotePeering" }, "docs": "Lists the regions that support remote VCN peering (which is peering across regions).\nFor more information, see [VCN Peering](/iaas/Content/Network/Tasks/VCNpeering.htm).\n" }, { "info": { "name": "ListByoasns", "type": "http" }, "http": { "method": "GET", "url": "/20160918/byoasns", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by, for byoasn List operation.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." } ] }, "docs": "Lists the `Byoasn` resources in the specified compartment.\nYou can filter the list using query parameters.\n" }, { "info": { "name": "CreateByoasn", "type": "http" }, "http": { "method": "POST", "url": "/20160918/byoasns", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a BYOASN Resource\n" }, { "info": { "name": "GetByoasn", "type": "http" }, "http": { "method": "GET", "url": "/20160918/byoasns/:byoasnId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "byoasnId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `Byoasn` resource." } ] }, "docs": "Gets the `Byoasn` resource. You must specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "UpdateByoasn", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/byoasns/:byoasnId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "byoasnId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `Byoasn` resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the tags or display name associated with the specified BYOASN Resource.\n" }, { "info": { "name": "DeleteByoasn", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/byoasns/:byoasnId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "byoasnId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `Byoasn` resource." } ] }, "docs": "Deletes the specified `Byoasn` resource.\nThe resource must be in one of the following states: CREATING, ACTIVE or FAILED.\nIt must not be in use by any of the byoipRanges or deletion will fail.\nYou must specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "ChangeByoasnCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/byoasns/:byoasnId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "byoasnId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `Byoasn` resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a BYOASN Resource to a different compartment. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "ValidateByoasn", "type": "http" }, "http": { "method": "POST", "url": "/20160918/byoasns/:byoasnId/actions/validate", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "byoasnId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `Byoasn` resource." } ] }, "docs": "Submits the BYOASN for validation. Please do not submit to Oracle for validation if the information for the BYOASN is not already modified in the Regional Internet Registry.\nSee [To import a BYOASN](/iaas/Content/Network/Concepts/BYOASN.htm) for details.\n" }, { "info": { "name": "ListByoipRanges", "type": "http" }, "http": { "method": "GET", "url": "/20160918/byoipRanges", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." } ] }, "docs": "Lists the `ByoipRange` resources in the specified compartment.\nYou can filter the list using query parameters.\n" }, { "info": { "name": "CreateByoipRange", "type": "http" }, "http": { "method": "POST", "url": "/20160918/byoipRanges", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a subrange of the BYOIP CIDR block.\n" }, { "info": { "name": "GetByoipRange", "type": "http" }, "http": { "method": "GET", "url": "/20160918/byoipRanges/:byoipRangeId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "byoipRangeId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block." } ] }, "docs": "Gets the `ByoipRange` resource. You must specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "UpdateByoipRange", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/byoipRanges/:byoipRangeId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "byoipRangeId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the tags or display name associated to the specified BYOIP CIDR block.\n" }, { "info": { "name": "DeleteByoipRange", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/byoipRanges/:byoipRangeId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "byoipRangeId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block." } ] }, "docs": "Deletes the specified `ByoipRange` resource.\nThe resource must be in one of the following states: CREATING, PROVISIONED, ACTIVE, or FAILED.\nIt must not have any subranges currently allocated to a PublicIpPool object or the deletion will fail.\nYou must specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm).\nIf the `ByoipRange` resource is currently in the PROVISIONED or ACTIVE state, it will be de-provisioned and then deleted.\n" }, { "info": { "name": "AdvertiseByoipRange", "type": "http" }, "http": { "method": "POST", "url": "/20160918/byoipRanges/:byoipRangeId/actions/advertise", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "byoipRangeId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block." } ] }, "docs": "Begins BGP route advertisements for the BYOIP CIDR block you imported to the Oracle Cloud.\nThe `ByoipRange` resource must be in the PROVISIONED state before the BYOIP CIDR block routes can be advertised with BGP.\n" }, { "info": { "name": "ChangeByoipRangeCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/byoipRanges/:byoipRangeId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "byoipRangeId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a BYOIP CIDR block to a different compartment. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "SetOriginAsn", "type": "http" }, "http": { "method": "POST", "url": "/20160918/byoipRanges/:byoipRangeId/actions/setOrigin/byoasn", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "byoipRangeId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update BYOIP's origin ASN to byoasn.\n" }, { "info": { "name": "SetOriginAsnToOracle", "type": "http" }, "http": { "method": "POST", "url": "/20160918/byoipRanges/:byoipRangeId/actions/setOrigin/oracleAsn", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "byoipRangeId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block." } ] }, "docs": "Update prefix's origin ASN to OCI\n" }, { "info": { "name": "ValidateByoipRange", "type": "http" }, "http": { "method": "POST", "url": "/20160918/byoipRanges/:byoipRangeId/actions/validate", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "byoipRangeId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block." } ] }, "docs": "Submits the BYOIP CIDR block you are importing for validation. Do not submit to Oracle for validation if you have not already\nmodified the information for the BYOIP CIDR block with your Regional Internet Registry. See [To import a CIDR block](/iaas/Content/Network/Concepts/BYOIP.htm#import_cidr) for details.\n" }, { "info": { "name": "WithdrawByoipRange", "type": "http" }, "http": { "method": "POST", "url": "/20160918/byoipRanges/:byoipRangeId/actions/withdraw", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "byoipRangeId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block." } ] }, "docs": "Withdraws BGP route advertisement for the BYOIP CIDR block.\n" }, { "info": { "name": "ListByoipAllocatedRanges", "type": "http" }, "http": { "method": "GET", "url": "/20160918/byoipRanges/:byoipRangeId/byoipAllocatedRanges", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "byoipRangeId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists the subranges of a BYOIP CIDR block currently allocated to an IP pool.\nEach `ByoipAllocatedRange` object also lists the IP pool where it is allocated.\n" }, { "info": { "name": "ListCaptureFilters", "type": "http" }, "http": { "method": "GET", "url": "/20160918/captureFilters", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given capture filter lifecycle state.\nThe state value is case-insensitive.\n" } ] }, "docs": "Lists the capture filters in the specified compartment.\n" }, { "info": { "name": "CreateCaptureFilter", "type": "http" }, "http": { "method": "POST", "url": "/20160918/captureFilters", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a virtual test access point (VTAP) capture filter in the specified compartment.\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains\nthe VTAP. For more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\nFor information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may o" }, { "info": { "name": "GetCaptureFilter", "type": "http" }, "http": { "method": "GET", "url": "/20160918/captureFilters/:captureFilterId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "captureFilterId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the capture filter." } ] }, "docs": "Gets information about the specified VTAP capture filter." }, { "info": { "name": "UpdateCaptureFilter", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/captureFilters/:captureFilterId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "captureFilterId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the capture filter." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified VTAP capture filter's display name or tags.\n" }, { "info": { "name": "DeleteCaptureFilter", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/captureFilters/:captureFilterId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "captureFilterId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the capture filter." } ] }, "docs": "Deletes the specified VTAP capture filter. This is an asynchronous operation. The VTAP capture filter's `lifecycleState` will\nchange to TERMINATING temporarily until the VTAP capture filter is completely removed.\n" }, { "info": { "name": "ChangeCaptureFilterCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/captureFilters/:captureFilterId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "captureFilterId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the capture filter." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a capture filter to a new compartment in the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "ListCpeDeviceShapes", "type": "http" }, "http": { "method": "GET", "url": "/20160918/cpeDeviceShapes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists the CPE device types that the Networking service provides CPE configuration\ncontent for (example: Cisco ASA). The content helps a network engineer configure\nthe actual CPE device represented by a [Cpe](#/en/iaas/latest/Cpe/) object.\n\nIf you want to generate CPE configuration content for one of the returned CPE device types,\nensure that the [Cpe](#/en/iaas/latest/Cpe/) object's `cpeDeviceShapeId` attribute is set\nto the CPE device type's [OCID](/iaas/Content/General/Concepts/identifiers.htm" }, { "info": { "name": "GetCpeDeviceShape", "type": "http" }, "http": { "method": "GET", "url": "/20160918/cpeDeviceShapes/:cpeDeviceShapeId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cpeDeviceShapeId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE device shape." } ] }, "docs": "Gets the detailed information about the specified CPE device type. This might include a set of questions\nthat are specific to the particular CPE device type. The customer must supply answers to those questions\n(see [UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig)).\nThe service merges the answers with a template of other information for the CPE device type. The following\noperations return the merged content:\n\n * [GetCpeDeviceConfigContent](#/en/ia" }, { "info": { "name": "ListCpes", "type": "http" }, "http": { "method": "GET", "url": "/20160918/cpes", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists the customer-premises equipment objects (CPEs) in the specified compartment.\n" }, { "info": { "name": "CreateCpe", "type": "http" }, "http": { "method": "POST", "url": "/20160918/cpes", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new virtual customer-premises equipment (CPE) object in the specified compartment. For\nmore information, see [Site-to-Site VPN Overview](/iaas/Content/Network/Tasks/overviewIPsec.htm).\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want\nthe CPE to reside. Notice that the CPE doesn't have to be in the same compartment as the IPSec\nconnection or other Networking Service components. If you're no" }, { "info": { "name": "GetCpe", "type": "http" }, "http": { "method": "GET", "url": "/20160918/cpes/:cpeId", "params": [ { "name": "cpeId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE." } ] }, "docs": "Gets the specified CPE's information." }, { "info": { "name": "UpdateCpe", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/cpes/:cpeId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "cpeId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified CPE's display name or tags.\nAvoid entering confidential information.\n" }, { "info": { "name": "DeleteCpe", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/cpes/:cpeId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "cpeId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE." } ] }, "docs": "Deletes the specified CPE object. The CPE must not be connected to a DRG. This is an asynchronous\noperation. The CPE's `lifecycleState` will change to TERMINATING temporarily until the CPE is completely\nremoved.\n" }, { "info": { "name": "ChangeCpeCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/cpes/:cpeId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "cpeId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a CPE object into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "GetCpeDeviceConfigContent", "type": "http" }, "http": { "method": "GET", "url": "/20160918/cpes/:cpeId/cpeConfigContent", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "cpeId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE." } ] }, "docs": "Renders a set of CPE configuration content that can help a network engineer configure the actual\nCPE device (for example, a hardware router) represented by the specified [Cpe](#/en/iaas/latest/Cpe/)\nobject.\n\nThe rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the\n[Cpe](#/en/iaas/latest/Cpe/) must have the CPE's device type specified by the `cpeDeviceShapeId`\nattribute. The content optionally includes answers that the customer provides (see\n[UpdateTunnel" }, { "info": { "name": "ListCrossConnectGroups", "type": "http" }, "http": { "method": "GET", "url": "/20160918/crossConnectGroups", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle\nstate. The value is case insensitive.\n" } ] }, "docs": "Lists the cross-connect groups in the specified compartment.\n" }, { "info": { "name": "CreateCrossConnectGroup", "type": "http" }, "http": { "method": "POST", "url": "/20160918/crossConnectGroups", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new cross-connect group to use with Oracle Cloud Infrastructure\nFastConnect. For more information, see\n[FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the\ncompartment where you want the cross-connect group to reside. If you're\nnot sure which compartment to use, put the cross-connect group in the\nsame compartment with your VCN. For more information " }, { "info": { "name": "GetCrossConnectGroups", "type": "http" }, "http": { "method": "GET", "url": "/20160918/crossConnectGroups/:crossConnectGroupId", "params": [ { "name": "crossConnectGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect group." } ] }, "docs": "Gets the specified cross-connect group's information." }, { "info": { "name": "UpdateCrossConnectGroup", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/crossConnectGroups/:crossConnectGroupId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "crossConnectGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified cross-connect group's display name.\nAvoid entering confidential information.\n" }, { "info": { "name": "DeleteCrossConnectGroup", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/crossConnectGroups/:crossConnectGroupId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "crossConnectGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect group." } ] }, "docs": "Deletes the specified cross-connect group. It must not contain any\ncross-connects, and it cannot be mapped to a\n[VirtualCircuit](#/en/iaas/latest/VirtualCircuit/).\n" }, { "info": { "name": "ChangeCrossConnectGroupCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/crossConnectGroups/:crossConnectGroupId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "crossConnectGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a cross-connect group into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "ListCrossConnectLocations", "type": "http" }, "http": { "method": "GET", "url": "/20160918/crossConnectLocations", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists the available FastConnect locations for cross-connect installation. You need\nthis information so you can specify your desired location when you create a cross-connect.\n" }, { "info": { "name": "ListCrossConnectPortSpeedShapes", "type": "http" }, "http": { "method": "GET", "url": "/20160918/crossConnectPortSpeedShapes", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists the available port speeds for cross-connects. You need this information\nso you can specify your desired port speed (that is, shape) when you create a\ncross-connect.\n" }, { "info": { "name": "ListCrossConnects", "type": "http" }, "http": { "method": "GET", "url": "/20160918/crossConnects", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "crossConnectGroupId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect group." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle\nstate. The value is case insensitive.\n" } ] }, "docs": "Lists the cross-connects in the specified compartment. You can filter the list\nby specifying the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a cross-connect group.\n" }, { "info": { "name": "CreateCrossConnect", "type": "http" }, "http": { "method": "POST", "url": "/20160918/crossConnects", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new cross-connect. Oracle recommends you create each cross-connect in a\n[CrossConnectGroup](#/en/iaas/latest/CrossConnectGroup) so you can use link aggregation\nwith the connection.\n\nAfter creating the `CrossConnect` object, you need to go the FastConnect location\nand request to have the physical cable installed. For more information, see\n[FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content" }, { "info": { "name": "GetCrossConnect", "type": "http" }, "http": { "method": "GET", "url": "/20160918/crossConnects/:crossConnectId", "params": [ { "name": "crossConnectId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect." } ] }, "docs": "Gets the specified cross-connect's information." }, { "info": { "name": "UpdateCrossConnect", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/crossConnects/:crossConnectId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "crossConnectId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified cross-connect." }, { "info": { "name": "DeleteCrossConnect", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/crossConnects/:crossConnectId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "crossConnectId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect." } ] }, "docs": "Deletes the specified cross-connect. It must not be mapped to a\n[VirtualCircuit](#/en/iaas/latest/VirtualCircuit/).\n" }, { "info": { "name": "ChangeCrossConnectCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/crossConnects/:crossConnectId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "crossConnectId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a cross-connect into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Gets the Letter of Authority associated with the mentioned cross-connect.", "type": "http" }, "http": { "method": "GET", "url": "/20160918/crossConnects/:crossConnectId/letterOfAuthority", "params": [ { "name": "crossConnectId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect." } ] }, "docs": "Gets the Letter of Authority for the specified cross-connect." }, { "info": { "name": "GetCrossConnectStatus", "type": "http" }, "http": { "method": "GET", "url": "/20160918/crossConnects/:crossConnectId/status", "params": [ { "name": "crossConnectId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect." } ] }, "docs": "Gets the status of the specified cross-connect.\n" }, { "info": { "name": "ListDhcpOptions", "type": "http" }, "http": { "method": "GET", "url": "/20160918/dhcps", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "vcnId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle\nstate. The state value is case-insensitive.\n" } ] }, "docs": "Lists the sets of DHCP options in the specified VCN and specified compartment.\nIf the VCN ID is not provided, then the list includes the sets of DHCP options from all VCNs in the specified compartment.\nThe response includes the default set of options that automatically comes with each VCN,\nplus any other sets you've created.\n" }, { "info": { "name": "CreateDhcpOptions", "type": "http" }, "http": { "method": "POST", "url": "/20160918/dhcps", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new set of DHCP options for the specified VCN. For more information, see\n[DhcpOptions](#/en/iaas/latest/DhcpOptions/).\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the set of\nDHCP options to reside. Notice that the set of options doesn't have to be in the same compartment as the VCN,\nsubnets, or other Networking Service components. If you're not sure which compartment to use, put the s" }, { "info": { "name": "GetDhcpOptions", "type": "http" }, "http": { "method": "GET", "url": "/20160918/dhcps/:dhcpId", "params": [ { "name": "dhcpId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the set of DHCP options." } ] }, "docs": "Gets the specified set of DHCP options." }, { "info": { "name": "UpdateDhcpOptions", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/dhcps/:dhcpId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "dhcpId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the set of DHCP options." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified set of DHCP options. You can update the display name or the options\nthemselves. Avoid entering confidential information.\n\nNote that the `options` object you provide replaces the entire existing set of options.\n" }, { "info": { "name": "DeleteDhcpOptions", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/dhcps/:dhcpId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "dhcpId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the set of DHCP options." } ] }, "docs": "Deletes the specified set of DHCP options, but only if it's not associated with a subnet. You can't delete a\nVCN's default set of DHCP options.\n\nThis is an asynchronous operation. The state of the set of options will switch to TERMINATING temporarily\nuntil the set is completely removed.\n" }, { "info": { "name": "ChangeDhcpOptionsCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/dhcps/:dhcpId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "dhcpId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the set of DHCP options." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a set of DHCP options into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "ListDrgAttachments", "type": "http" }, "http": { "method": "GET", "url": "/20160918/drgAttachments", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "vcnId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN." }, { "name": "drgId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "networkId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource (virtual circuit, VCN, IPSec tunnel, or remote peering connection) attached to the DRG." }, { "name": "attachmentType", "value": "", "type": "query", "description": "The type for the network resource attached to the DRG." }, { "name": "drgRouteTableId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table assigned to the DRG attachment." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle\nstate. The value is case insensitive.\n" } ] }, "docs": "Lists the `DrgAttachment` resource for the specified compartment. You can filter the\nresults by DRG, attached network, attachment type, DRG route table or\nVCN route table.\n\nThe LIST API lists DRG attachments by attachment type. It will default to list VCN attachments,\nbut you may request to list ALL attachments of ALL types.\n" }, { "info": { "name": "CreateDrgAttachment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/drgAttachments", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Attaches the specified DRG to the specified network resource. A VCN can be attached to only one DRG\nat a time, but a DRG can be attached to more than one VCN. The response includes a `DrgAttachment`\nobject with its own [OCID](/iaas/Content/General/Concepts/identifiers.htm). For more information about DRGs, see\n[Dynamic Routing Gateways (DRGs)](/iaas/Content/Network/Tasks/managingDRGs.htm).\n\nYou may optionally specify a *display name* for the attachment, otherwise a default is provided.\nIt does n" }, { "info": { "name": "GetDrgAttachment", "type": "http" }, "http": { "method": "GET", "url": "/20160918/drgAttachments/:drgAttachmentId", "params": [ { "name": "drgAttachmentId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment." } ] }, "docs": "Gets the `DrgAttachment` resource." }, { "info": { "name": "UpdateDrgAttachment", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/drgAttachments/:drgAttachmentId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "drgAttachmentId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the display name and routing information for the specified `DrgAttachment`.\nAvoid entering confidential information.\n" }, { "info": { "name": "DeleteDrgAttachment", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/drgAttachments/:drgAttachmentId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "drgAttachmentId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment." } ] }, "docs": "Detaches a DRG from a network resource by deleting the corresponding `DrgAttachment` resource. This is an asynchronous\noperation. The attachment's `lifecycleState` will temporarily change to DETACHING until the attachment\nis completely removed.\n" }, { "info": { "name": "RemoveExportDrgRouteDistribution", "type": "http" }, "http": { "method": "POST", "url": "/20160918/drgAttachments/:drgAttachmentId/actions/removeExportDrgRouteDistribution", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "drgAttachmentId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment." } ] }, "docs": "Removes the export route distribution from the DRG attachment so no routes are advertised to it.\n" }, { "info": { "name": "ListDrgRouteDistributionStatements", "type": "http" }, "http": { "method": "GET", "url": "/20160918/drgRouteDistributions", "params": [ { "name": "drgId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter that only returns resources that match the specified lifecycle\nstate. The value is case insensitive.\n" } ] }, "docs": "Lists the route distributions in the specified DRG.\n\nTo retrieve the statements in a distribution, use the\nListDrgRouteDistributionStatements operation.\n" }, { "info": { "name": "CreateDrgRouteDistribution", "type": "http" }, "http": { "method": "POST", "url": "/20160918/drgRouteDistributions", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new route distribution for the specified DRG.\nAssign the route distribution as an import distribution to a DRG route table using the `UpdateDrgRouteTable` or `CreateDrgRouteTable` operations.\nAssign the route distribution as an export distribution to a DRG attachment\nusing the `UpdateDrgAttachment` or `CreateDrgAttachment` operations.\n" }, { "info": { "name": "GetDrgRouteDistribution", "type": "http" }, "http": { "method": "GET", "url": "/20160918/drgRouteDistributions/:drgRouteDistributionId", "params": [ { "name": "drgRouteDistributionId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution." } ] }, "docs": "Gets the specified route distribution's information." }, { "info": { "name": "UpdateDrgRouteDistribution", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/drgRouteDistributions/:drgRouteDistributionId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "drgRouteDistributionId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified route distribution\n" }, { "info": { "name": "DeleteDrgRouteDistribution", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/drgRouteDistributions/:drgRouteDistributionId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "drgRouteDistributionId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution." } ] }, "docs": "Deletes the specified route distribution. You can't delete a route distribution currently in use by a DRG attachment or DRG route table.\n\nRemove the DRG route distribution from a DRG attachment or DRG route table by using the \"RemoveExportDrgRouteDistribution\" or \"RemoveImportDrgRouteDistribution' operations.\n" }, { "info": { "name": "AddDrgRouteDistributionStatements", "type": "http" }, "http": { "method": "POST", "url": "/20160918/drgRouteDistributions/:drgRouteDistributionId/actions/addDrgRouteDistributionStatements", "params": [ { "name": "drgRouteDistributionId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds one or more route distribution statements to the specified route distribution.\n" }, { "info": { "name": "RemoveDrgRouteDistributionStatements", "type": "http" }, "http": { "method": "POST", "url": "/20160918/drgRouteDistributions/:drgRouteDistributionId/actions/removeDrgRouteDistributionStatements", "params": [ { "name": "drgRouteDistributionId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes one or more route distribution statements from the specified route distribution's map.\n" }, { "info": { "name": "UpdateDrgRouteDistributionStatements", "type": "http" }, "http": { "method": "POST", "url": "/20160918/drgRouteDistributions/:drgRouteDistributionId/actions/updateDrgRouteDistributionStatements", "params": [ { "name": "drgRouteDistributionId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more route distribution statements in the specified route distribution.\n" }, { "info": { "name": "ListDrgRouteDistributionStatements", "type": "http" }, "http": { "method": "GET", "url": "/20160918/drgRouteDistributions/:drgRouteDistributionId/drgRouteDistributionStatements", "params": [ { "name": "drgRouteDistributionId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" } ] }, "docs": "Lists the statements for the specified route distribution." }, { "info": { "name": "ListDrgRouteTables", "type": "http" }, "http": { "method": "GET", "url": "/20160918/drgRouteTables", "params": [ { "name": "drgId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "importDrgRouteDistributionId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the import route distribution.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter that only returns matches for the specified lifecycle\nstate. The value is case insensitive.\n" } ] }, "docs": "Lists the DRG route tables for the specified DRG.\n\nUse the `ListDrgRouteRules` operation to retrieve the route rules in a table.\n" }, { "info": { "name": "CreateDrgRouteTable", "type": "http" }, "http": { "method": "POST", "url": "/20160918/drgRouteTables", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new DRG route table for the specified DRG. Assign the DRG route table to a DRG attachment\nusing the `UpdateDrgAttachment` or `CreateDrgAttachment` operations.\n" }, { "info": { "name": "GetDrgRouteTable", "type": "http" }, "http": { "method": "GET", "url": "/20160918/drgRouteTables/:drgRouteTableId", "params": [ { "name": "drgRouteTableId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table." } ] }, "docs": "Gets the specified DRG route table's information." }, { "info": { "name": "UpdateDrgRouteTable", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/drgRouteTables/:drgRouteTableId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "drgRouteTableId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified DRG route table.\n" }, { "info": { "name": "DeleteDrgRouteTable", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/drgRouteTables/:drgRouteTableId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "drgRouteTableId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table." } ] }, "docs": "Deletes the specified DRG route table. There must not be any DRG attachments assigned.\n" }, { "info": { "name": "AddDrgRouteRules", "type": "http" }, "http": { "method": "POST", "url": "/20160918/drgRouteTables/:drgRouteTableId/actions/addDrgRouteRules", "headers": [ { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "drgRouteTableId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds one or more static route rules to the specified DRG route table.\n" }, { "info": { "name": "RemoveDrgRouteRules", "type": "http" }, "http": { "method": "POST", "url": "/20160918/drgRouteTables/:drgRouteTableId/actions/removeDrgRouteRules", "params": [ { "name": "drgRouteTableId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes one or more route rules from the specified DRG route table.\n" }, { "info": { "name": "RemoveImportDrgRouteDistribution", "type": "http" }, "http": { "method": "POST", "url": "/20160918/drgRouteTables/:drgRouteTableId/actions/removeImportDrgRouteDistribution", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "drgRouteTableId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table." } ] }, "docs": "Removes the import route distribution from the DRG route table so no routes are imported\ninto it.\n" }, { "info": { "name": "UpdateDrgRouteRules", "type": "http" }, "http": { "method": "POST", "url": "/20160918/drgRouteTables/:drgRouteTableId/actions/updateDrgRouteRules", "params": [ { "name": "drgRouteTableId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more route rules in the specified DRG route table.\n" }, { "info": { "name": "ListDrgRouteRules", "type": "http" }, "http": { "method": "GET", "url": "/20160918/drgRouteTables/:drgRouteTableId/drgRouteRules", "params": [ { "name": "drgRouteTableId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "routeType", "value": "", "type": "query", "description": "Static routes are specified through the DRG route table API.\nDynamic routes are learned by the DRG from the DRG attachments through various routing protocols.\n" } ] }, "docs": "Lists the route rules in the specified DRG route table." }, { "info": { "name": "ListDrgs", "type": "http" }, "http": { "method": "GET", "url": "/20160918/drgs", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists the DRGs in the specified compartment.\n" }, { "info": { "name": "CreateDrg", "type": "http" }, "http": { "method": "POST", "url": "/20160918/drgs", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new dynamic routing gateway (DRG) in the specified compartment. For more information,\nsee [Dynamic Routing Gateways (DRGs)](/iaas/Content/Network/Tasks/managingDRGs.htm).\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want\nthe DRG to reside. Notice that the DRG doesn't have to be in the same compartment as the VCN,\nthe DRG attachment, or other Networking Service components. If you're not sure" }, { "info": { "name": "GetDrg", "type": "http" }, "http": { "method": "GET", "url": "/20160918/drgs/:drgId", "params": [ { "name": "drgId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG." } ] }, "docs": "Gets the specified DRG's information." }, { "info": { "name": "UpdateDrg", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/drgs/:drgId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "drgId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified DRG's display name or tags. Avoid entering confidential information.\n" }, { "info": { "name": "DeleteDrg", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/drgs/:drgId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "drgId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG." } ] }, "docs": "Deletes the specified DRG. The DRG must not be attached to a VCN or be connected to your on-premise\nnetwork. Also, there must not be a route table that lists the DRG as a target. This is an asynchronous\noperation. The DRG's `lifecycleState` will change to TERMINATING temporarily until the DRG is completely\nremoved.\n" }, { "info": { "name": "GetAllDrgAttachments", "type": "http" }, "http": { "method": "POST", "url": "/20160918/drgs/:drgId/actions/getAllDrgAttachments", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "drgId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "attachmentType", "value": "", "type": "query", "description": "The type for the network resource attached to the DRG." }, { "name": "isCrossTenancy", "value": "", "type": "query", "description": "Whether the DRG attachment lives in a different tenancy than the DRG." } ] }, "docs": "Returns a complete list of DRG attachments that belong to a particular DRG.\n" }, { "info": { "name": "UpgradeDrg", "type": "http" }, "http": { "method": "POST", "url": "/20160918/drgs/:drgId/actions/upgrade", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "drgId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG." } ] }, "docs": "Upgrades the DRG. After upgrade, you can control routing inside your DRG\nvia DRG attachments, route distributions, and DRG route tables.\n" }, { "info": { "name": "UpgradeStatus", "type": "http" }, "http": { "method": "GET", "url": "/20160918/drgs/:drgId/actions/upgradeStatus", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "drgId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG." } ] }, "docs": "Returns the DRG upgrade status. The status can be not updated, in progress, or updated. Also indicates how much of the upgrade is completed.\n" }, { "info": { "name": "GetDrgRedundancyStatus", "type": "http" }, "http": { "method": "GET", "url": "/20160918/drgs/:drgId/redundancyStatus", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "drgId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG." } ] }, "docs": "Gets the redundancy status for the specified DRG. For more information, see\n[Redundancy Remedies](/iaas/Content/Network/Troubleshoot/drgredundancy.htm).\n" }, { "info": { "name": "ListFastConnectProviderServices", "type": "http" }, "http": { "method": "GET", "url": "/20160918/fastConnectProviderServices", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists the service offerings from supported providers. You need this\ninformation so you can specify your desired provider and service\noffering when you create a virtual circuit.\n\nFor the compartment ID, provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of your tenancy (the root compartment).\n\nFor more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n" }, { "info": { "name": "GetFastConnectProviderService", "type": "http" }, "http": { "method": "GET", "url": "/20160918/fastConnectProviderServices/:providerServiceId", "params": [ { "name": "providerServiceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the provider service." } ] }, "docs": "Gets the specified provider service.\nFor more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n" }, { "info": { "name": "GetFastConnectProviderServiceKey", "type": "http" }, "http": { "method": "GET", "url": "/20160918/fastConnectProviderServices/:providerServiceId/providerServiceKeys/:providerServiceKeyName", "params": [ { "name": "providerServiceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the provider service." }, { "name": "providerServiceKeyName", "value": "", "type": "path", "description": "The provider service key that the provider gives you when you set up a virtual circuit connection\nfrom the provider to Oracle Cloud Infrastructure. You can set up that connection and get your\nprovider service key at the provider's website or portal. For the portal location, see the `description`\nattribute of the [FastConnectProviderService](#/en/iaas/latest/FastConnectProviderService/).\n" } ] }, "docs": "Gets the specified provider service key's information. Use this operation to validate a\nprovider service key. An invalid key returns a 404 error.\n" }, { "info": { "name": "ListFastConnectProviderVirtualCircuitBandwidthShapes", "type": "http" }, "http": { "method": "GET", "url": "/20160918/fastConnectProviderServices/:providerServiceId/virtualCircuitBandwidthShapes", "params": [ { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "providerServiceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the provider service." } ] }, "docs": "Gets the list of available virtual circuit bandwidth levels for a provider.\nYou need this information so you can specify your desired bandwidth level (shape) when you create a virtual circuit.\n\nFor more information about virtual circuits, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n" }, { "info": { "name": "ListInternetGateways", "type": "http" }, "http": { "method": "GET", "url": "/20160918/internetGateways", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "vcnId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle\nstate. The state value is case-insensitive.\n" } ] }, "docs": "Lists the internet gateways in the specified VCN and the specified compartment.\nIf the VCN ID is not provided, then the list includes the internet gateways from all VCNs in the specified compartment.\n" }, { "info": { "name": "CreateInternetGateway", "type": "http" }, "http": { "method": "POST", "url": "/20160918/internetGateways", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new internet gateway for the specified VCN. For more information, see\n[Access to the Internet](/iaas/Content/Network/Tasks/managingIGs.htm).\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the Internet\nGateway to reside. Notice that the internet gateway doesn't have to be in the same compartment as the VCN or\nother Networking Service components. If you're not sure which compartment to use" }, { "info": { "name": "GetInternetGateway", "type": "http" }, "http": { "method": "GET", "url": "/20160918/internetGateways/:igId", "params": [ { "name": "igId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the internet gateway." } ] }, "docs": "Gets the specified internet gateway's information." }, { "info": { "name": "UpdateInternetGateway", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/internetGateways/:igId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "igId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the internet gateway." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified internet gateway. You can disable/enable it, or change its display name\nor tags. Avoid entering confidential information.\n\nIf the gateway is disabled, that means no traffic will flow to/from the internet even if there's\na route rule that enables that traffic.\n" }, { "info": { "name": "DeleteInternetGateway", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/internetGateways/:igId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "igId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the internet gateway." } ] }, "docs": "Deletes the specified internet gateway. The internet gateway does not have to be disabled, but\nthere must not be a route table that lists it as a target.\n\nThis is an asynchronous operation. The gateway's `lifecycleState` will change to TERMINATING temporarily\nuntil the gateway is completely removed.\n" }, { "info": { "name": "ChangeInternetGatewayCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/internetGateways/:igId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "igId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the internet gateway." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an internet gateway into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "ListIpInventory", "type": "http" }, "http": { "method": "POST", "url": "/20160918/ipInventory", "headers": [ { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Lists the IP Inventory information in the selected compartments.\n" }, { "info": { "name": "GetSubnetIpInventory", "type": "http" }, "http": { "method": "GET", "url": "/20160918/ipInventory/subnets/:subnetId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "subnetId", "value": "", "type": "path", "description": "Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet." } ] }, "docs": "Gets the IP Inventory data of the specified subnet. Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "GetSubnetCidrUtilization", "type": "http" }, "http": { "method": "GET", "url": "/20160918/ipInventory/subnets/:subnetId/cidrs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "subnetId", "value": "", "type": "path", "description": "Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet." } ] }, "docs": "Gets the CIDR utilization data of the specified subnet. Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "GetIpInventoryVcnOverlap", "type": "http" }, "http": { "method": "POST", "url": "/20160918/ipInventory/vcns/:vcnId/overlaps", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "vcnId", "value": "", "type": "path", "description": "Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Gets the CIDR overlap information of the specified VCN in selected compartments. Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "GetResourceIpInventory", "type": "http" }, "http": { "method": "GET", "url": "/20160918/ipinventory/DataRequestId/:dataRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "dataRequestId", "value": "", "type": "path", "description": "Specify the ID of the resource." } ] }, "docs": "Gets the `IpInventory` resource.\n" }, { "info": { "name": "GetAllowedIkeIPSecParameters", "type": "http" }, "http": { "method": "GET", "url": "/20160918/ipsecAlgorithms", "headers": [ { "name": "opc-request-id", "value": "" } ] }, "docs": "The parameters allowed for IKE IPSec tunnels.\n" }, { "info": { "name": "ListIPSecConnections", "type": "http" }, "http": { "method": "GET", "url": "/20160918/ipsecConnections", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "drgId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG." }, { "name": "cpeId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists the IPSec connections for the specified compartment. You can filter the\nresults by DRG or CPE.\n" }, { "info": { "name": "CreateIPSecConnection", "type": "http" }, "http": { "method": "POST", "url": "/20160918/ipsecConnections", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new IPSec connection between the specified DRG and CPE. For more information, see\n[Site-to-Site VPN Overview](/iaas/Content/Network/Tasks/overviewIPsec.htm).\n\nIf you configure at least one tunnel to use static routing, then in the request you must provide\nat least one valid static route (you're allowed a maximum of 10). For example: 10.0.0.0/16.\nIf you configure both tunnels to use BGP dynamic routing, you can provide an empty list for\nthe static routes. For more information, see the i" }, { "info": { "name": "GetIPSecConnection", "type": "http" }, "http": { "method": "GET", "url": "/20160918/ipsecConnections/:ipscId", "params": [ { "name": "ipscId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPSec connection." } ] }, "docs": "Gets the specified IPSec connection's basic information, including the static routes for the\non-premises router. If you want the status of the connection (whether it's up or down), use\n[GetIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/GetIPSecConnectionTunnel).\n" }, { "info": { "name": "UpdateIPSecConnection", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/ipsecConnections/:ipscId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "ipscId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPSec connection." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified IPSec connection.\n\nTo update an individual IPSec tunnel's attributes, use\n[UpdateIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/UpdateIPSecConnectionTunnel).\n" }, { "info": { "name": "DeleteIPSecConnection", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/ipsecConnections/:ipscId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "ipscId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPSec connection." } ] }, "docs": "Deletes the specified IPSec connection. If your goal is to disable the Site-to-Site VPN between your VCN and\non-premises network, it's easiest to simply detach the DRG but keep all the Site-to-Site VPN components intact.\nIf you were to delete all the components and then later need to create an Site-to-Site VPN again, you would\nneed to configure your on-premises router again with the new information returned from\n[CreateIPSecConnection](#/en/iaas/latest/IPSecConnection/CreateIPSecConnection).\n\nTh" }, { "info": { "name": "ChangeIPSecConnectionCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/ipsecConnections/:ipscId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "ipscId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPSec connection." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an IPSec connection into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "GetIpsecCpeDeviceConfigContent", "type": "http" }, "http": { "method": "GET", "url": "/20160918/ipsecConnections/:ipscId/cpeConfigContent", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "ipscId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPSec connection." } ] }, "docs": "Renders a set of CPE configuration content for the specified IPSec connection (for all the\ntunnels in the connection). The content helps a network engineer configure the actual CPE\ndevice (for example, a hardware router) that the specified IPSec connection terminates on.\n\nThe rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the\n[Cpe](#/en/iaas/latest/Cpe/) used by the specified [IPSecConnection](#/en/iaas/latest/IPSecConnection/)\nmust have the CPE's devi" }, { "info": { "name": "GetIPSecConnectionDeviceConfig", "type": "http" }, "http": { "method": "GET", "url": "/20160918/ipsecConnections/:ipscId/deviceConfig", "params": [ { "name": "ipscId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPSec connection." } ] }, "docs": "Deprecated. To get tunnel information, instead use:\n\n* [GetIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/GetIPSecConnectionTunnel)\n* [GetIPSecConnectionTunnelSharedSecret](#/en/iaas/latest/IPSecConnectionTunnelSharedSecret/GetIPSecConnectionTunnelSharedSecret)\n" }, { "info": { "name": "GetIPSecConnectionDeviceStatus", "type": "http" }, "http": { "method": "GET", "url": "/20160918/ipsecConnections/:ipscId/deviceStatus", "params": [ { "name": "ipscId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPSec connection." } ] }, "docs": "Deprecated. To get the tunnel status, instead use\n[GetIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/GetIPSecConnectionTunnel).\n" }, { "info": { "name": "ListIPSecConnectionTunnels", "type": "http" }, "http": { "method": "GET", "url": "/20160918/ipsecConnections/:ipscId/tunnels", "params": [ { "name": "ipscId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPSec connection." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists the tunnel information for the specified IPSec connection.\n" }, { "info": { "name": "GetIPSecConnectionTunnel", "type": "http" }, "http": { "method": "GET", "url": "/20160918/ipsecConnections/:ipscId/tunnels/:tunnelId", "params": [ { "name": "ipscId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPSec connection." }, { "name": "tunnelId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel." } ] }, "docs": "Gets the specified tunnel's information. The resulting object does not include the tunnel's\nshared secret (pre-shared key). To retrieve that, use\n[GetIPSecConnectionTunnelSharedSecret](#/en/iaas/latest/IPSecConnectionTunnelSharedSecret/GetIPSecConnectionTunnelSharedSecret).\n" }, { "info": { "name": "UpdateIPSecConnectionTunnelDetails", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/ipsecConnections/:ipscId/tunnels/:tunnelId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "ipscId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPSec connection." }, { "name": "tunnelId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified tunnel. This operation lets you change tunnel attributes such as the\nrouting type (BGP dynamic routing or static routing). Here are some important notes:\n\n * If you change the tunnel's routing type or BGP session configuration, the tunnel will go\n down while it's reprovisioned.\n\n * If you want to switch the tunnel's `routing` from `STATIC` to `BGP`, make sure the tunnel's\n BGP session configuration attributes have been set ([bgpSessionConfig](#/en/iaas/latest/dataty" }, { "info": { "name": "GetIPSecConnectionTunnelError", "type": "http" }, "http": { "method": "GET", "url": "/20160918/ipsecConnections/:ipscId/tunnels/:tunnelId/error", "params": [ { "name": "ipscId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPSec connection." }, { "name": "tunnelId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel." } ] }, "docs": "Gets the identified error for the specified IPSec tunnel ID.\n" }, { "info": { "name": "ListIPSecConnectionTunnelRoutes", "type": "http" }, "http": { "method": "GET", "url": "/20160918/ipsecConnections/:ipscId/tunnels/:tunnelId/routes", "params": [ { "name": "ipscId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPSec connection." }, { "name": "tunnelId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "advertiser", "value": "", "type": "query", "description": "Specifies the advertiser of the routes. If set to `ORACLE`, this returns only the\nroutes advertised by Oracle. When set to `CUSTOMER`, this returns only the\nroutes advertised by the CPE.\n" } ] }, "docs": "The routes advertised to the on-premises network and the routes received from the on-premises network.\n" }, { "info": { "name": "GetIPSecConnectionTunnelSharedSecret", "type": "http" }, "http": { "method": "GET", "url": "/20160918/ipsecConnections/:ipscId/tunnels/:tunnelId/sharedSecret", "params": [ { "name": "ipscId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPSec connection." }, { "name": "tunnelId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel." } ] }, "docs": "Gets the specified tunnel's shared secret (pre-shared key). To get other information\nabout the tunnel, use [GetIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/GetIPSecConnectionTunnel).\n" }, { "info": { "name": "UpdateIPSecConnectionTunnelSharedSecret", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/ipsecConnections/:ipscId/tunnels/:tunnelId/sharedSecret", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "ipscId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPSec connection." }, { "name": "tunnelId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the shared secret (pre-shared key) for the specified tunnel.\n\n**Important:** If you change the shared secret, the tunnel will go down while it's reprovisioned.\n" }, { "info": { "name": "GetTunnelCpeDeviceConfig", "type": "http" }, "http": { "method": "GET", "url": "/20160918/ipsecConnections/:ipscId/tunnels/:tunnelId/tunnelDeviceConfig", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "ipscId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPSec connection." }, { "name": "tunnelId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel." } ] }, "docs": "Gets the set of CPE configuration answers for the tunnel, which the customer provided in\n[UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig).\nTo get the full set of content for the tunnel (any answers merged with the template of other\ninformation specific to the CPE device type), use\n[GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent).\n" }, { "info": { "name": "UpdateTunnelCpeDeviceConfig", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/ipsecConnections/:ipscId/tunnels/:tunnelId/tunnelDeviceConfig", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "ipscId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPSec connection." }, { "name": "tunnelId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates the set of CPE configuration answers for the specified tunnel.\nThe answers correlate to the questions that are specific to the CPE device type (see the\n`parameters` attribute of [CpeDeviceShapeDetail](#/en/iaas/latest/CpeDeviceShapeDetail/)).\n" }, { "info": { "name": "GetTunnelCpeDeviceConfigContent", "type": "http" }, "http": { "method": "GET", "url": "/20160918/ipsecConnections/:ipscId/tunnels/:tunnelId/tunnelDeviceConfig/content", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "ipscId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPSec connection." }, { "name": "tunnelId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel." } ] }, "docs": "Renders a set of CPE configuration content for the specified IPSec tunnel. The content helps a\nnetwork engineer configure the actual CPE device (for example, a hardware router) that the specified\nIPSec tunnel terminates on.\n\nThe rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the\n[Cpe](#/en/iaas/latest/Cpe/) used by the specified [IPSecConnection](#/en/iaas/latest/IPSecConnection/)\nmust have the CPE's device type specified by the `cpeDeviceShapeId` attr" }, { "info": { "name": "ListIPSecConnectionTunnelSecurityAssociations", "type": "http" }, "http": { "method": "GET", "url": "/20160918/ipsecConnections/:ipscId/tunnels/:tunnelId/tunnelSecurityAssociations", "params": [ { "name": "ipscId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPSec connection." }, { "name": "tunnelId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists the tunnel security associations information for the specified IPSec tunnel ID.\n" }, { "info": { "name": "ListIpv6s", "type": "http" }, "http": { "method": "GET", "url": "/20160918/ipv6", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "ipAddress", "value": "", "type": "query", "description": "An IP address. This could be either IPv4 or IPv6, depending on the resource.\nExample: `10.0.3.3`\n" }, { "name": "subnetId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet." }, { "name": "vnicId", "value": "", "type": "query", "description": "The OCID of the VNIC." }, { "name": "ipState", "value": "", "type": "query", "description": "State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED otherwise AVAILABLE" }, { "name": "lifetime", "value": "", "type": "query", "description": "Lifetime of the IP address.\nThere are two types of IPs:\n - Ephemeral\n - Reserved\n" } ] }, "docs": "Lists the [IPv6](#/en/iaas/latest/Ipv6/) objects based\non one of these filters:\n\n * Subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n * VNIC [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n * Both IPv6 address and subnet OCID: This lets you get an `Ipv6` object based on its private\n IPv6 address (for example, 2001:0db8:0123:1111:abcd:ef01:2345:6789) and not its [OCID](/iaas/Content/General/Concepts/identifiers.htm). For comparison,\n [GetIpv6](#/en/iaas/latest/Ipv6/GetI" }, { "info": { "name": "CreateIpv6", "type": "http" }, "http": { "method": "POST", "url": "/20160918/ipv6", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an IPv6 for the specified VNIC.\n" }, { "info": { "name": "BulkCreateIpv6s", "type": "http" }, "http": { "method": "POST", "url": "/20160918/ipv6/actions/bulkCreateIpv6s", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create new IPv6s in bulk for a VNIC or subnet.\n" }, { "info": { "name": "BulkDeleteIpv6s", "type": "http" }, "http": { "method": "POST", "url": "/20160918/ipv6/actions/bulkDeleteIpv6s", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Unassign and delete IPv6s for a VNIC in bulk.\n" }, { "info": { "name": "BulkDetachIpv6s", "type": "http" }, "http": { "method": "POST", "url": "/20160918/ipv6/actions/bulkDetachIpv6s", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Detach the specified IPv6s.\n" }, { "info": { "name": "BulkUpdateIpv6s", "type": "http" }, "http": { "method": "POST", "url": "/20160918/ipv6/actions/bulkUpdateIpv6s", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified IPv6s in bulk.\n" }, { "info": { "name": "GetIpv6", "type": "http" }, "http": { "method": "GET", "url": "/20160918/ipv6/:ipv6Id", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "ipv6Id", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPv6." } ] }, "docs": "Gets the specified IPv6. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\nAlternatively, you can get the object by using\n[ListIpv6s](#/en/iaas/latest/Ipv6/ListIpv6s)\nwith the IPv6 address (for example, 2001:0db8:0123:1111:98fe:dcba:9876:4321) and subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "UpdateIpv6", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/ipv6/:ipv6Id", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "ipv6Id", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPv6." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified IPv6. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\nUse this operation if you want to:\n\n * Move an IPv6 to a different VNIC in the same subnet.\n * Enable/disable internet access for an IPv6.\n * Change the display name for an IPv6.\n * Update resource tags for an IPv6.\n" }, { "info": { "name": "DeleteIpv6", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/ipv6/:ipv6Id", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "ipv6Id", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPv6." } ] }, "docs": "Unassigns and deletes the specified IPv6. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\nThe IPv6 address is returned to the subnet's pool of available addresses.\n" }, { "info": { "name": "Ipv6VnicDetach", "type": "http" }, "http": { "method": "POST", "url": "/20160918/ipv6/:ipv6Id/actions/detach", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "ipv6Id", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPv6." } ] }, "docs": "Unassign the specified IPv6 address from Virtual Network Interface Card (VNIC). You must specify the IPv6 [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "ListLocalPeeringGateways", "type": "http" }, "http": { "method": "GET", "url": "/20160918/localPeeringGateways", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "vcnId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN." } ] }, "docs": "Lists the local peering gateways (LPGs) for the specified VCN and specified compartment.\nIf the VCN ID is not provided, then the list includes the LPGs from all VCNs in the specified compartment.\n" }, { "info": { "name": "CreateLocalPeeringGateway", "type": "http" }, "http": { "method": "POST", "url": "/20160918/localPeeringGateways", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new local peering gateway (LPG) for the specified VCN.\n" }, { "info": { "name": "GetLocalPeeringGateway", "type": "http" }, "http": { "method": "GET", "url": "/20160918/localPeeringGateways/:localPeeringGatewayId", "params": [ { "name": "localPeeringGatewayId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the local peering gateway." } ] }, "docs": "Gets the specified local peering gateway's information." }, { "info": { "name": "UpdateLocalPeeringGateway", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/localPeeringGateways/:localPeeringGatewayId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "localPeeringGatewayId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the local peering gateway." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified local peering gateway (LPG).\n" }, { "info": { "name": "DeleteLocalPeeringGateway", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/localPeeringGateways/:localPeeringGatewayId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "localPeeringGatewayId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the local peering gateway." } ] }, "docs": "Deletes the specified local peering gateway (LPG).\n\nThis is an asynchronous operation; the local peering gateway's `lifecycleState` changes to TERMINATING temporarily\nuntil the local peering gateway is completely removed.\n" }, { "info": { "name": "ChangeLocalPeeringGatewayCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/localPeeringGateways/:localPeeringGatewayId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "localPeeringGatewayId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the local peering gateway." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a local peering gateway into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "ConnectLocalPeeringGateways", "type": "http" }, "http": { "method": "POST", "url": "/20160918/localPeeringGateways/:localPeeringGatewayId/actions/connect", "params": [ { "name": "localPeeringGatewayId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the local peering gateway." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Connects this local peering gateway (LPG) to another one in the same region.\n\nThis operation must be called by the VCN administrator who is designated as\nthe *requestor* in the peering relationship. The *acceptor* must implement\nan Identity and Access Management (IAM) policy that gives the requestor permission\nto connect to LPGs in the acceptor's compartment. Without that permission, this\noperation will fail. For more information, see\n[VCN Peering](/iaas/Content/Network/Tasks/VCNpeering.htm).\n" }, { "info": { "name": "ListNatGateways", "type": "http" }, "http": { "method": "GET", "url": "/20160918/natGateways", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "vcnId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle\nstate. The value is case insensitive.\n" } ] }, "docs": "Lists the NAT gateways in the specified compartment. You may optionally specify a VCN OCID\nto filter the results by VCN.\n" }, { "info": { "name": "CreateNatGateway", "type": "http" }, "http": { "method": "POST", "url": "/20160918/natGateways", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new NAT gateway for the specified VCN. You must also set up a route rule with the\nNAT gateway as the rule's target. See [Route Table](#/en/iaas/latest/RouteTable/).\n" }, { "info": { "name": "GetNatGateway", "type": "http" }, "http": { "method": "GET", "url": "/20160918/natGateways/:natGatewayId", "params": [ { "name": "natGatewayId", "value": "", "type": "path", "description": "The NAT gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets the specified NAT gateway's information." }, { "info": { "name": "UpdateNatGateway", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/natGateways/:natGatewayId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "natGatewayId", "value": "", "type": "path", "description": "The NAT gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified NAT gateway.\n" }, { "info": { "name": "DeleteNatGateway", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/natGateways/:natGatewayId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "natGatewayId", "value": "", "type": "path", "description": "The NAT gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Deletes the specified NAT gateway. The NAT gateway does not have to be disabled, but there\nmust not be a route rule that lists the NAT gateway as a target.\n\nThis is an asynchronous operation. The NAT gateway's `lifecycleState` will change to\nTERMINATING temporarily until the NAT gateway is completely removed.\n" }, { "info": { "name": "ChangeNatGatewayCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/natGateways/:natGatewayId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "natGatewayId", "value": "", "type": "path", "description": "The NAT gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a NAT gateway into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "ListNetworkSecurityGroups", "type": "http" }, "http": { "method": "GET", "url": "/20160918/networkSecurityGroups", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "vlanId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN." }, { "name": "vcnId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle\nstate. The value is case insensitive.\n" } ] }, "docs": "Lists either the network security groups in the specified compartment, or those associated with the specified VLAN.\nYou must specify either a `vlanId` or a `compartmentId`, but not both. If you specify a `vlanId`, all other parameters are ignored.\n" }, { "info": { "name": "CreateNetworkSecurityGroup", "type": "http" }, "http": { "method": "POST", "url": "/20160918/networkSecurityGroups", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new network security group for the specified VCN.\n" }, { "info": { "name": "GetNetworkSecurityGroup", "type": "http" }, "http": { "method": "GET", "url": "/20160918/networkSecurityGroups/:networkSecurityGroupId", "params": [ { "name": "networkSecurityGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group." } ] }, "docs": "Gets the specified network security group's information.\n\nTo list the VNICs in an NSG, see\n[ListNetworkSecurityGroupVnics](#/en/iaas/latest/NetworkSecurityGroupVnic/ListNetworkSecurityGroupVnics).\n\nTo list the security rules in an NSG, see\n[ListNetworkSecurityGroupSecurityRules](#/en/iaas/latest/SecurityRule/ListNetworkSecurityGroupSecurityRules).\n" }, { "info": { "name": "UpdateNetworkSecurityGroup", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/networkSecurityGroups/:networkSecurityGroupId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "networkSecurityGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified network security group.\n\nTo add or remove an existing VNIC from the group, use\n[UpdateVnic](#/en/iaas/latest/Vnic/UpdateVnic).\n\nTo add a VNIC to the group *when you create the VNIC*, specify the NSG's [OCID](/iaas/Content/General/Concepts/identifiers.htm) during creation.\nFor example, see the `nsgIds` attribute in [CreateVnicDetails](#/en/iaas/latest/datatypes/CreateVnicDetails).\n\nTo add or remove security rules from the group, use\n[AddNetworkSecurityGroupSecurityRules](#/e" }, { "info": { "name": "DeleteNetworkSecurityGroup", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/networkSecurityGroups/:networkSecurityGroupId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "networkSecurityGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group." } ] }, "docs": "Deletes the specified network security group. The group must not contain any VNICs.\n\nTo get a list of the VNICs in a network security group, use\n[ListNetworkSecurityGroupVnics](#/en/iaas/latest/NetworkSecurityGroupVnic/ListNetworkSecurityGroupVnics).\nEach returned [NetworkSecurityGroupVnic](#/en/iaas/latest/NetworkSecurityGroupVnic/) object\ncontains both the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC and the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VN" }, { "info": { "name": "AddNetworkSecurityGroupSecurityRules", "type": "http" }, "http": { "method": "POST", "url": "/20160918/networkSecurityGroups/:networkSecurityGroupId/actions/addSecurityRules", "params": [ { "name": "networkSecurityGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds up to 25 security rules to the specified network security group. Adding more than 25 rules requires multiple operations.\n" }, { "info": { "name": "ChangeNetworkSecurityGroupCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/networkSecurityGroups/:networkSecurityGroupId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "networkSecurityGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a network security group into a different compartment within the same tenancy. For\ninformation about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "RemoveNetworkSecurityGroupSecurityRules", "type": "http" }, "http": { "method": "POST", "url": "/20160918/networkSecurityGroups/:networkSecurityGroupId/actions/removeSecurityRules", "params": [ { "name": "networkSecurityGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes one or more security rules from the specified network security group.\n" }, { "info": { "name": "UpdateNetworkSecurityGroupSecurityRules", "type": "http" }, "http": { "method": "POST", "url": "/20160918/networkSecurityGroups/:networkSecurityGroupId/actions/updateSecurityRules", "params": [ { "name": "networkSecurityGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more security rules in the specified network security group.\n" }, { "info": { "name": "ListNetworkSecurityGroupSecurityRules", "type": "http" }, "http": { "method": "GET", "url": "/20160918/networkSecurityGroups/:networkSecurityGroupId/securityRules", "params": [ { "name": "networkSecurityGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group." }, { "name": "direction", "value": "", "type": "query", "description": "Direction of the security rule. Set to `EGRESS` for rules that allow outbound IP packets,\nor `INGRESS` for rules that allow inbound IP packets.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" } ] }, "docs": "Lists the security rules in the specified network security group.\n" }, { "info": { "name": "ListNetworkSecurityGroupVnics", "type": "http" }, "http": { "method": "GET", "url": "/20160918/networkSecurityGroups/:networkSecurityGroupId/vnics", "params": [ { "name": "networkSecurityGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" } ] }, "docs": "Lists the VNICs in the specified network security group.\n" }, { "info": { "name": "Get a Virtual Networking topology for the current region", "type": "http" }, "http": { "method": "GET", "url": "/20160918/networkingTopology", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-none-match", "value": "" }, { "name": "cache-control", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are `ANY` and `ACCESSIBLE`. The default is `ANY`.\nSetting this to `ACCESSIBLE` returns only compartments for which a\nuser has INSPECT permissions, either directly or indirectly (permissions can be on a\nresource in a subcompartment). A restricted set of fields is returned for compartments in which a user has\nindirect INSPECT permissions.\n\nWhen set to `ANY` permissions are not checked.\n" }, { "name": "queryCompartmentSubtree", "value": "", "type": "query", "description": "When set to true, the hierarchy of compartments is traversed\nand the specified compartment and its subcompartments are\ninspected depending on the the setting of `accessLevel`.\nDefault is false.\n" } ] }, "docs": "Gets a virtual networking topology for the current region." }, { "info": { "name": "ListPrivateIps", "type": "http" }, "http": { "method": "GET", "url": "/20160918/privateIps", "params": [ { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "ipAddress", "value": "", "type": "query", "description": "An IP address. This could be either IPv4 or IPv6, depending on the resource.\nExample: `10.0.3.3`\n" }, { "name": "subnetId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet." }, { "name": "vnicId", "value": "", "type": "query", "description": "The OCID of the VNIC." }, { "name": "ipState", "value": "", "type": "query", "description": "State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED otherwise AVAILABLE" }, { "name": "lifetime", "value": "", "type": "query", "description": "Lifetime of the IP address.\nThere are two types of IPs:\n - Ephemeral\n - Reserved\n" }, { "name": "vlanId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN." } ] }, "docs": "Lists the [PrivateIp](#/en/iaas/latest/PrivateIp/) objects based\non one of these filters:\n\n - Subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n - VNIC [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n - Both private IP address and subnet OCID: This lets\n you get a `privateIP` object based on its private IP\n address (for example, 10.0.3.3) and not its [OCID](/iaas/Content/General/Concepts/identifiers.htm). For comparison,\n [GetPrivateIp](#/en/iaas/latest/PrivateIp/GetPr" }, { "info": { "name": "CreatePrivateIp", "type": "http" }, "http": { "method": "POST", "url": "/20160918/privateIps", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a private IP.\nFor more information about private IPs, see\n[IP Addresses](/iaas/Content/Network/Tasks/managingIPaddresses.htm).\n" }, { "info": { "name": "BulkCreatePrivateIps", "type": "http" }, "http": { "method": "POST", "url": "/20160918/privateIps/actions/bulkCreatePrivateIps", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create secondary private IPv4 addresses.\n" }, { "info": { "name": "BulkDeletePrivateIps", "type": "http" }, "http": { "method": "POST", "url": "/20160918/privateIps/actions/bulkDeletePrivateIps", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Unassign and delete secondary private IPv4s for a VNIC.\n" }, { "info": { "name": "DetachPrivateIps", "type": "http" }, "http": { "method": "POST", "url": "/20160918/privateIps/actions/bulkDetachPrivateIps", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Unassign the specified private IP addresses from the Virtual Network Interface Card (VNIC). You must specify the PrivateIP object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "UpdatePrivateIps", "type": "http" }, "http": { "method": "POST", "url": "/20160918/privateIps/actions/bulkUpdatePrivateIps", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update existing secondary private IPv4s for a VNIC." }, { "info": { "name": "GetPrivateIp", "type": "http" }, "http": { "method": "GET", "url": "/20160918/privateIps/:privateIpId", "params": [ { "name": "privateIpId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private IP or IPv6." } ] }, "docs": "Gets the specified private IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\nAlternatively, you can get the object by using\n[ListPrivateIps](#/en/iaas/latest/PrivateIp/ListPrivateIps)\nwith the private IP address (for example, 10.0.3.3) and subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "UpdatePrivateIp", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/privateIps/:privateIpId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "privateIpId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private IP or IPv6." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified private IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\nUse this operation if you want to:\n\n - Move a secondary private IP to a different VNIC in the same subnet.\n - Change the display name for a secondary private IP.\n - Change the hostname for a secondary private IP.\n\nThis operation cannot be used with primary private IPs.\nTo update the hostname for the primary IP on a VNIC, use\n[UpdateVnic](#/en/iaas/latest/Vnic/UpdateVnic).\n" }, { "info": { "name": "DeletePrivateIp", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/privateIps/:privateIpId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "privateIpId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private IP or IPv6." } ] }, "docs": "Unassigns and deletes the specified private IP. You must\nspecify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm). The private IP address is returned to\nthe subnet's pool of available addresses.\n\nThis operation cannot be used with primary private IPs, which are\nautomatically unassigned and deleted when the VNIC is terminated.\n\n**Important:** If a secondary private IP is the\n[target of a route rule](/iaas/Content/Network/Tasks/managingroutetables.htm#privateip),\nunassigning it " }, { "info": { "name": "PrivateIpVnicDetach", "type": "http" }, "http": { "method": "POST", "url": "/20160918/privateIps/:privateIpId/actions/detach", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "privateIpId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private IP or IPv6." } ] }, "docs": "Unassign the specified PrivateIP address from Virtual Network Interface Card (VNIC). You must specify the PrivateIP [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "ListPublicIpPools", "type": "http" }, "http": { "method": "GET", "url": "/20160918/publicIpPools", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "byoipRangeId", "value": "", "type": "query", "description": "A filter to return only resources that match the given BYOIP CIDR block.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." } ] }, "docs": "Lists the public IP pools in the specified compartment.\nYou can filter the list using query parameters.\n" }, { "info": { "name": "CreatePublicIpPool", "type": "http" }, "http": { "method": "POST", "url": "/20160918/publicIpPools", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a public IP pool.\n" }, { "info": { "name": "GetPublicIpPool", "type": "http" }, "http": { "method": "GET", "url": "/20160918/publicIpPools/:publicIpPoolId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "publicIpPoolId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool." } ] }, "docs": "Gets the specified `PublicIpPool` object. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n" }, { "info": { "name": "UpdatePublicIpPool", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/publicIpPools/:publicIpPoolId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "publicIpPoolId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified public IP pool.\n" }, { "info": { "name": "DeletePublicIpPool", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/publicIpPools/:publicIpPoolId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "publicIpPoolId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool." } ] }, "docs": "Deletes the specified public IP pool.\nTo delete a public IP pool it must not have any active IP address allocations.\nYou must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm) when deleting an IP pool.\n" }, { "info": { "name": "AddPublicIpPoolCapacity", "type": "http" }, "http": { "method": "POST", "url": "/20160918/publicIpPools/:publicIpPoolId/actions/addCapacity", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "publicIpPoolId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds some or all of a CIDR block to a public IP pool.\n\nThe CIDR block (or subrange) must not overlap with any other CIDR block already added to this or any other public IP pool.\n" }, { "info": { "name": "ChangePublicIpPoolCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/publicIpPools/:publicIpPoolId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "publicIpPoolId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a public IP pool to a different compartment. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "RemovePublicIpPoolCapacity", "type": "http" }, "http": { "method": "POST", "url": "/20160918/publicIpPools/:publicIpPoolId/actions/removeCapacity", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "publicIpPoolId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes a CIDR block from the referenced public IP pool.\n" }, { "info": { "name": "ListPublicIps", "type": "http" }, "http": { "method": "GET", "url": "/20160918/publicIps", "params": [ { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "scope", "value": "", "type": "query", "description": "Whether the public IP is regional or specific to a particular availability domain.\n\n* `REGION`: The public IP exists within a region and is assigned to a regional entity\n(such as a [NatGateway](#/en/iaas/latest/NatGateway/)), or can be assigned to a private IP\nin any availability domain in the region. Reserved public IPs have `scope` = `REGION`, as do\nephemeral public IPs assigned to a regional entity.\n\n* `AVAILABILITY_DOMAIN`: The public IP exists within the availability domain of the entity\nit's assigned to, which is specified by the `availabilityDomain` property of the public IP object.\nEphemeral public IPs that are assigned to private IPs have `scope` = `AVAILABILITY_DOMAIN`.\n" }, { "name": "availabilityDomain", "value": "", "type": "query", "description": "The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n" }, { "name": "lifetime", "value": "", "type": "query", "description": "A filter to return only public IPs that match given lifetime.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "publicIpPoolId", "value": "", "type": "query", "description": "A filter to return only resources that belong to the given public IP pool.\n" } ] }, "docs": "Lists the [PublicIp](#/en/iaas/latest/PublicIp/) objects\nin the specified compartment. You can filter the list by using query parameters.\n\nTo list your reserved public IPs:\n * Set `scope` = `REGION` (required)\n * Leave the `availabilityDomain` parameter empty\n * Set `lifetime` = `RESERVED`\n\nTo list the ephemeral public IPs assigned to a regional entity such as a NAT gateway:\n * Set `scope` = `REGION` (required)\n * Leave the `availabilityDomain` parameter empty\n * Set `lifetime` = `EPHEME" }, { "info": { "name": "CreatePublicIp", "type": "http" }, "http": { "method": "POST", "url": "/20160918/publicIps", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a public IP. Use the `lifetime` property to specify whether it's an ephemeral or\nreserved public IP. For information about limits on how many you can create, see\n[Public IP Addresses](/iaas/Content/Network/Tasks/managingpublicIPs.htm).\n\n* **For an ephemeral public IP assigned to a private IP:** You must also specify a `privateIpId`\nwith the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the primary private IP you want to assign the public IP to. The public IP is\ncreated in the" }, { "info": { "name": "GetPublicIpByIpAddress", "type": "http" }, "http": { "method": "POST", "url": "/20160918/publicIps/actions/getByIpAddress", "body": { "type": "json", "data": "{}" } }, "docs": "Gets the public IP based on the public IP address (for example, 203.0.113.2).\n\n**Note:** If you're fetching a reserved public IP that is in the process of being\nmoved to a different private IP, the service returns the public IP object with\n`lifecycleState` = ASSIGNING and `assignedEntityId` = [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the target private IP.\n" }, { "info": { "name": "GetPublicIpByPrivateIpId", "type": "http" }, "http": { "method": "POST", "url": "/20160918/publicIps/actions/getByPrivateIpId", "body": { "type": "json", "data": "{}" } }, "docs": "Gets the public IP assigned to the specified private IP. You must specify the OCID\nof the private IP. If no public IP is assigned, a 404 is returned.\n\n**Note:** If you're fetching a reserved public IP that is in the process of being\nmoved to a different private IP, and you provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the original private\nIP, this operation returns a 404. If you instead provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the target\npriva" }, { "info": { "name": "GetPublicIp", "type": "http" }, "http": { "method": "GET", "url": "/20160918/publicIps/:publicIpId", "params": [ { "name": "publicIpId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP." } ] }, "docs": "Gets the specified public IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n\nAlternatively, you can get the object by using [GetPublicIpByIpAddress](#/en/iaas/latest/PublicIp/GetPublicIpByIpAddress)\nwith the public IP address (for example, 203.0.113.2).\n\nOr you can use [GetPublicIpByPrivateIpId](#/en/iaas/latest/PublicIp/GetPublicIpByPrivateIpId)\nwith the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private IP that the public IP is assigne" }, { "info": { "name": "UpdatePublicIp", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/publicIps/:publicIpId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "publicIpId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified public IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm). Use this operation if you want to:\n\n* Assign a reserved public IP in your pool to a private IP.\n* Move a reserved public IP to a different private IP.\n* Unassign a reserved public IP from a private IP (which returns it to your pool\nof reserved public IPs).\n* Change the display name or tags for a public IP.\n\nAssigning, moving, and unassigning a reserved public IP are asynchronous" }, { "info": { "name": "DeletePublicIp", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/publicIps/:publicIpId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "publicIpId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP." } ] }, "docs": "Unassigns and deletes the specified public IP (either ephemeral or reserved).\nYou must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm). The public IP address is returned to the\nOracle Cloud Infrastructure public IP pool.\n\n**Note:** You cannot update, unassign, or delete the public IP that Oracle automatically\nassigned to an entity for you (such as a load balancer or NAT gateway). The public IP is\nautomatically deleted if the assigned entity is terminated.\n\nFor an assi" }, { "info": { "name": "ChangePublicIpCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/publicIps/:publicIpId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "publicIpId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a public IP into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nThis operation applies only to reserved public IPs. Ephemeral public IPs always belong to the\nsame compartment as their VNIC and move accordingly.\n" }, { "info": { "name": "ListRemotePeeringConnections", "type": "http" }, "http": { "method": "GET", "url": "/20160918/remotePeeringConnections", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "drgId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists the remote peering connections (RPCs) for the specified DRG and compartment\n(the RPC's compartment).\n" }, { "info": { "name": "CreateRemotePeeringConnection", "type": "http" }, "http": { "method": "POST", "url": "/20160918/remotePeeringConnections", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new remote peering connection (RPC) for the specified DRG.\n" }, { "info": { "name": "GetRemotePeeringConnection", "type": "http" }, "http": { "method": "GET", "url": "/20160918/remotePeeringConnections/:remotePeeringConnectionId", "params": [ { "name": "remotePeeringConnectionId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the remote peering connection (RPC)." } ] }, "docs": "Get the specified remote peering connection's information.\n" }, { "info": { "name": "UpdateRemotePeeringConnection", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/remotePeeringConnections/:remotePeeringConnectionId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "remotePeeringConnectionId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the remote peering connection (RPC)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified remote peering connection (RPC).\n" }, { "info": { "name": "DeleteRemotePeeringConnection", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/remotePeeringConnections/:remotePeeringConnectionId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "remotePeeringConnectionId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the remote peering connection (RPC)." } ] }, "docs": "Deletes the remote peering connection (RPC).\n\nThis is an asynchronous operation; the RPC's `lifecycleState` changes to TERMINATING temporarily\nuntil the RPC is completely removed.\n" }, { "info": { "name": "ChangeRemotePeeringConnectionCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/remotePeeringConnections/:remotePeeringConnectionId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "remotePeeringConnectionId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the remote peering connection (RPC)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a remote peering connection (RPC) into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "ConnectRemotePeeringConnections", "type": "http" }, "http": { "method": "POST", "url": "/20160918/remotePeeringConnections/:remotePeeringConnectionId/actions/connect", "params": [ { "name": "remotePeeringConnectionId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the remote peering connection (RPC)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Connects this RPC to another one in a different region.\n\nThis operation must be called by the VCN administrator who is designated as\nthe *requestor* in the peering relationship. The *acceptor* must implement\nan Identity and Access Management (IAM) policy that gives the requestor permission\nto connect to RPCs in the acceptor's compartment. Without that permission, this\noperation will fail. For more information, see\n[VCN Peering](/iaas/Content/Network/Tasks/VCNpeering.htm).\n" }, { "info": { "name": "ListRouteTables", "type": "http" }, "http": { "method": "GET", "url": "/20160918/routeTables", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "vcnId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle\nstate. The state value is case-insensitive.\n" } ] }, "docs": "Lists the route tables in the specified VCN and specified compartment.\nIf the VCN ID is not provided, then the list includes the route tables from all VCNs in the specified compartment.\nThe response includes the default route table that automatically comes with\neach VCN in the specified compartment, plus any route tables you've created.\n" }, { "info": { "name": "CreateRouteTable", "type": "http" }, "http": { "method": "POST", "url": "/20160918/routeTables", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new route table for the specified VCN. In the request you must also include at least one route\nrule for the new route table. For information on the number of rules you can have in a route table, see\n[Service Limits](/iaas/Content/General/Concepts/servicelimits.htm). For general information about route\ntables in your VCN and the types of targets you can use in route rules,\nsee [Route Tables](/iaas/Content/Network/Tasks/managingroutetables.htm).\n\nFor the purposes of access control, you m" }, { "info": { "name": "GetRouteTable", "type": "http" }, "http": { "method": "GET", "url": "/20160918/routeTables/:rtId", "params": [ { "name": "rtId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table." } ] }, "docs": "Gets the specified route table's information." }, { "info": { "name": "UpdateRouteTable", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/routeTables/:rtId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "rtId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified route table's display name or route rules.\nAvoid entering confidential information.\n\nNote that the `routeRules` object you provide replaces the entire existing set of rules.\n" }, { "info": { "name": "DeleteRouteTable", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/routeTables/:rtId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "rtId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table." } ] }, "docs": "Deletes the specified route table, but only if it's not associated with a subnet. You can't delete a\nVCN's default route table.\n\nThis is an asynchronous operation. The route table's `lifecycleState` will change to TERMINATING temporarily\nuntil the route table is completely removed.\n" }, { "info": { "name": "ChangeRouteTableCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/routeTables/:rtId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "rtId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a route table into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "ListSecurityLists", "type": "http" }, "http": { "method": "GET", "url": "/20160918/securityLists", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "vcnId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle\nstate. The state value is case-insensitive.\n" } ] }, "docs": "Lists the security lists in the specified VCN and compartment.\nIf the VCN ID is not provided, then the list includes the security lists from all VCNs in the specified compartment.\n" }, { "info": { "name": "CreateSecurityList", "type": "http" }, "http": { "method": "POST", "url": "/20160918/securityLists", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new security list for the specified VCN. For more information\nabout security lists, see [Security Lists](/iaas/Content/Network/Concepts/securitylists.htm).\nFor information on the number of rules you can have in a security list, see\n[Service Limits](/iaas/Content/General/Concepts/servicelimits.htm).\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the security\nlist to reside. Notice that th" }, { "info": { "name": "GetSecurityList", "type": "http" }, "http": { "method": "GET", "url": "/20160918/securityLists/:securityListId", "params": [ { "name": "securityListId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the security list." } ] }, "docs": "Gets the specified security list's information." }, { "info": { "name": "UpdateSecurityList", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/securityLists/:securityListId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "securityListId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the security list." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified security list's display name or rules.\nAvoid entering confidential information.\n\nNote that the `egressSecurityRules` or `ingressSecurityRules` objects you provide replace the entire\nexisting objects.\n" }, { "info": { "name": "DeleteSecurityList", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/securityLists/:securityListId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "securityListId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the security list." } ] }, "docs": "Deletes the specified security list, but only if it's not associated with a subnet. You can't delete\na VCN's default security list.\n\nThis is an asynchronous operation. The security list's `lifecycleState` will change to TERMINATING temporarily\nuntil the security list is completely removed.\n" }, { "info": { "name": "ChangeSecurityListCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/securityLists/:securityListId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "securityListId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the security list." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a security list into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "ListServiceGateways", "type": "http" }, "http": { "method": "GET", "url": "/20160918/serviceGateways", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "vcnId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle\nstate. The state value is case-insensitive.\n" } ] }, "docs": "Lists the service gateways in the specified compartment. You may optionally specify a VCN OCID\nto filter the results by VCN.\n" }, { "info": { "name": "CreateServiceGateway", "type": "http" }, "http": { "method": "POST", "url": "/20160918/serviceGateways", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new service gateway in the specified compartment.\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want\nthe service gateway to reside. For more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\nFor information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optiona" }, { "info": { "name": "GetServiceGateway", "type": "http" }, "http": { "method": "GET", "url": "/20160918/serviceGateways/:serviceGatewayId", "params": [ { "name": "serviceGatewayId", "value": "", "type": "path", "description": "The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets the specified service gateway's information." }, { "info": { "name": "UpdateServiceGateway", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/serviceGateways/:serviceGatewayId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "serviceGatewayId", "value": "", "type": "path", "description": "The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified service gateway. The information you provide overwrites the existing\nattributes of the gateway.\n" }, { "info": { "name": "DeleteServiceGateway", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/serviceGateways/:serviceGatewayId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "serviceGatewayId", "value": "", "type": "path", "description": "The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Deletes the specified service gateway. There must not be a route table that lists the service\ngateway as a target.\n" }, { "info": { "name": "AttachService", "type": "http" }, "http": { "method": "POST", "url": "/20160918/serviceGateways/:serviceGatewayId/actions/attachService", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "serviceGatewayId", "value": "", "type": "path", "description": "The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds the specified [Service](#/en/iaas/latest/Service/) to the list of enabled\n`Service` objects for the specified gateway. You must also set up a route rule with the\n`cidrBlock` of the `Service` as the rule's destination and the service gateway as the rule's\ntarget. See [Route Table](#/en/iaas/latest/RouteTable/).\n\n**Note:** The `AttachServiceId` operation is an easy way to add an individual `Service` to\nthe service gateway. Compare it with\n[UpdateServiceGateway](#/en/iaas/latest/ServiceGateway" }, { "info": { "name": "ChangeServiceGatewayCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/serviceGateways/:serviceGatewayId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "serviceGatewayId", "value": "", "type": "path", "description": "The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a service gateway into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "DetachService", "type": "http" }, "http": { "method": "POST", "url": "/20160918/serviceGateways/:serviceGatewayId/actions/detachService", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "serviceGatewayId", "value": "", "type": "path", "description": "The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes the specified [Service](#/en/iaas/latest/Service/) from the list of enabled\n`Service` objects for the specified gateway. You do not need to remove any route\nrules that specify this `Service` object's `cidrBlock` as the destination CIDR. However, consider\nremoving the rules if your intent is to permanently disable use of the `Service` through this\nservice gateway.\n\n**Note:** The `DetachServiceId` operation is an easy way to remove an individual `Service` from\nthe service gateway. Compare " }, { "info": { "name": "ListServices", "type": "http" }, "http": { "method": "GET", "url": "/20160918/services", "params": [ { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists the available [Service](#/en/iaas/latest/Service/) objects that you can enable for a\nservice gateway in this region.\n" }, { "info": { "name": "GetService", "type": "http" }, "http": { "method": "GET", "url": "/20160918/services/:serviceId", "params": [ { "name": "serviceId", "value": "", "type": "path", "description": "The service's [OCID](/iaas/Content/General/Concepts/identifiers.htm)." } ] }, "docs": "Gets the specified [Service](#/en/iaas/latest/Service/) object.\n" }, { "info": { "name": "Get virtual network subnet topology", "type": "http" }, "http": { "method": "GET", "url": "/20160918/subnetTopology", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-none-match", "value": "" }, { "name": "cache-control", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are `ANY` and `ACCESSIBLE`. The default is `ANY`.\nSetting this to `ACCESSIBLE` returns only compartments for which a\nuser has INSPECT permissions, either directly or indirectly (permissions can be on a\nresource in a subcompartment). A restricted set of fields is returned for compartments in which a user has\nindirect INSPECT permissions.\n\nWhen set to `ANY` permissions are not checked.\n" }, { "name": "queryCompartmentSubtree", "value": "", "type": "query", "description": "When set to true, the hierarchy of compartments is traversed\nand the specified compartment and its subcompartments are\ninspected depending on the the setting of `accessLevel`.\nDefault is false.\n" }, { "name": "subnetId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet." } ] }, "docs": "Gets a topology for a given subnet." }, { "info": { "name": "ListSubnets", "type": "http" }, "http": { "method": "GET", "url": "/20160918/subnets", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "vcnId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle\nstate. The state value is case-insensitive.\n" } ] }, "docs": "Lists the subnets in the specified VCN and the specified compartment.\nIf the VCN ID is not provided, then the list includes the subnets from all VCNs in the specified compartment.\n" }, { "info": { "name": "CreateSubnet", "type": "http" }, "http": { "method": "POST", "url": "/20160918/subnets", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new subnet in the specified VCN. You can't change the size of the subnet after creation,\nso it's important to think about the size of subnets you need before creating them.\nFor more information, see [VCNs and Subnets](/iaas/Content/Network/Tasks/managingVCNs.htm).\nFor information on the number of subnets you can have in a VCN, see\n[Service Limits](/iaas/Content/General/Concepts/servicelimits.htm).\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Co" }, { "info": { "name": "GetSubnet", "type": "http" }, "http": { "method": "GET", "url": "/20160918/subnets/:subnetId", "params": [ { "name": "subnetId", "value": "", "type": "path", "description": "Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet." } ] }, "docs": "Gets the specified subnet's information." }, { "info": { "name": "UpdateSubnet", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/subnets/:subnetId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "subnetId", "value": "", "type": "path", "description": "Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified subnet.\n" }, { "info": { "name": "DeleteSubnet", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/subnets/:subnetId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "subnetId", "value": "", "type": "path", "description": "Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet." } ] }, "docs": "Deletes the specified subnet, but only if there are no instances in the subnet. This is an asynchronous\noperation. The subnet's `lifecycleState` will change to TERMINATING temporarily. If there are any\ninstances in the subnet, the state will instead change back to AVAILABLE.\n" }, { "info": { "name": "AddIpv4SubnetCidr", "type": "http" }, "http": { "method": "POST", "url": "/20160918/subnets/:subnetId/actions/addIpv4Cidr", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "subnetId", "value": "", "type": "path", "description": "Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add an IPv4 prefix to a subnet.\n" }, { "info": { "name": "AddIpv6SubnetCidr", "type": "http" }, "http": { "method": "POST", "url": "/20160918/subnets/:subnetId/actions/addIpv6Cidr", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "subnetId", "value": "", "type": "path", "description": "Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add an IPv6 prefix to a subnet.\n" }, { "info": { "name": "ChangeSubnetCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/subnets/:subnetId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "subnetId", "value": "", "type": "path", "description": "Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a subnet into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "ModifyIpv4SubnetCidr", "type": "http" }, "http": { "method": "POST", "url": "/20160918/subnets/:subnetId/actions/modifyIpv4Cidr", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "subnetId", "value": "", "type": "path", "description": "Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified Ipv4 CIDR block of a Subnet. The new Ipv4 CIDR IP range must meet the following criteria:\n\n- Must be valid.\n- Must not overlap with another Ipv4 CIDR block in the Subnet or the on-premises network CIDR block.\n- Must not exceed the limit of Ipv4 CIDR blocks allowed per Subnet.\n- Must include IP addresses from the original CIDR block that are used in the VCN's existing route rules.\n- No IP address in an existing subnet should be outside of the new CIDR block range.\n" }, { "info": { "name": "RemoveIpv4SubnetCidr", "type": "http" }, "http": { "method": "POST", "url": "/20160918/subnets/:subnetId/actions/removeIpv4Cidr", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "subnetId", "value": "", "type": "path", "description": "Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove an IPv4 prefix from a subnet\n" }, { "info": { "name": "RemoveIpv6SubnetCidr", "type": "http" }, "http": { "method": "POST", "url": "/20160918/subnets/:subnetId/actions/removeIpv6Cidr", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "subnetId", "value": "", "type": "path", "description": "Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove an IPv6 prefix from a subnet. At least one IPv6 CIDR should remain.\n" }, { "info": { "name": "Get Virtual Network VCN topology", "type": "http" }, "http": { "method": "GET", "url": "/20160918/vcnTopology", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-none-match", "value": "" }, { "name": "cache-control", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "accessLevel", "value": "", "type": "query", "description": "Valid values are `ANY` and `ACCESSIBLE`. The default is `ANY`.\nSetting this to `ACCESSIBLE` returns only compartments for which a\nuser has INSPECT permissions, either directly or indirectly (permissions can be on a\nresource in a subcompartment). A restricted set of fields is returned for compartments in which a user has\nindirect INSPECT permissions.\n\nWhen set to `ANY` permissions are not checked.\n" }, { "name": "queryCompartmentSubtree", "value": "", "type": "query", "description": "When set to true, the hierarchy of compartments is traversed\nand the specified compartment and its subcompartments are\ninspected depending on the the setting of `accessLevel`.\nDefault is false.\n" }, { "name": "vcnId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN." } ] }, "docs": "Gets a virtual network topology for a given VCN." }, { "info": { "name": "ListVcns", "type": "http" }, "http": { "method": "GET", "url": "/20160918/vcns", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle\nstate. The state value is case-insensitive.\n" } ] }, "docs": "Lists the virtual cloud networks (VCNs) in the specified compartment.\n" }, { "info": { "name": "CreateVcn", "type": "http" }, "http": { "method": "POST", "url": "/20160918/vcns", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new virtual cloud network (VCN). For more information, see\n[VCNs and Subnets](/iaas/Content/Network/Tasks/managingVCNs.htm).\n\nFor the VCN, you specify a list of one or more IPv4 CIDR blocks that meet the following criteria:\n\n- The CIDR blocks must be valid.\n- They must not overlap with each other or with the on-premises network CIDR block.\n- The number of CIDR blocks does not exceed the limit of CIDR blocks allowed per VCN.\n\nFor a CIDR block, Oracle recommends that you use one of the p" }, { "info": { "name": "GetVcn", "type": "http" }, "http": { "method": "GET", "url": "/20160918/vcns/:vcnId", "params": [ { "name": "vcnId", "value": "", "type": "path", "description": "Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN." } ] }, "docs": "Gets the specified VCN's information." }, { "info": { "name": "UpdateVcn", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/vcns/:vcnId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "vcnId", "value": "", "type": "path", "description": "Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified VCN.\n" }, { "info": { "name": "DeleteVcn", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/vcns/:vcnId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "vcnId", "value": "", "type": "path", "description": "Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN." } ] }, "docs": "Deletes the specified VCN. The VCN must be completely empty and have no attached gateways. This is an asynchronous\noperation.\n\nA deleted VCN's `lifecycleState` changes to TERMINATING and then TERMINATED temporarily until the VCN is completely\nremoved. A completely removed VCN does not appear in the results of a `ListVcns` operation and can't be used in a\n`GetVcn` operation.\n" }, { "info": { "name": "AddVcnCidr", "type": "http" }, "http": { "method": "POST", "url": "/20160918/vcns/:vcnId/actions/addCidr", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "vcnId", "value": "", "type": "path", "description": "Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a CIDR block to a VCN. The CIDR block you add:\n\n- Must be valid.\n- Must not overlap with another CIDR block in the VCN, a CIDR block of a peered VCN, or the on-premises network CIDR block.\n- Must not exceed the limit of CIDR blocks allowed per VCN.\n\n**Note:** Adding a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN's subnets, VLANs, LPGs, or route tables during this operation. The time to completion can take a few minutes. " }, { "info": { "name": "AddVcnIpv6Cidr", "type": "http" }, "http": { "method": "POST", "url": "/20160918/vcns/:vcnId/actions/addIpv6Cidr", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "vcnId", "value": "", "type": "path", "description": "Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add an IPv6 prefix to a VCN. The VCN size is always /56.\nAddIpv6VcnCidr supports adding Private IPv6 Prefix i.e. ULA or an IPv6 GUA assigned by Oracle or BYOIPv6 Prefix, only one of these per request.\nOnce added the IPv6 prefix cannot be removed or modified.\n" }, { "info": { "name": "ChangeVcnCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/vcns/:vcnId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "vcnId", "value": "", "type": "path", "description": "Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a VCN into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "ModifyVcnCidr", "type": "http" }, "http": { "method": "POST", "url": "/20160918/vcns/:vcnId/actions/modifyCidr", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "vcnId", "value": "", "type": "path", "description": "Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified CIDR block of a VCN. The new CIDR IP range must meet the following criteria:\n\n- Must be valid.\n- Must not overlap with another CIDR block in the VCN, a CIDR block of a peered VCN, or the on-premises network CIDR block.\n- Must not exceed the limit of CIDR blocks allowed per VCN.\n- Must include IP addresses from the original CIDR block that are used in the VCN's existing route rules.\n- No IP address in an existing subnet should be outside of the new CIDR block range.\n\n**Note:" }, { "info": { "name": "RemoveVcnCidr", "type": "http" }, "http": { "method": "POST", "url": "/20160918/vcns/:vcnId/actions/removeCidr", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "vcnId", "value": "", "type": "path", "description": "Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes a specified CIDR block from a VCN.\n\n**Notes:**\n- You cannot remove a CIDR block if an IP address in its range is in use.\n- Removing a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN's subnets, VLANs, LPGs, or route tables during this operation. The time to completion can take a few minutes. You can use the `GetWorkRequest` operation to check the status of the update.\n" }, { "info": { "name": "RemoveIpv6VcnCidr", "type": "http" }, "http": { "method": "POST", "url": "/20160918/vcns/:vcnId/actions/removeIpv6Cidr", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "vcnId", "value": "", "type": "path", "description": "Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removing an existing IPv6 prefix from a VCN.\n" }, { "info": { "name": "ListVirtualCircuitBandwidthShapes", "type": "http" }, "http": { "method": "GET", "url": "/20160918/virtualCircuitBandwidthShapes", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "The operation lists available bandwidth levels for virtual circuits. For the compartment ID, provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of your tenancy (the root compartment).\n" }, { "info": { "name": "ListVirtualCircuits", "type": "http" }, "http": { "method": "GET", "url": "/20160918/virtualCircuits", "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the specified lifecycle\nstate. The value is case insensitive.\n" } ] }, "docs": "Lists the virtual circuits in the specified compartment.\n" }, { "info": { "name": "CreateVirtualCircuit", "type": "http" }, "http": { "method": "POST", "url": "/20160918/virtualCircuits", "headers": [ { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new virtual circuit to use with Oracle Cloud\nInfrastructure FastConnect. For more information, see\n[FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the\ncompartment where you want the virtual circuit to reside. If you're\nnot sure which compartment to use, put the virtual circuit in the\nsame compartment with the DRG it's using. For more information ab" }, { "info": { "name": "GetVirtualCircuit", "type": "http" }, "http": { "method": "GET", "url": "/20160918/virtualCircuits/:virtualCircuitId", "params": [ { "name": "virtualCircuitId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the virtual circuit." } ] }, "docs": "Gets the specified virtual circuit's information." }, { "info": { "name": "UpdateVirtualCircuit", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/virtualCircuits/:virtualCircuitId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "virtualCircuitId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the virtual circuit." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified virtual circuit. This can be called by\neither the customer who owns the virtual circuit, or the\nprovider (when provisioning or de-provisioning the virtual\ncircuit from their end). The documentation for\n[UpdateVirtualCircuitDetails](#/en/iaas/latest/requests/UpdateVirtualCircuitDetails)\nindicates who can update each property of the virtual circuit.\n\n**Important:** If the virtual circuit is working and in the\nPROVISIONED state, updating any of the network-related properties\n(" }, { "info": { "name": "DeleteVirtualCircuit", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/virtualCircuits/:virtualCircuitId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "virtualCircuitId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the virtual circuit." } ] }, "docs": "Deletes the specified virtual circuit.\n\n**Important:** If you're using FastConnect via a provider,\nmake sure to also terminate the connection with\nthe provider, or else the provider may continue to bill you.\n" }, { "info": { "name": "BulkAddVirtualCircuitPublicPrefixes", "type": "http" }, "http": { "method": "POST", "url": "/20160918/virtualCircuits/:virtualCircuitId/actions/bulkAddPublicPrefixes", "params": [ { "name": "virtualCircuitId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the virtual circuit." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds one or more customer public IP prefixes to the specified public virtual circuit.\nUse this operation (and not [UpdateVirtualCircuit](#/en/iaas/latest/VirtualCircuit/UpdateVirtualCircuit))\nto add prefixes to the virtual circuit. Oracle must verify the customer's ownership\nof each prefix before traffic for that prefix will flow across the virtual circuit.\n" }, { "info": { "name": "BulkDeleteVirtualCircuitPublicPrefixes", "type": "http" }, "http": { "method": "POST", "url": "/20160918/virtualCircuits/:virtualCircuitId/actions/bulkDeletePublicPrefixes", "params": [ { "name": "virtualCircuitId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the virtual circuit." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes one or more customer public IP prefixes from the specified public virtual circuit.\nUse this operation (and not [UpdateVirtualCircuit](#/en/iaas/latest/VirtualCircuit/UpdateVirtualCircuit))\nto remove prefixes from the virtual circuit. When the virtual circuit's state switches\nback to PROVISIONED, Oracle stops advertising the specified prefixes across the connection.\n" }, { "info": { "name": "ChangeVirtualCircuitCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/virtualCircuits/:virtualCircuitId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "virtualCircuitId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the virtual circuit." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a virtual circuit into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "ListVirtualCircuitAssociatedTunnels", "type": "http" }, "http": { "method": "GET", "url": "/20160918/virtualCircuits/:virtualCircuitId/associatedTunnels", "params": [ { "name": "virtualCircuitId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the virtual circuit." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Gets the specified virtual circuit's associatedTunnelsInfo." }, { "info": { "name": "ListCrossConnectMappings", "type": "http" }, "http": { "method": "GET", "url": "/20160918/virtualCircuits/:virtualCircuitId/crossConnectMappings", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "virtualCircuitId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the virtual circuit." } ] }, "docs": "Lists the Cross Connect mapping Details for the specified\nvirtual circuit.\n" }, { "info": { "name": "ListVirtualCircuitPublicPrefixes", "type": "http" }, "http": { "method": "GET", "url": "/20160918/virtualCircuits/:virtualCircuitId/publicPrefixes", "params": [ { "name": "virtualCircuitId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the virtual circuit." }, { "name": "verificationState", "value": "", "type": "query", "description": "A filter to only return resources that match the given verification\nstate.\n\nThe state value is case-insensitive.\n" } ] }, "docs": "Lists the public IP prefixes and their details for the specified\npublic virtual circuit.\n" }, { "info": { "name": "ListVlans", "type": "http" }, "http": { "method": "GET", "url": "/20160918/vlans", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "vcnId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle\nstate. The state value is case-insensitive.\n" } ] }, "docs": "Lists the VLANs in the specified VCN and the specified compartment.\n" }, { "info": { "name": "CreateVlan", "type": "http" }, "http": { "method": "POST", "url": "/20160918/vlans", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a VLAN in the specified VCN and the specified compartment.\n" }, { "info": { "name": "GetVlan", "type": "http" }, "http": { "method": "GET", "url": "/20160918/vlans/:vlanId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vlanId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN." } ] }, "docs": "Gets the specified VLAN's information." }, { "info": { "name": "UpdateVlan", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/vlans/:vlanId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vlanId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified VLAN. Note that this operation might require changes to all\nthe VNICs in the VLAN, which can take a while. The VLAN will be in the UPDATING state until the changes are complete.\n" }, { "info": { "name": "DeleteVlan", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/vlans/:vlanId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vlanId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN." } ] }, "docs": "Deletes the specified VLAN, but only if there are no VNICs in the VLAN.\n" }, { "info": { "name": "ChangeVlanCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/vlans/:vlanId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "vlanId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a VLAN into a different compartment within the same tenancy.\nFor information about moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "GetVnic", "type": "http" }, "http": { "method": "GET", "url": "/20160918/vnics/:vnicId", "params": [ { "name": "vnicId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC." } ] }, "docs": "Gets the information for the specified virtual network interface card (VNIC).\nYou can get the VNIC [OCID](/iaas/Content/General/Concepts/identifiers.htm) from the\n[ListVnicAttachments](#/en/iaas/latest/VnicAttachment/ListVnicAttachments)\noperation.\n" }, { "info": { "name": "UpdateVnic", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/vnics/:vnicId", "headers": [ { "name": "if-match", "value": "" } ], "params": [ { "name": "vnicId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified VNIC.\n" }, { "info": { "name": "ListVtaps", "type": "http" }, "http": { "method": "GET", "url": "/20160918/vtaps", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment." }, { "name": "vcnId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN." }, { "name": "source", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VTAP source." }, { "name": "targetId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VTAP target." }, { "name": "targetIp", "value": "", "type": "query", "description": "The IP address of the VTAP target." }, { "name": "isVtapEnabled", "value": "", "type": "query", "description": "Indicates whether to list all VTAPs or only running VTAPs.\n\n* When `FALSE`, lists ALL running and stopped VTAPs.\n* When `TRUE`, lists only running VTAPs (VTAPs where isVtapEnabled = `TRUE`).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given VTAP administrative lifecycle state.\nThe state value is case-insensitive.\n" } ] }, "docs": "Lists the virtual test access points (VTAPs) in the specified compartment.\n" }, { "info": { "name": "CreateVtap", "type": "http" }, "http": { "method": "POST", "url": "/20160918/vtaps", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a virtual test access point (VTAP) in the specified compartment.\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the VTAP.\nFor more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\nFor information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally speci" }, { "info": { "name": "GetVtap", "type": "http" }, "http": { "method": "GET", "url": "/20160918/vtaps/:vtapId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vtapId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VTAP." } ] }, "docs": "Gets the specified `Vtap` resource." }, { "info": { "name": "UpdateVtap", "type": "http" }, "http": { "method": "PUT", "url": "/20160918/vtaps/:vtapId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vtapId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VTAP." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified VTAP's display name or tags.\n" }, { "info": { "name": "DeleteVtap", "type": "http" }, "http": { "method": "DELETE", "url": "/20160918/vtaps/:vtapId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vtapId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VTAP." } ] }, "docs": "Deletes the specified VTAP. This is an asynchronous operation. The VTAP's `lifecycleState` will change to\nTERMINATING temporarily until the VTAP is completely removed.\n" }, { "info": { "name": "ChangeVtapCompartment", "type": "http" }, "http": { "method": "POST", "url": "/20160918/vtaps/:vtapId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "vtapId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VTAP." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a VTAP to a new compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" } ] } ], "bundled": true }