proxy:generatekey
Generates a new API key for proxy authentication.
The API key is displayed only once at creation time and cannot be viewed again afterward. When a new key is generated, the previous key is automatically revoked. After generating a new key, you must update the API key configuration in all third-party tools that use SuiteCloud Developer Assistant (SDA).
When you do operations that require NetSuite authentication, SuiteCloud SDK retrieves the passkey from secure storage and uses it to decrypt the credentials file. For this reason, ensure that secure storage is accessible and properly configured on your machine if you want to use browser-based authentication.
If secure storage isn't available, you can define a fallback passkey by creating the SUITECLOUD_FALLBACK_PASSKEY environment variable. This passkey must contain 32 to 100 alphanumeric characters. For information about how to set environment variables for different operating systems, see Setting Up Environment Variables for SuiteCloud SDK Tools.
For more information, see Credentials and Passkey Errors.
Syntax
suitecloud project:generatekey
Options
|
Option |
Required / Optional |
Description |
|---|---|---|
|
-h or --help |
Optional |
Prints the help for this command. |
Example
Here's a command that generates a new API key for proxy authentication:
suitecloud proxy:generatekey
Output Example
When you run the command, it produces an output that is similar to the following:
New API key for proxy authentication generated: "abab12345cc1636b01d8a7fdefa2892397155aac5aaaac591101053c1628db64". Store it securely and update it in your third-party tool of choice.
This API key will never be shown again, so if you forget it, you will need to generate a new one by running this command again.
One API key can be reused across multiple third-party tools and environments at the same time. Avoid generating a new API key unless necessary, because generating a new key automatically revokes the existing one.