• Installs:
  • Today: 0
  • All Time: 0


This method add a new global API key.


Step 1: Login into your Algolia Dashboard (https://www.algolia.com/dashboard)
Step 2: Go to API Keys section (https://www.algolia.com/api-keys)
Step 3: Use your Application ID as appId and Admin API Key as apiKey

Test This Block

  • apiKey
    Body parameter
    Algolia Application Key.
  • appId
    Body parameter
    Algolia Application ID.

  • gear
    Required Parameters

      List of Strings. Contains the list of rights for this key. Here is the complete list of ACL that can be used for a key: `search`, `browse`, `addObject`, `deleteObject`, `deleteIndex`, `settings`, `editSettings`, `analytics`, `listIndexes`. See README for more info.
    Optional Parameters
    • validity
      Body parameter
      Specify a validity for this key in seconds (the key will automatically be removed after this period of time). Defaults to 0 (no validity limit).
    • maxHitsPerQuery
      Body parameter
      Specify the maximum number of hits this API key can retrieve in one call. Defaults to 0 (unlimited).
    • description
      Body parameter
      Used to identify a key.
    • maxQueriesPerIPPerHour
      Body parameter
      Specify the maximum number of API calls allowed from an IP address per hour.
    • queryParameters
      Body parameter
      Force some query parameters to be applied foreach query made with this api key. You can force all query parameters like: “typoTolerance=strict&ignorePlurals=false&filters=rights:public”. The parameters use the url string format.
    • indexes
      Restrict this new API key to specific index names. This option is useful if you want to isolate your development and production environments: you can have one API key targeting all development indices and another one that target all production indices. You can target all indices starting by a prefix or finishing by a suffix with the ‘*’ character (for example “dev_*” matches all indices starting by “dev_” and “*_dev” matches all indices finishing by “_dev”). If the list is empty or not set, the API Key will be valid for all indices.
      Restrict this new API key to specific referers. You can specify a pattern with one or two *. For example, “https://algolia.com/*” matches all referers starting with “https://algolia.com/” and “*algolia.com” matches all referers ending with “.algolia.com”. You can combine both of them to like “*.algolia.com*” to allow the domain algolia.com. Defaults to all referers if empty or blank
    Show Optional Parameters
    TEST Function
    CODE (NodeJS)

    Nice try, But you still have to Log in.
    Meanwhile, you can enjoy this limerick:

    "A programming genius called HEAP
    Had trouble in getting to sleep
    So he made his lambs troup
    through a huge FOR-NEXT loop
    FOR 1 TO 10000: NEXT sheep."

    Sign in to get the snippet
    Sign In
    $ / m
    We will charge your card every month for the plan amount, as well as any overages incurred in the previous month.

    Oops, we are missing some details

    Looks like there are a few missing details that you haven't filled in yet.
    These details are important and will help us protect you and let you know about anything new.


    Login to RapidAPI

    Create endpoints based on popular APIs and share with others.
    Follow popular APIs and get updated. Stand out in the community of developers.

    Login with Github
    Login with Facebook
    Login with Google
    Remember Me

  • We're not going to post anything on your wall.
  • We're not planning to spam you.
  • esccloses this view

    Why sign up to RapidAPI?

    • integrate
      Integrate APIs into your app
      Ruby, Java, Elixir, Node.js, Phyton, Objective C, Swift, PHP and MORE
    • keys
      Save all API keys in one place
    • notifications
      Get notifications about API changes
    • stats
      Get stats and monitor API connections
    Sign up with Github
    Sign up with Facebook
    Sign up with Google
  • We're not going to post anything on your wall.
  • We're not planning to spam you.
  • esccloses this view


    esccloses this view