Skip to main content

Manage AccessKey

An AccessKey is a credential for calling NineData OpenAPI and NineData Skill. It is separate from the password used to sign in to the NineData console. Create separate AccessKeys for different Agents or integration scenarios, then manage their status and source IP rules independently.

caution

SecretKey is only shown once on this page. Save it in a restricted secret manager or Agent local configuration before leaving that page. Do not place it in documentation, source code, repositories, logs, screenshots, or chats. It cannot be viewed again after closing; if lost, create a new AccessKey.

Create an AccessKey​

  1. Sign in to the NineData console and switch to organization mode.

  2. In the left navigation, open Account > AccessKey Management.

  3. Click Create AccessKey.

  4. Enter a Purpose Name and optionally enter a Purpose Description. The purpose name is required; the purpose description supports up to 200 characters.

  5. Click OK. On the result page, save the AccessKey and SecretKey.

    The new AccessKey appears in the list. You can view the AccessKey ID in the list, but the SecretKey is not displayed in the list or on the edit page.

Configure source IP control​

  1. In the AccessKey Management list, find the target AccessKey, open the more menu in the Operations column, and click Edit.

  2. In Access IP Control, enter the allowed IP addresses or CIDR ranges. Separate multiple values with English commas. For example:

    • Specific IP address: 192.168.0.1
    • CIDR range: 192.168.0.0/24
    • Multiple values: 192.168.0.1,192.168.0.0/24

  3. Click Save.

    Changes take effect immediately after saving; current connections are not affected. Clear the field and save to remove the source IP restriction for the AccessKey.

Manage status and view audit logs​

The list displays the following information:

ColumnDescription
Purpose NameThe purpose entered when the AccessKey was created.
AccessKeyThe system-generated AccessKey ID. You can view and copy it from the list.
StatusShows the current status of the AccessKey.
Created byThe account that created the AccessKey.
CreatedThe AccessKey creation time.
Last Used TimeThe most recent successful use of the AccessKey.
Last Access IPThe source IP of the most recent use.
The rightmost columnView audit logs or open More operations.

The More menu lets you edit, disable, enable, or delete an AccessKey, depending on its current status.

  • Once disabled, new calls will fail immediately; other AccessKeys are unaffected.
  • Once enabled, calls can resume; the original SecretKey remains valid.
  • Once deleted, new calls will fail immediately; other AccessKeys are unaffected. Before deleting it, confirm that no Agent or external integration still uses the credential.

Click View Audit for an AccessKey to open OpenAPI Request Logs and automatically filter the records by that AccessKey.

Next steps​