Create API key
Use the OneSignal API to create a new Rich Authentication Token (App API Key) for a specific app. This guide explains how to authenticate with the Organization API key and configure optional IP allowlists using CIDR notation.
Overview
Use this API to create a new App API Key (also called a Rich Authentication Token) for a specific OneSignal app. These keys are used to authenticate API requests at the app level and offer enhanced security features, including optional IP allowlisting.
For background on different OneSignal API keys, see Keys & IDs.
How to use this API
Use your Organization API Key, to authenticate. This key is different from the standard REST API key.
IP allowlisting
By default, the API key will not be restricted to any specific IP addresses. To enable IP allowlisting, you need to set the ip_allowlist_mode
parameter to explicit
and provide a list of allowed IP addresses in the ip_allowlist
parameter.
If you want to set the explicit range of IPs that can use this API key, add them by setting ip_allowlist_mode
to explicit
and in ip_allowlist
add the IPs in CIDRs notation as an array of string values.
Path Parameters
Your OneSignal App ID in UUID v4 format. See Keys & IDs.
Body
Response
200
The response is of type object
.