UTILITIES > API > API keys > API keys

API keys

An API (Application Programming Interface) key is an alphanumeric string that allows an application to securely access a service or a resource on a computer system. It has two main purposes: to authenticate access and to monitor the usage of services by developers; it is used to limit access to services only to those who have the proper authorization, thus preventing abuse or unauthorized use.

An API key consists of two values:
  • API key
    can be publicly shared with developers using the API;
    it is used to authenticate access to the services offered by an API.
     
    Example API key cmp-024a830c-6d82-4797-bc47-f5fdd7ferox13
  • Secret API key
    should be kept confidential and should not be shared or made public;
    it provides more privileged and reserved access compared to a public API key.
     
    Example secret API key: HnR5xHaHJ64lX4lbxuyOVNjmSsgPFaB5

Key statuses

Status Status description Action
Active API key has been enabled Can be used, disabled or deleted.
Not active The API key has been disabled To be used, it must first be re-enabled, or can be deleted.