---
title: Set Pre-Shared Keys (PSK) for IPsec tunnels
---

[Skip to content](#%5Ftop) 

[API Reference](https://developers.cloudflare.com/api/python)

[Magic Transit](https://developers.cloudflare.com/api/python/resources/magic%5Ftransit)

[IPSEC Tunnels](https://developers.cloudflare.com/api/python/resources/magic%5Ftransit/subresources/ipsec%5Ftunnels)

Copy Markdown

Open in **Claude**

Open in **ChatGPT**

Open in **Cursor**

---

**Copy Markdown**

**View as Markdown**

# Set Pre-Shared Keys (PSK) for IPsec tunnels

magic\_transit.ipsec\_tunnels.psk\_set(IPSECTunnelPSKSetParams\*\*kwargs)  \-> [IPSECTunnelPSKSetResponse](https://developers.cloudflare.com/api/python/resources/magic%5Ftransit#%28resource%29%20magic%5Ftransit.ipsec%5Ftunnels%20%3E%20%28model%29%20ipsec%5Ftunnel%5Fpsk%5Fset%5Fresponse%20%3E%20%28schema%29)

POST/accounts/{account\_id}/magic/ipsec\_tunnels/psk

Sets Pre-Shared Keys for multiple IPsec tunnels associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. After PSKs are applied, they are immediately persisted to Cloudflare’s edge and cannot be retrieved later. Store the PSKs in a safe place.

##### Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/).

**Example:**`Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY`

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

**Example:**`X-Auth-Email: user@example.com`

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

**Example:**`X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194`

##### Accepted Permissions (at least one required)

`Magic WAN Write` `Magic Transit Write`

##### ParametersExpand Collapse 

account\_id: str

Identifier

maxLength32

psks: Iterable\[PSK\]

List of tunnel ID and PSK pairs.

id: str

The ID of the IPsec tunnel.

maxLength32

psk: str

A randomly generated or provided string for use in the IPsec tunnel.

validate\_only: Optional\[[bool](https://developers.cloudflare.com/api/python/resources/magic%5Ftransit/subresources/ipsec%5Ftunnels/methods/psk%5Fset#%28resource%29%20magic%5Ftransit.ipsec%5Ftunnels%20%3E%20%28method%29%20psk%5Fset%20%3E%20%28params%29%20default%20%3E%20%28param%29%20validate%5Fonly%20%3E%20%28schema%29)\]

If `true`, only run validation without persisting changes.

##### ReturnsExpand Collapse 

class IPSECTunnelPSKSetResponse: …

successfully\_applied\_psks: Optional\[Dict\[str, SuccessfullyAppliedPSKs\]\]

Map of tunnel IDs to successfully applied PSK details.

ipsec\_id: str

The IKE identifier used for this tunnel on the Cloudflare edge.

ipsec\_tunnel\_id: str

Identifier

maxLength32

psk: str

A randomly generated or provided string for use in the IPsec tunnel.

psk\_metadata: [PSKMetadata](https://developers.cloudflare.com/api/python/resources/magic%5Ftransit#%28resource%29%20magic%5Ftransit.ipsec%5Ftunnels%20%3E%20%28model%29%20psk%5Fmetadata%20%3E%20%28schema%29)

The PSK metadata that includes when the PSK was generated.

last\_generated\_on: Optional\[datetime\]

The date and time the tunnel was last modified.

formatdate-time

unapplied\_psks: Optional\[Dict\[str, str\]\]

Map of tunnel IDs to failure reasons for PSKs that could not be applied.

### Set Pre-Shared Keys (PSK) for IPsec tunnels

Python

HTTPHTTP

TypeScriptTypeScript

PythonPython

GoGo

TerraformTerraform

```
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
response = client.magic_transit.ipsec_tunnels.psk_set(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    psks=[{
        "id": "023e105f4ecef8ad9ca31a8372d0c353",
        "psk": "O3bwKSjnaoCxDoUxjcq4Rk8ZKkezQUiy",
    }],
)
print(response.successfully_applied_psks)
```

200 example

```
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "successfully_applied_psks": {
      "foo": {
        "ipsec_id": "12345_abc123def4567890abcdef1234567890",
        "ipsec_tunnel_id": "023e105f4ecef8ad9ca31a8372d0c353",
        "psk": "O3bwKSjnaoCxDoUxjcq4Rk8ZKkezQUiy",
        "psk_metadata": {
          "last_generated_on": "2017-06-14T05:20:00Z"
        }
      }
    },
    "unapplied_psks": {
      "foo": "string"
    }
  },
  "success": true
}
```

##### Returns Examples

200 example

```
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "successfully_applied_psks": {
      "foo": {
        "ipsec_id": "12345_abc123def4567890abcdef1234567890",
        "ipsec_tunnel_id": "023e105f4ecef8ad9ca31a8372d0c353",
        "psk": "O3bwKSjnaoCxDoUxjcq4Rk8ZKkezQUiy",
        "psk_metadata": {
          "last_generated_on": "2017-06-14T05:20:00Z"
        }
      }
    },
    "unapplied_psks": {
      "foo": "string"
    }
  },
  "success": true
}
```