Skip to main content
POST

Authorizations

Authorization
string
header
required

The tenant API key that POST /bootstrap returned.

Body

application/json
platform
enum<string>
required
Available options:
ios,
android,
web
bundle_id
string
required

The iOS bundle ID or the Android package name. For a web app, any label.

name
string

A name for the app, which log lines show. Without one, log lines show the bundle ID. Up to 64 characters, with no control characters.

Maximum string length: 64
apns_team_id
string

The Apple team ID. Required for iOS.

apns_key_id
string

The APNs key ID. Required for iOS.

apns_key_pem
string
write-only

The contents of the APNs .p8 key, a PKCS

apns_environment
enum<string>
default:production

Use sandbox for builds from Xcode.

Available options:
production,
sandbox
fcm_project_id
string

The Firebase project ID. pgw sends pushes to this project. Required for Android. Must not be all digits.

fcm_project_number
string

The Firebase project number. Optional, but Linphone identifies its project by this number, so a Linphone build needs it.

Pattern: ^[0-9]*$
fcm_service_account_json
string
write-only

The contents of the Firebase service account key file. Required for Android.

vapid_subject
string

A mailto: or https: URI that push services can use to contact you. Required for web.

vapid_private_key_pem
string
write-only

A P-256 private key in PEM, PKCS

delivery_mode
enum<string>

Omit to use the gateway default.

Available options:
provisional,
always_push
managed_refresh_push
enum<string>

Whether pgw sends the app's managed iOS and Android devices a refresh push before their registration expires. Omit to use the gateway default.

Available options:
,
on,
off

Response

The app was registered.

id
string
required
platform
enum<string>
required
Available options:
ios,
android,
web
bundle_id
string
required
delivery_mode
enum<string>
required

Empty when the app uses the gateway default.

Available options:
,
provisional,
always_push
managed_refresh_push
enum<string>
required

Empty when the app uses the gateway default.

Available options:
,
on,
off
created_at
string<date-time>
required
name
string

Absent when the app has no name.

apns_team_id
string
apns_key_id
string
apns_environment
enum<string>
Available options:
production,
sandbox
fcm_project_id
string
fcm_project_number
string
vapid_public_key
string

A web app's VAPID public key, in unpadded base64url. Browsers subscribe with it.

vapid_subject
string