Skip to main content
GET
/
developers
/
api_key_info
import cobo_waas2
from cobo_waas2.models.get_api_key_info200_response import GetApiKeyInfo200Response
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.DevelopersApi(api_client)

    try:
        # Get API key information
        api_response = api_instance.get_api_key_info()
        print("The response of DevelopersApi->get_api_key_info:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DevelopersApi->get_api_key_info: %s\n" % e)


{
  "name": "my_api_key",
  "curve_type": "ED25519",
  "key": "427b06814cca3359bd0e710c1187833b7f052748a3fdf59888fad4ddc4bd379f",
  "callback_url": "https://example.com/api/callback",
  "valid_ips": [
    "127.0.0.1"
  ],
  "created_timestamp": 1701396866000,
  "updated_timestamp": 1701396866000,
  "expired_timestamp": 1701396866000,
  "role_scopes": [
    {
      "role_name": "API_Spender",
      "scopes": {
        "wallet_types": [
          "Custodial"
        ],
        "wallet_subtypes": [
          "Asset"
        ],
        "wallet_ids": [
          "f47ac10b-58cc-4372-a567-0e02b2c3d479"
        ],
        "vault_ids": [
          "f47ac10b-58cc-4372-a567-0e02b2c3d479"
        ],
        "project_ids": [
          "f47ac10b-58cc-4372-a567-0e02b2c3d479"
        ]
      }
    }
  ]
}
import cobo_waas2
from cobo_waas2.models.get_api_key_info200_response import GetApiKeyInfo200Response
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.DevelopersApi(api_client)

    try:
        # Get API key information
        api_response = api_instance.get_api_key_info()
        print("The response of DevelopersApi->get_api_key_info:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DevelopersApi->get_api_key_info: %s\n" % e)

Authorizations

​
BIZ-API-KEY
string
header
required

The API key. For more details, refer to API key.

In the API playground, enter your API secret, and your API key will be accordingly calculated.

Response

The API key information.

​
name
string
required

The API key name.

Example:

"my_api_key"

​
curve_type
enum<string>
required

The curve type used for the API key, which determines the cryptographic algorithm for key generation and signing. Possible values include:

  • ED25519: Ed25519
  • SECP256K1: Secp256k1
Available options:
ED25519,
SECP256K1
Example:

"ED25519"

​
key
string
required

The API key value.

Example:

"427b06814cca3359bd0e710c1187833b7f052748a3fdf59888fad4ddc4bd379f"

​
created_timestamp
integer
required

The time when the API key was registered, in Unix timestamp format, measured in milliseconds.

Example:

1701396866000

​
updated_timestamp
integer
required

The time when the API key information was last updated, in Unix timestamp format, measured in milliseconds.

Example:

1701396866000

​
callback_url
string

The URL of the callback endpoint that receives callback messages triggered by this API key.

Example:

"https://example.com/api/callback"

​
valid_ips
string[]

(Applicable to permanent API keys only) The list of IP addresses that are allowed to use this API key.

​
expired_timestamp
integer

The time when the API key expires, in Unix timestamp format, measured in milliseconds. For permanent API keys, this property value is null.

Example:

1701396866000

​
role_scopes
object[]

The list of user roles and wallet scopes associated with the API key.