Generate Pre Shared Key (PSK) for IPsec tunnels

POST

https://api.cloudflare.com/client/v4/accounts/{account_identifier}/magic/ipsec_tunnels/{tunnel_identifier}/psk_generate

Last modified:2022-12-16 13:48:33

Generates a Pre Shared Key for a specific IPsec tunnel used in the IKE session. Use ?validate_only=true as an optional query parameter to only run validation without persisting changes. After a PSK is generated, the PSK is immediately persisted to Cloudflare's edge and cannot be retrieved later. Note the PSK in a safe place.

Request

Path Params

tunnel_identifier

string

required

account_identifier

string

required

Body Params application/json

object {0}

Example

{}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cloudflare.com/client/v4/accounts//magic/ipsec_tunnels//psk_generate' \
--header 'Content-Type: application/json' \
--data-raw '{}'

Responses

🟢200Generate Pre Shared Key (PSK) for IPsec tunnels response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "ipsec_tunnel_id": "023e105f4ecef8ad9ca31a8372d0c353",
        "psk": "O3bwKSjnaoCxDoUxjcq4Rk8ZKkezQUiy",
        "psk_metadata": {
            "last_generated_on": "2017-06-14T05:20:00Z"
        }
    },
    "success": true
}

🟢200Generate Pre Shared Key (PSK) for IPsec tunnels response failure

Modified at 2022-12-16 13:48:33

Update IPsec Tunnel

List interconnects