Create a Presentation Network

POST

/api/v1/presentation-networks

curl --request POST \
  --url https://example.com/api/v1/presentation-networks \
  --header 'Content-Type: application/json' \
  --header 'X-CSRF-Token: example' \
  --data '{ "name": "example", "ssid": "example", "hidden": false, "security": "wpa_psk", "secret": "example", "identity": "example", "anonymousIdentity": "example", "caCertificatePem": "example", "domainSuffixMatch": "example" }'

Parameters

Header Parameters

X-CSRF-Token

required

string

Request Body^required

Media typeapplication/json

object

name

required

string

>= 1 characters <= 120 characters

ssid

required

string

>= 1 characters <= 32 characters

hidden

required

boolean

security

required

WPA2/WPA3 Personal PSK or WPA2-Enterprise PEAP/MSCHAPv2.

string

Allowed values: wpa_psk wpa_eap_peap_mschapv2

secret

required

WPA PSK/passphrase or Enterprise password. Write-only; never returned by Studio, logged, audited, or placed in a player command.

string format: password

>= 1 characters <= 128 characters

identity

string

<= 253 characters

anonymousIdentity

string

<= 253 characters

caCertificatePem

string

<= 32768 characters

domainSuffixMatch

string

<= 253 characters

Responses

201

Network created; the credential is accepted but not returned

Media typeapplication/json

object

data

required

object

id

required

string format: uuid

name

required

string

>= 1 characters <= 120 characters

ssid

required

string

>= 1 characters <= 32 characters

hidden

required

boolean

security

required

WPA2/WPA3 Personal PSK or WPA2-Enterprise PEAP/MSCHAPv2.

string

Allowed values: wpa_psk wpa_eap_peap_mschapv2

securityLabel

required

string

auth

required

object

identity

string

<= 253 characters

anonymousIdentity

string

<= 253 characters

caCertificatePem

Public CA certificate chain for Enterprise server validation.

string

<= 32768 characters

domainSuffixMatch

Expected RADIUS server domain; requires caCertificatePem.

string

<= 253 characters

credentialSet

required

True means a credential exists; its value is never returned.

boolean

secretUpdatedAt

string format: date-time

configRevision

required

integer format: int64

>= 1

assignedScreens

required

integer

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "data": {
    "security": "wpa_psk"
  }
}

403

Insufficient role or CSRF failure

409

Encryption key unavailable or network name already exists

422

Network