Page tree


In This Document 



Have a suggestion for the Armor Knowledge Base? Send a message to kb@armor.com.




Overview

The Create an API key API creates an API key. 

You can use the Get Users API to find the user ID.


Sample request

POST https://api.armor.com/users/6/keys


{
  "name": "John's API Key",
  "userId": 6
}

Input

The following table describes the different parts of this API call: 

API Call / URLMethod / Type
/users/{id}/keysPOST

The following table describes the parameter (or parameters) for this API call: 

ParameterDescriptionRequired or optionalTypeExample
user id

The ID of the user

You can use the Get Users API to find the ID of your users.

RequiredInteger6
nameA descriptive name for the API keyRequiredStringJohn's API key



Sample return

StatusResponse
200
{
  "id": "6",
  "apiKey": "00000000-0000-0000-0000-000000000000",
  "name": "John's API key"
}