CreateCpe

POST {{baseUrl}}/cpes

Creates a new virtual customer-premises equipment (CPE) object in the specified compartment. For more information, see Site-to-Site VPN Overview.

For the purposes of access control, you must provide the OCID of the compartment where you want the CPE to reside. Notice that the CPE doesn't have to be in the same compartment as the IPSec connection or other Networking Service components. If you're not sure which compartment to use, put the CPE in the same compartment as the DRG. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.

You must provide the public IP address of your on-premises router. See CPE Configuration.

You may optionally specify a display name for the CPE, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.

Request Body

{"compartmentId"=>"{{compartment_ocid}}", "ipAddress"=>"Duis commodo", "cpeDeviceShapeId"=>"in cupidatat magna aute fugiat", "displayName"=>"dolor ut in velit sunt"}

HEADERS

KeyDatatypeRequiredDescription
opc-retry-tokenstringA token that uniquely identifies a request so it can be retried in case of a timeout or
server error without risk of executing that same action again. Retry tokens expire after 24
hours, but can be invalidated before then due to conflicting operations (for example, if a resource
has been deleted and purged from the system, then a retry of the original creation request
may be rejected).
Content-Typestring
Datestring(Required) Current Date
Authorizationstring(Required) Signature Authentication on Authorization header
x-content-sha256string(Required) Content sha256 for POST, PUT and PATCH operations

RESPONSES

status: OK

{"compartmentId":"ut commodo enim aute consectetur","id":"incididunt anim","ipAddress":"dolore consectetur","cpeDeviceShapeId":"eiusmod laborum proi","definedTags":{},"displayName":"tempor sint et pariatur","freeformTags":{},"timeCreated":"1948-01-11T13:26:43.224Z"}