---
title: "View source for Api Keys - DreamFactory Wiki"
source: "http://wiki.dreamfactory.com/index.php?action=edit&title=Api_Keys"
canonical_url: "http://wiki.dreamfactory.com/index.php?action=edit&title=Api_Keys"
converted_at: "2026-04-17T02:43:19.465Z"
format: "markdown"
converted_by: "html-to-md-ai"
---
[]()
	
	
	
	# View source for Api Keys

	
		
		← [Api Keys](/Api_Keys)
		
		
		
		[Jump to navigation](#mw-head)
		[Jump to search](#searchInput)
		You do not have permission to edit this page, for the following reason:

The action you have requested is limited to users in the group: [Users](/index.php?title=DreamFactory_Wiki:Users&action=edit&redlink=1).

---

You can view and copy the source of this page.

{{#seo:
|title=Api Keys - DreamFactory Documentation
|title_mode=replace
|canonical=https://wiki.dreamfactory.com/Api_Keys
|og:title=Api Keys
|og:type=article
|og:site_name=DreamFactory Documentation
}}
'''Create and configure API keys in DreamFactory to authenticate requests and control access to your APIs'''

<span id="api-keys"></span>
= API Keys =

<span id="creating-an-api-key"></span>
== Creating an API Key ==

Next let's create an API Key, on the left navbar select '''API Keys''':

[[File:api-key-navbar.png|thumb|Creating an App Key for your DreamFactory API]]

Click the purple + button to create a new key. You are presented with the following form:

[[File:api-key-overview.png|thumb|App Configuration Form]]

Let's walk through each field:

* '''Application Name''' and '''Description''': The application name and description are used purely for human consumption, so feel free to complete these as you see fit.
* '''Active''': This checkbox can be used to toggle availability of the API key, which is generated and presented to you when the application is saved.
* '''App Location''': This field presents four options for specifying the application's location. The majority of users choose <code>No Storage Required</code> because the API key will be used in conjunction with a mobile or web application, or via a server-side script.
* '''Assign a Default Role''': Use this field to assign the newly created role to your application. Click on the select box and choose the role.

Click '''Save''' button and the new API key is generated.

== See also ==
* [[Event_Scripts|Event Scripts]]
* [[Interacting_With_Api|Interacting With the API]]
* [[Advanced_Database_Api_Features|Advanced Database API Features]]
* [[Api_Creation_Management|API Creation and Management]]

[[Category:Api_Key]]
[[Category:Authentication]]
[[Category:App_Configuration]]
[[Category:API]]
[[Category:Difficulty_Beginner]]

[[Category:API]]
Return to [Api Keys](/Api_Keys).

Retrieved from "[https://wiki.dreamfactory.com/Api_Keys](https://wiki.dreamfactory.com/Api_Keys)"