1. Tutorials
  2. Managing M2X API Keys

Managing M2X API Keys

Learn how to manage M2X Master and Device API Keys.

Tutorial Outline

  1. Master API Keys

    What are Master API Keys and where are they managed?

    Master API Keys provide account wide authorization to manage devices, distributions & other API keys. Manage your Master API Keys from your M2X Account Settings.

  2. Primary Master API Key

    A Primary Master API Key is assigned to each new M2X account and is the first key listed in the Master Key list. This key cannot be edited or deleted, but it can be regenerated if the key has been compromised.

  3. Creating a Master API Key

    Additional Master API Keys can be created with varying levels of access.

    Master Key Options:

    • `Name` : a unique name for the key
    • `Permissions` : the type of HTTP requests authorized for the key
    • `Expiry Date` : (optional) date and time when the keys access will be revoked, specified in GMT
    • `Origin IPs` : (optional) a comma separated list of IP addresses that are permitted to utilize the key
  4. Device API Keys

    What are Device API Keys and where are they managed?

    Device API Keys provide limited access to the specific device to which they are associated. Manage your Device API Keys via the API Keys tab on the Device detail page.

  5. Primary Device Key

    A Primary Device Key is assigned to every newly created device. This key cannot be edited or deleted, but it can be regenerated if the key has been compromised.

  6. Creating a Device API Key

    Additional Device API Keys can be created with varying levels of access.

    Device Key Options:

    • `Name` : a unique name for the key
    • `Stream` : restrict which stream the key can access (or select β€œAll” to allow access to all streams on this device)
    • `Permissions` : the type of HTTP requests authorized for the key
    • `Expiry Date` : (optional) date and time when the keys access will be revoked, specified in GMT
    • `Origin IPs` : (optional) a comma separated list of IP addresses that are permitted to utilize the key