API Documentation · Peripherals

Peripherals

Peripheral-device endpoints, including export. 4 endpoints.

Endpoints in this group

GET Get Agents Peripherals
GET Get the peripherals of agent
POST Approve, Disapprove, Approve and Enable, Enable command
POST Delete peripherals commands

GET /prime/webui/peripherals

Get Agents Peripherals

Get Agents Peripherals. Use this to fetch data.

curl example

curl -X GET 'https://<host>/prime/webui/peripherals' \
-H 'Authorization: Bearer <token>'

OpenAPI spec

"get": {
             "tags": [
                "Peripherals"
             ],
             "summary": "Get Agents Peripherals",
             "parameters": [
                {
                  "name": "Device",



                                                                                                170

     "in": "query",
     "schema": {
       "type": "string",
       "nullable": true
     }
},
{
     "name": "HostUuid",
     "in": "query",
     "schema": {
       "type": "string",
       "nullable": true
     }
},
{
     "name": "HostIdentifier",
     "in": "query",
     "schema": {
       "type": "string",
       "nullable": true
     }
},
{
     "name": "Vid",
     "in": "query",
     "schema": {
       "type": "string",
       "nullable": true
     }
},
{
     "name": "Pid",
     "in": "query",
     "schema": {
       "type": "string",
       "nullable": true
     }
},
{
     "name": "Vendor",
     "in": "query",
     "schema": {
       "type": "string",
       "nullable": true
     }
},
{
     "name": "ProductInfo",
     "in": "query",
     "schema": {
       "type": "string",
       "nullable": true
     }
},
{
     "name": "Manufacturer",
     "in": "query",
     "schema": {
       "type": "string",
       "nullable": true
     }
},
{
     "name": "SerialNumber",
     "in": "query",
     "schema": {



                                 171

         "type": "string",
         "nullable": true
     }
},
{
     "name": "GUISerial",
     "in": "query",
     "schema": {
       "type": "string",
       "nullable": true
     }
},
{
     "name": "DevIcon",
     "in": "query",
     "schema": {
       "type": "string",
       "nullable": true
     }
},
{
     "name": "Vulnerability",
     "in": "query",
     "schema": {
       "type": "string",
       "nullable": true
     }
},
{
     "name": "Severity",
     "in": "query",
     "schema": {
       "type": "integer",
       "format": "int32",
       "nullable": true
     }
},
{
     "name": "Hashtags",
     "in": "query",
     "schema": {
       "type": "string",
       "nullable": true
     }
},
{
     "name": "IsUnapprovedPeripheral",
     "in": "query",
     "schema": {
       "type": "boolean",
       "nullable": true
     }
},
{
     "name": "IsVulnerablePeripheral",
     "in": "query",
     "schema": {
       "type": "boolean",
       "nullable": true
     }
},
{
     "name": "IsKnownAttackTool",
     "in": "query",
     "schema": {
       "type": "boolean",



                                         172

           "nullable": true
       }
  },
  {
       "name": "FlappingStartTime",
       "in": "query",
       "schema": {
         "type": "string",
         "format": "date -time",
         "nullable": true
       }
  },
  {
       "name": "SortBy",
       "in": "query",
       "schema": {
         "type": "string",
         "nullable": true
       }
  },
  {
       "name": "PageSize",
       "in": "query",
       "schema": {
         "type": "integer",
         "format": "int32"
       }
  },
  {
       "name": "PageNumber",
       "in": "query",
       "schema": {
         "type": "integer",
         "format": "int32"
       }
  },
  {
       "name": "GlobalSearch",
       "in": "query",
       "schema": {
         "type": "string",
         "nullable": true
       }
   }
],
"responses": {
   "200": {
     "description": "Success",
     "content": {
       "text/plain": {
          "schema": {
            "$ref": "#/components/schemas/PeripheralViewDataWrapper"
          }
       },
       "application/json": {
          "schema": {
            "$ref": "#/components/schemas/PeripheralViewDataWrapper"
          }
       },
       "text/json": {
          "schema": {
            "$ref": "#/components/schemas/PeripheralViewDataWrapper"
          }
       }
     }
   }



                                                                       173

               }
           }

GET /prime/webui/peripherals/{uuid}

Get the peripherals of agent

Get the peripherals of agent. Use this to fetch data.

curl example

curl -X GET 'https://<host>/prime/webui/peripherals/{uuid}' \
-H 'Authorization: Bearer <token>'

OpenAPI spec

"get": {
             "tags": [
                "Peripherals"
             ],
             "summary": "Get the peripherals of agent",
             "parameters": [
                {
                   "name": "uuid",
                   "in": "path",
                   "description": "Agent ID",
                   "required": true,
                   "schema": {
                     "type": "string",
                     "description": "Agent ID",
                     "nullable": true
                   }
                },
                {
                   "name": "Device",
                   "in": "query",
                   "schema": {
                     "type": "string",
                     "nullable": true
                   }
                },
                {
                   "name": "HostUuid",
                   "in": "query",
                   "schema": {
                     "type": "string",
                     "nullable": true
                   }
                },
                {
                   "name": "HostIdentifier",
                   "in": "query",
                   "schema": {
                     "type": "string",
                     "nullable": true
                   }
                },
                {
                   "name": "Vid",
                   "in": "query",
                   "schema": {
                     "type": "string",
                     "nullable": true
                   }
                },
                {
                   "name": "Pid",
                   "in": "query",
                   "schema": {


                                                                        174

         "type": "string",
         "nullable": true
     }
},
{
     "name": "Vendor",
     "in": "query",
     "schema": {
       "type": "string",
       "nullable": true
     }
},
{
     "name": "ProductInfo",
     "in": "query",
     "schema": {
       "type": "string",
       "nullable": true
     }
},
{
     "name": "Manufacturer",
     "in": "query",
     "schema": {
       "type": "string",
       "nullable": true
     }
},
{
     "name": "SerialNumber",
     "in": "query",
     "schema": {
       "type": "string",
       "nullable": true
     }
},
{
     "name": "GUISerial",
     "in": "query",
     "schema": {
       "type": "string",
       "nullable": true
     }
},
{
     "name": "DevIcon",
     "in": "query",
     "schema": {
       "type": "string",
       "nullable": true
     }
},
{
     "name": "Vulnerability",
     "in": "query",
     "schema": {
       "type": "string",
       "nullable": true
     }
},
{
     "name": "Severity",
     "in": "query",
     "schema": {
       "type": "integer",
       "format": "int32",



                                175

         "nullable": true
     }
},
{
     "name": "Hashtags",
     "in": "query",
     "schema": {
       "type": "string",
       "nullable": true
     }
},
{
     "name": "IsUnapprovedPeripheral",
     "in": "query",
     "schema": {
       "type": "boolean",
       "nullable": true
     }
},
{
     "name": "IsVulnerablePeripheral",
     "in": "query",
     "schema": {
       "type": "boolean",
       "nullable": true
     }
},
{
     "name": "IsKnownAttackTool",
     "in": "query",
     "schema": {
       "type": "boolean",
       "nullable": true
     }
},
{
     "name": "FlappingStartTime",
     "in": "query",
     "schema": {
       "type": "string",
       "format": "date -time",
       "nullable": true
     }
},
{
     "name": "SortBy",
     "in": "query",
     "schema": {
       "type": "string",
       "nullable": true
     }
},
{
     "name": "PageSize",
     "in": "query",
     "schema": {
       "type": "integer",
       "format": "int32"
     }
},
{
     "name": "PageNumber",
     "in": "query",
     "schema": {
       "type": "integer",
       "format": "int32"



                                         176

                    }
               },
               {
                    "name": "GlobalSearch",
                    "in": "query",
                    "schema": {
                      "type": "string",
                      "nullable": true
                    }
                }
             ],
             "responses": {
                "200": {
                  "description": "Success",
                  "content": {
                    "text/plain": {
                       "schema": {
                         "$ref": "#/components/schemas/PeripheralViewDataWrapper"
                       }
                    },
                    "application/json": {
                       "schema": {
                         "$ref": "#/components/schemas/PeripheralViewDataWrapper"
                       }
                    },
                    "text/json": {
                       "schema": {
                         "$ref": "#/components/schemas/PeripheralViewDataWrapper"
                       }
                    }
                  }
                }
             }
         }

POST /prime/webui/peripherals/command

Approve, Disapprove, Approve and Enable, Enable command

Approve, Disapprove, Approve and Enable, Enable command. Use this to create data.

curl example

curl -X POST 'https://<host>/prime/webui/peripherals/command' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/PeripheralCommandsViewResource"}'

OpenAPI spec

"post": {
           "tags": [
              "Peripherals"
           ],
           "summary": "Approve, Disapprove, Approve and Enable, Enable command",
           "requestBody": {
              "description": "",
              "content": {
                "application/json -patch+json": {
                   "schema": {
                     "$ref": "#/components/schemas/PeripheralCommandsViewResource"
                   }
                },
                "application/json": {
                   "schema": {
                     "$ref": "#/components/schemas/PeripheralCommandsViewResource"
                   }
                },
                "text/json": {


                                                                                           177

                    "schema": {
                      "$ref": "#/components/schemas/PeripheralCommandsViewResource"
                    }
                  },
                  "application/*+json": {
                     "schema": {
                       "$ref": "#/components/schemas/PeripheralCommandsViewResource"
                     }
                  }
                 }
              },
              "responses": {
                 "200": {
                   "description": "Success"
                 }
              }
          }

POST /prime/webui/peripherals/deleteCommands

Delete peripherals commands

Delete peripherals commands. Use this to create data.

curl example

curl -X POST 'https://<host>/prime/webui/peripherals/deleteCommands' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'

OpenAPI spec

"post": {
            "tags": [
               "Peripherals"
            ],
            "summary": "Delete peripherals commands",
            "requestBody": {
               "content": {
                 "application/json -patch+json": {
                    "schema": {
                      "type": "array",
                      "items": {
                         "$ref": "#/components/schemas/PeripheralIdData"
                      },
                      "nullable": true
                    }
                 },
                 "application/json": {
                    "schema": {
                      "type": "array",
                      "items": {
                         "$ref": "#/components/schemas/PeripheralIdData"
                      },
                      "nullable": true
                    }
                 },
                 "text/json": {
                    "schema": {
                      "type": "array",
                      "items": {
                         "$ref": "#/components/schemas/PeripheralIdData"
                      },
                      "nullable": true
                    }
                 },
                 "application/*+json": {
                    "schema": {


                                                                                       178

                          "type": "array",
                          "items": {
                             "$ref": "#/components/schemas/PeripheralIdData"
                          },
                          "nullable": true
                      }
                  }
                 }
              },
              "responses": {
                 "200": {
                   "description": "Success"
                 }
              }
          }