Page tree


Knowledge Base


Feedback

Have a suggestion for the Armor Knowledge Base?

Send a message to
kb@armor.com.









This API call applies to both Armor Complete and Armor Anywhere users.

The Create Notes API adds notes to a specified entityType and entityId.  

You can use the GET https://api.armor.com/apps API to find the entityID.

Sample Request

POST https://api.armor.com/apps/8508/notes

{
 "messages": "This is a note"
}

Input


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

API Call / URLMethod / Type
{entityType}/{entityId}/notesPUT


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

ParameterDescriptionFormatRequired or optionalExample
entityType

The type of the entity

(You must enter apps.)

StringRequirednotes
entityIdThe ID of the entityIntegerRequired8508
messagesA descriptive messageStringRequiredThis is a note

Sample Return

StatusResponse
200
true
400
Bad Request