Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Constants](https://developer.android.com/reference/android/net/VpnManager#constants) \| [Methods](https://developer.android.com/reference/android/net/VpnManager#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/net/VpnManager#inhmethods)
# VpnManager
*** ** * ** ***
` public class VpnManager `
` extends https://developer.android.com/reference/java/lang/Object ` ` `
|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.net.VpnManager |
*** ** * ** ***
This class provides an interface for apps to manage platform VPN profiles
Apps can use this API to provide profiles with which the platform can set up a VPN without further app intermediation. When a VPN profile is present and the app is selected as an always-on VPN, the platform will directly trigger the negotiation of the VPN without starting or waking the app (unlike VpnService).
VPN apps using supported protocols should preferentially use this API over the `https://developer.android.com/reference/android/net/VpnService` API for ease-of-development and reduced maintenance burden. This also give the user the guarantee that VPN network traffic is not subjected to on-device packet interception.
Restricted for SDK Runtime environment in API level 34.
**See also:**
- `https://developer.android.com/reference/android/net/Ikev2VpnProfile`
## Summary
| ### Constants ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/reference/android/net/VpnManager#ACTION_VPN_MANAGER_EVENT` Action sent in `https://developer.android.com/reference/android/content/Intent`s to VpnManager clients when an event occurred. |
| `https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/reference/android/net/VpnManager#CATEGORY_EVENT_ALWAYS_ON_STATE_CHANGED` The always-on state of this VPN was changed This may be the result of a user changing VPN settings, or a Device Policy Manager app having changed the VPN policy. |
| `https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/reference/android/net/VpnManager#CATEGORY_EVENT_DEACTIVATED_BY_USER` The user deactivated the VPN. |
| `https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/reference/android/net/VpnManager#CATEGORY_EVENT_IKE_ERROR` An IKE protocol error occurred. |
| `https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/reference/android/net/VpnManager#CATEGORY_EVENT_NETWORK_ERROR` A network error occurred. |
| `int` | `https://developer.android.com/reference/android/net/VpnManager#ERROR_CLASS_NOT_RECOVERABLE` `https://developer.android.com/reference/android/net/VpnManager#EXTRA_ERROR_CLASS` coding for a non-recoverable error. |
| `int` | `https://developer.android.com/reference/android/net/VpnManager#ERROR_CLASS_RECOVERABLE` `https://developer.android.com/reference/android/net/VpnManager#EXTRA_ERROR_CLASS` coding for a recoverable error. |
| `int` | `https://developer.android.com/reference/android/net/VpnManager#ERROR_CODE_NETWORK_IO` An `https://developer.android.com/reference/android/net/VpnManager#EXTRA_ERROR_CODE` for `https://developer.android.com/reference/android/net/VpnManager#CATEGORY_EVENT_NETWORK_ERROR` indicating an input/output error. |
| `int` | `https://developer.android.com/reference/android/net/VpnManager#ERROR_CODE_NETWORK_LOST` An `https://developer.android.com/reference/android/net/VpnManager#EXTRA_ERROR_CODE` for `https://developer.android.com/reference/android/net/VpnManager#CATEGORY_EVENT_NETWORK_ERROR` indicating that network connectivity was lost. |
| `int` | `https://developer.android.com/reference/android/net/VpnManager#ERROR_CODE_NETWORK_PROTOCOL_TIMEOUT` An `https://developer.android.com/reference/android/net/VpnManager#EXTRA_ERROR_CODE` for `https://developer.android.com/reference/android/net/VpnManager#CATEGORY_EVENT_NETWORK_ERROR` indicating a timeout. |
| `int` | `https://developer.android.com/reference/android/net/VpnManager#ERROR_CODE_NETWORK_UNKNOWN_HOST` An `https://developer.android.com/reference/android/net/VpnManager#EXTRA_ERROR_CODE` for `https://developer.android.com/reference/android/net/VpnManager#CATEGORY_EVENT_NETWORK_ERROR` to indicate that the network host isn't known. |
| `https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/reference/android/net/VpnManager#EXTRA_ERROR_CLASS` Extra for the error class, as an `int`. |
| `https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/reference/android/net/VpnManager#EXTRA_ERROR_CODE` Extra for an error code, as an `int`. |
| `https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/reference/android/net/VpnManager#EXTRA_SESSION_KEY` The key of the session that experienced this event, as a `String`. |
| `https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/reference/android/net/VpnManager#EXTRA_TIMESTAMP_MILLIS` A `long` timestamp containing the time at which the event occurred. |
| `https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/reference/android/net/VpnManager#EXTRA_UNDERLYING_LINK_PROPERTIES` The `https://developer.android.com/reference/android/net/LinkProperties` of the underlying network when the event occurred. |
| `https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/reference/android/net/VpnManager#EXTRA_UNDERLYING_NETWORK` The network that was underlying the VPN when the event occurred, as a `https://developer.android.com/reference/android/net/Network`. |
| `https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/reference/android/net/VpnManager#EXTRA_UNDERLYING_NETWORK_CAPABILITIES` The `https://developer.android.com/reference/android/net/NetworkCapabilities` of the underlying network when the event occurred. |
| `https://developer.android.com/reference/java/lang/String` | `https://developer.android.com/reference/android/net/VpnManager#EXTRA_VPN_PROFILE_STATE` The VpnProfileState at the time that this event occurred. |
| ### Public methods ||
|---|---|
| ` void` | ` https://developer.android.com/reference/android/net/VpnManager#deleteProvisionedVpnProfile()() ` Delete the VPN profile configuration that was provisioned by the calling app |
| ` https://developer.android.com/reference/android/net/VpnProfileState` | ` https://developer.android.com/reference/android/net/VpnManager#getProvisionedVpnProfileState()() ` Retrieve the VpnProfileState for the profile provisioned by the calling package. |
| ` https://developer.android.com/reference/android/content/Intent` | ` https://developer.android.com/reference/android/net/VpnManager#provisionVpnProfile(android.net.PlatformVpnProfile)(https://developer.android.com/reference/android/net/PlatformVpnProfile profile) ` Install a VpnProfile configuration keyed on the calling app's package name. |
| ` void` | ` https://developer.android.com/reference/android/net/VpnManager#startProvisionedVpnProfile()() ` *This method was deprecated in API level 33. This method is replaced by startProvisionedVpnProfileSession which returns a session key for the caller to diagnose the errors.* |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/net/VpnManager#startProvisionedVpnProfileSession()() ` Request the startup of a previously provisioned VPN. |
| ` void` | ` https://developer.android.com/reference/android/net/VpnManager#stopProvisionedVpnProfile()() ` Tear down the VPN provided by the calling app (if any) |
### Inherited methods
From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `
Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `
Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class` ` https://developer.android.com/reference/java/lang/Object#getClass()() `
Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `
Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `
Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `
Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `
Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) `
Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) `
Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait()() `
Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
## Constants
### ACTION_VPN_MANAGER_EVENT
Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final String ACTION_VPN_MANAGER_EVENT
```
Action sent in `https://developer.android.com/reference/android/content/Intent`s to VpnManager clients when an event occurred.
If the provisioning application declares a service handling this intent action, but is not already running, it will be started. Upon starting, the application is granted a short grace period to run in the background even while the device is idle to handle any potential failures. Applications requiring long-running actions triggered by one of these events should declare a foreground service to prevent being killed once the grace period expires. This action will have a category of either `https://developer.android.com/reference/android/net/VpnManager#CATEGORY_EVENT_IKE_ERROR`, `https://developer.android.com/reference/android/net/VpnManager#CATEGORY_EVENT_NETWORK_ERROR`, or `https://developer.android.com/reference/android/net/VpnManager#CATEGORY_EVENT_DEACTIVATED_BY_USER`, that the app can use to filter events it's interested in reacting to. It will also contain the following extras :
- `https://developer.android.com/reference/android/net/VpnManager#EXTRA_SESSION_KEY`, a `String` for the session key, as returned by `https://developer.android.com/reference/android/net/VpnManager#startProvisionedVpnProfileSession()`.
- `https://developer.android.com/reference/android/net/VpnManager#EXTRA_TIMESTAMP_MILLIS`, a long for the timestamp at which the error occurred, in milliseconds since the epoch, as returned by `https://developer.android.com/reference/java/lang/System#currentTimeMillis()`.
- `https://developer.android.com/reference/android/net/VpnManager#EXTRA_UNDERLYING_NETWORK`, a `https://developer.android.com/reference/android/net/Network` containing the underlying network at the time the error occurred, or null if none. Note that this network may have disconnected already.
- `https://developer.android.com/reference/android/net/VpnManager#EXTRA_UNDERLYING_NETWORK_CAPABILITIES`, a `https://developer.android.com/reference/android/net/NetworkCapabilities` for the underlying network at the time the error occurred.
- `https://developer.android.com/reference/android/net/VpnManager#EXTRA_UNDERLYING_LINK_PROPERTIES`, a `https://developer.android.com/reference/android/net/LinkProperties` for the underlying network at the time the error occurred.
When this event is an error, either `https://developer.android.com/reference/android/net/VpnManager#CATEGORY_EVENT_IKE_ERROR` or `https://developer.android.com/reference/android/net/VpnManager#CATEGORY_EVENT_NETWORK_ERROR`, the following extras will be populated :
- `https://developer.android.com/reference/android/net/VpnManager#EXTRA_ERROR_CLASS`, an `int` for the class of error, either `https://developer.android.com/reference/android/net/VpnManager#ERROR_CLASS_RECOVERABLE` or `https://developer.android.com/reference/android/net/VpnManager#ERROR_CLASS_NOT_RECOVERABLE`.
- `https://developer.android.com/reference/android/net/VpnManager#EXTRA_ERROR_CODE`, an `int` error code specific to the error. See `https://developer.android.com/reference/android/net/VpnManager#EXTRA_ERROR_CODE` for details.
Constant Value: "android.net.action.VPN_MANAGER_EVENT"
### CATEGORY_EVENT_ALWAYS_ON_STATE_CHANGED
Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final String CATEGORY_EVENT_ALWAYS_ON_STATE_CHANGED
```
The always-on state of this VPN was changed
This may be the result of a user changing VPN settings, or a Device Policy Manager app having changed the VPN policy.
Constant Value: "android.net.category.EVENT_ALWAYS_ON_STATE_CHANGED"
### CATEGORY_EVENT_DEACTIVATED_BY_USER
Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final String CATEGORY_EVENT_DEACTIVATED_BY_USER
```
The user deactivated the VPN. This can happen either when the user turns the VPN off explicitly, or when they select a different VPN provider.
Constant Value: "android.net.category.EVENT_DEACTIVATED_BY_USER"
### CATEGORY_EVENT_IKE_ERROR
Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final String CATEGORY_EVENT_IKE_ERROR
```
An IKE protocol error occurred. Codes (in `https://developer.android.com/reference/android/net/VpnManager#EXTRA_ERROR_CODE`) are the codes from `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException`, as defined by IANA in "IKEv2 Notify Message Types - Error Types".
Constant Value: "android.net.category.EVENT_IKE_ERROR"
### CATEGORY_EVENT_NETWORK_ERROR
Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final String CATEGORY_EVENT_NETWORK_ERROR
```
A network error occurred. Error codes (in `https://developer.android.com/reference/android/net/VpnManager#EXTRA_ERROR_CODE`) are ERROR_CODE_NETWORK_\*.
Constant Value: "android.net.category.EVENT_NETWORK_ERROR"
### ERROR_CLASS_NOT_RECOVERABLE
Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int ERROR_CLASS_NOT_RECOVERABLE
```
`https://developer.android.com/reference/android/net/VpnManager#EXTRA_ERROR_CLASS` coding for a non-recoverable error. This error is fatal, e.g. configuration error. The stack will not retry connection.
Constant Value: 1 (0x00000001)
### ERROR_CLASS_RECOVERABLE
Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int ERROR_CLASS_RECOVERABLE
```
`https://developer.android.com/reference/android/net/VpnManager#EXTRA_ERROR_CLASS` coding for a recoverable error. The stack experienced an error but will retry with exponential backoff, e.g. network timeout.
Constant Value: 2 (0x00000002)
### ERROR_CODE_NETWORK_IO
Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int ERROR_CODE_NETWORK_IO
```
An `https://developer.android.com/reference/android/net/VpnManager#EXTRA_ERROR_CODE` for `https://developer.android.com/reference/android/net/VpnManager#CATEGORY_EVENT_NETWORK_ERROR` indicating an input/output error. This code happens when reading or writing to sockets on the underlying networks was terminated by an I/O error.
**See also:**
- `https://developer.android.com/reference/java/io/IOException`
Constant Value: 3 (0x00000003)
### ERROR_CODE_NETWORK_LOST
Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int ERROR_CODE_NETWORK_LOST
```
An `https://developer.android.com/reference/android/net/VpnManager#EXTRA_ERROR_CODE` for `https://developer.android.com/reference/android/net/VpnManager#CATEGORY_EVENT_NETWORK_ERROR` indicating that network connectivity was lost. The most common reason for this error is that the underlying network was disconnected, see `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeNetworkLostException`.
Constant Value: 2 (0x00000002)
### ERROR_CODE_NETWORK_PROTOCOL_TIMEOUT
Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int ERROR_CODE_NETWORK_PROTOCOL_TIMEOUT
```
An `https://developer.android.com/reference/android/net/VpnManager#EXTRA_ERROR_CODE` for `https://developer.android.com/reference/android/net/VpnManager#CATEGORY_EVENT_NETWORK_ERROR` indicating a timeout. For Ikev2 VPNs, this happens typically after a retransmission failure.
**See also:**
- `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeTimeoutException`
Constant Value: 1 (0x00000001)
### ERROR_CODE_NETWORK_UNKNOWN_HOST
Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final int ERROR_CODE_NETWORK_UNKNOWN_HOST
```
An `https://developer.android.com/reference/android/net/VpnManager#EXTRA_ERROR_CODE` for `https://developer.android.com/reference/android/net/VpnManager#CATEGORY_EVENT_NETWORK_ERROR` to indicate that the network host isn't known. This happens when domain name resolution could not resolve an IP address for the specified host.
**See also:**
- `https://developer.android.com/reference/java/net/UnknownHostException`
Constant Value: 0 (0x00000000)
### EXTRA_ERROR_CLASS
Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final String EXTRA_ERROR_CLASS
```
Extra for the error class, as an `int`. This is always either `https://developer.android.com/reference/android/net/VpnManager#ERROR_CLASS_NOT_RECOVERABLE` or `https://developer.android.com/reference/android/net/VpnManager#ERROR_CLASS_RECOVERABLE`. This extra is only populated for error categories.
Constant Value: "android.net.extra.ERROR_CLASS"
### EXTRA_ERROR_CODE
Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final String EXTRA_ERROR_CODE
```
Extra for an error code, as an `int`.
- For `https://developer.android.com/reference/android/net/VpnManager#CATEGORY_EVENT_NETWORK_ERROR`, this is one of the `ERROR_CODE_NETWORK_*` constants.
- For `https://developer.android.com/reference/android/net/VpnManager#CATEGORY_EVENT_IKE_ERROR`, this is one of values defined in `https://developer.android.com/reference/android/net/ipsec/ike/exceptions/IkeProtocolException`.ERROR_TYPE_\*.
For non-error categories, this extra is not populated.
Constant Value: "android.net.extra.ERROR_CODE"
### EXTRA_SESSION_KEY
Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final String EXTRA_SESSION_KEY
```
The key of the session that experienced this event, as a `String`. This is the same key that was returned by `https://developer.android.com/reference/android/net/VpnManager#startProvisionedVpnProfileSession()`.
Constant Value: "android.net.extra.SESSION_KEY"
### EXTRA_TIMESTAMP_MILLIS
Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final String EXTRA_TIMESTAMP_MILLIS
```
A `long` timestamp containing the time at which the event occurred. This is a number of milliseconds since the epoch, suitable to be compared with `https://developer.android.com/reference/java/lang/System#currentTimeMillis()`.
Constant Value: "android.net.extra.TIMESTAMP_MILLIS"
### EXTRA_UNDERLYING_LINK_PROPERTIES
Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final String EXTRA_UNDERLYING_LINK_PROPERTIES
```
The `https://developer.android.com/reference/android/net/LinkProperties` of the underlying network when the event occurred.
This extra will be null if there was no underlying network at the time of the event, or the underlying network has no bearing on the event, as in the case of:
- CATEGORY_EVENT_DEACTIVATED_BY_USER
- CATEGORY_EVENT_ALWAYS_ON_STATE_CHANGED
Constant Value: "android.net.extra.UNDERLYING_LINK_PROPERTIES"
### EXTRA_UNDERLYING_NETWORK
Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final String EXTRA_UNDERLYING_NETWORK
```
The network that was underlying the VPN when the event occurred, as a `https://developer.android.com/reference/android/net/Network`.
This extra will be null if there was no underlying network at the time of the event, or the underlying network has no bearing on the event, as in the case of:
- CATEGORY_EVENT_DEACTIVATED_BY_USER
- CATEGORY_EVENT_ALWAYS_ON_STATE_CHANGED
Constant Value: "android.net.extra.UNDERLYING_NETWORK"
### EXTRA_UNDERLYING_NETWORK_CAPABILITIES
Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final String EXTRA_UNDERLYING_NETWORK_CAPABILITIES
```
The `https://developer.android.com/reference/android/net/NetworkCapabilities` of the underlying network when the event occurred.
This extra will be null if there was no underlying network at the time of the event, or the underlying network has no bearing on the event, as in the case of:
- CATEGORY_EVENT_DEACTIVATED_BY_USER
- CATEGORY_EVENT_ALWAYS_ON_STATE_CHANGED
Constant Value: "android.net.extra.UNDERLYING_NETWORK_CAPABILITIES"
### EXTRA_VPN_PROFILE_STATE
Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public static final String EXTRA_VPN_PROFILE_STATE
```
The VpnProfileState at the time that this event occurred.
This extra may be null if the VPN was revoked by the user, or the profile was deleted.
Constant Value: "android.net.extra.VPN_PROFILE_STATE"
## Public methods
### deleteProvisionedVpnProfile
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void deleteProvisionedVpnProfile ()
```
Delete the VPN profile configuration that was provisioned by the calling app
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/SecurityException` | if this would violate user settings |
### getProvisionedVpnProfileState
Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public VpnProfileState getProvisionedVpnProfileState ()
```
Retrieve the VpnProfileState for the profile provisioned by the calling package.
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/net/VpnProfileState` | the VpnProfileState with current information, or null if there was no profile provisioned and started by the calling package.
|
### provisionVpnProfile
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public Intent provisionVpnProfile (PlatformVpnProfile profile)
```
Install a VpnProfile configuration keyed on the calling app's package name.
This method returns `null` if user consent has already been granted, or an `https://developer.android.com/reference/android/content/Intent` to a system activity. If an intent is returned, the application should launch the activity using `https://developer.android.com/reference/android/app/Activity#startActivityForResult(android.content.Intent,%20int)` to request user consent. The activity may pop up a dialog to require user action, and the result will come back via its `https://developer.android.com/reference/android/app/Activity#onActivityResult(int,%20int,%20android.content.Intent)`. If the result is `https://developer.android.com/reference/android/app/Activity#RESULT_OK`, the user has consented, and the VPN profile can be started.
| Parameters ||
|---|---|
| `profile` | `PlatformVpnProfile`: the VpnProfile provided by this package. Will override any previous VpnProfile stored for this package. This value cannot be `null`.
|
| Returns ||
|---|---|
| `https://developer.android.com/reference/android/content/Intent` | an Intent requesting user consent to start the VPN, or null if consent is not required based on privileges or previous user consent.
|
### startProvisionedVpnProfile
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
Deprecated in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void startProvisionedVpnProfile ()
```
**This method was deprecated in API level 33.**
This method is replaced by startProvisionedVpnProfileSession which returns a session key for the caller to diagnose the errors.
Request the startup of a previously provisioned VPN.
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/SecurityException` | exception if user or device settings prevent this VPN from being setup, or if user consent has not been granted |
### startProvisionedVpnProfileSession
Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String startProvisionedVpnProfileSession ()
```
Request the startup of a previously provisioned VPN.
| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | A unique key corresponding to this session. This value cannot be `null`.
|
| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/SecurityException` | exception if user or device settings prevent this VPN from being setup, or if user consent has not been granted |
### stopProvisionedVpnProfile
Added in [API level 30](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void stopProvisionedVpnProfile ()
```
Tear down the VPN provided by the calling app (if any)