create wildfire api-key
Focus
Focus
Advanced WildFire Powered by Precision AI™

create wildfire api-key

Table of Contents

create wildfire api-key

Description

Generate API keys on a WildFire appliance that you will use on an external system to submit samples to the appliance, query reports, or retrieve samples and Packet Captures (PCAPS) from the appliance.

Syntax

create { 
wildfire { 
api-key { 
key <value>; 
name <value>; 
{ 
{ 
{ 

Options

+ key — Create an API key by manually entering a key value. The value must be 64 alpha characters (a-z) or numbers (0-9). If you do not specify the key option, the appliance generates a key automatically.
+ name — Optionally enter a name for the API key. An API key name is simply used to label the keys to make it easier to identify keys assigned for specific uses and has no impact on the functionality of the key.

Sample Output

The following output shows that the appliance has three API keys and one key is named my-api-key.
admin@WF-500> show
wildfire global api-keys all 
+-----------------------------------------------------+------------+ 
|                         Apikey                      |    Name    | 
+-----------------------------------------------------+------------+ 
|                        <API KEY>                    | my-api-key | 
|                        <API KEY>                    | my-api-key | 
|                        <API KEY>                    | my-api-key | 
+-----------------------------------------------------+------------+ 
+---------+---------------------+---------------------+ 
|  Status |     Create Time     |    Last Used Time   | 
+---------+---------------------+---------------------+ 
| Enabled | 2017-03-02 19:14:36 | 2017-03-02 19:14:36 | 
| Enabled | 2016-02-06 12:13:22 | 2017-03-01 12:10:20 | 
| Enabled | 2014-08-04 17:00:42 | 2017-03-01 11:12:52 | 
+---------+---------------------+---------------------+ 

Required Privilege Level

superuser, deviceadmin