DELETE
/prime/webui/agents/agentless/connectiondetails
API Documentation · Agents
Agents
Endpoints for managing CybrIQ agents, agentless connections, and worker pollers. 34 endpoints.
Endpoints in this group
- DELETE DELETE /prime/webui/agents/agentless/connectiondetails
- DELETE Delete worker poller
- GET Export agents
- GET Get agent
- GET Get Agents
- GET Get agents classification summary
- GET Get agents with logs
- GET Get agents worker status
- GET Get policy test
- GET Get total errors
- GET Get uncommon peripherals
- GET Get unique white list violation
- GET Get vulnerable peripherals
- GET Get worker poller
- GET Reload uncommon peripherals
- GET Reload vulnerable peripherals
- POST Add agentless connection details
- POST Agentless registration
- POST Agentless unregistration
- POST Configure agents settings (set to armed or free and approve all)
- POST Delete agents
- POST Delete agents commands
- POST Export agent csv
- POST Export agent pdf
- POST Export agentless pdf connections
- POST Export agentless pdf connections
- POST Export agents worker status
- POST Export aggregated peripherals csv
- POST Export aggregated peripherals pdf
- POST Fetch agents debug logs
- POST Update agents
- POST Upload agentless connection details file
- PUT Activate worker poller
- PUT Update agentless connection details
DELETE
/prime/webui/agents/agentless/workerpollerdetails
Delete worker poller
Delete worker poller. Use this to delete data.
GET
/prime/webui/agents/AgentExportFile
Export agents
Export agents. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/agents/AgentExportFile' \
GET
/prime/webui/agents/agent/{agentId}
Get agent
Get agent. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/agents/agent/{agentId}' \
-H 'Authorization: Bearer <token>'OpenAPI spec
"get": {
"tags": [
"Agents"
],
"summary": "Get agent",
"parameters": [
{
"name": "agentId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/agents
Get Agents
Get Agents. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/agents' \
-H 'Authorization: Bearer <token>'OpenAPI spec
"get": {
"tags": [
"Agents"
],
"summary": "Get Agents",
"parameters": [
{
"name": "Uuid",
"in": "query",
20
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "HostIdentifier",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "IpAddress",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "Status",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "ContainsVulnerablePeripheralOrWLV",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "LastConfiguration",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "Version",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "License",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "OsVersion",
"in": "query",
"schema": {
"type": "string",
21
"nullable": true
}
},
{
"name": "LastUpdated",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "Hashtags",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "ExpirationDate",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "Severity",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "HasUnapprovedPeripherals",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "HasVulnerablePeripherals",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "HasKnownAttackTools",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "DeploymentMode",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
22
},
{
"name": "SortBy",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "PageNumber",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageSize",
"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/AgentsViewDataWrapper"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentsViewDataWrapper"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AgentsViewDataWrapper"
}
}
}
}
}
}
GET
/prime/webui/agents/AgentsClassificationSummary
Get agents classification summary
Get agents classification summary. Use this to fetch data.
GET
/prime/webui/agents/getloggedagents
Get agents with logs
Get agents with logs. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/agents/getloggedagents' \
-H 'Authorization: Bearer <token>'OpenAPI spec
"get": {
"tags": [
"Agents"
],
"summary": "Get agents with logs",
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/agents/agentless/connectiondetailsstatus
Get agents worker status
Get agents worker status. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/agents/agentless/connectiondetailsstatus' \
-H 'Authorization: Bearer <token>'OpenAPI spec
"get": {
"tags": [
"Agents"
],
"summary": "Get agents worker status",
"parameters": [
{
"name": "ComputerName",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "StatusString",
"in": "query",
"schema": {
"type": "string",
24
"nullable": true
}
},
{
"name": "StatusDescription",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "StatusErrorDescription",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "PrevRunningErrors",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "StartTime",
"in": "query",
"schema": {
"type": "string",
"format": "date -time",
"nullable": true
}
},
{
"name": "FromTimeStart",
"in": "query",
"schema": {
"type": "string",
"format": "date -time",
"nullable": true
}
},
{
"name": "ToTimeStart",
"in": "query",
"schema": {
"type": "string",
"format": "date -time",
"nullable": true
}
},
{
"name": "EndTime",
"in": "query",
"schema": {
"type": "string",
"format": "date -time",
"nullable": true
}
},
{
"name": "FromTimeEnd",
"in": "query",
25
"schema": {
"type": "string",
"format": "date -time",
"nullable": true
}
},
{
"name": "ToTimeEnd",
"in": "query",
"schema": {
"type": "string",
"format": "date -time",
"nullable": true
}
},
{
"name": "IsOverrideDefaults",
"in": "query",
"schema": {
"type": "boolean",
"nullable": true
}
},
{
"name": "SortBy",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "PageNumber",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageSize",
"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/AgentslessRsStatusGetResponse"
}
},
"application/json": {
26
"schema": {
"$ref": "#/components/schemas/AgentslessRsStatusGetResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AgentslessRsStatusGetResponse"
}
}
}
}
}
}
GET
/prime/webui/agents/getPolicyTest
Get policy test
Get policy test. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/agents/getPolicyTest' \
-H 'Authorization: Bearer <token>'OpenAPI spec
"get": {
"tags": [
"Agents"
],
"summary": "Get policy test",
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/agents/errorTotal
Get total errors
Get total errors. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/agents/errorTotal' \
-H 'Authorization: Bearer <token>'OpenAPI spec
"get": {
"tags": [
"Agents"
],
"summary": "Get total errors",
"parameters": [
{
"name": "FromDate",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "ToDate",
"in": "query",
"schema": {
"type": "string",
"nullable": true
27
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AgentsErrorDataWrapper"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentsErrorDataWrapper"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AgentsErrorDataWrapper"
}
}
}
}
}
}
GET
/prime/webui/agents/RiskInsights/UncommonPeripherals
Get uncommon peripherals
Get uncommon peripherals. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/agents/RiskInsights/UncommonPeripherals' \
-H 'Authorization: Bearer <token>'OpenAPI spec
"get": {
"tags": [
"Agents"
],
"summary": "Get uncommon peripherals",
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/agents/UniqueWhitelistViolation
Get unique white list violation
Get unique white list violation. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/agents/UniqueWhitelistViolation' \
-H 'Authorization: Bearer <token>'OpenAPI spec
"get": {
"tags": [
"Agents"
],
"summary": "Get unique white list violation",
"responses": {
"200": {
28
"description": "Success"
}
}
}
GET
/prime/webui/agents/RiskInsights/VulnerablePeripherals
Get vulnerable peripherals
Get vulnerable peripherals. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/agents/RiskInsights/VulnerablePeripherals' \
-H 'Authorization: Bearer <token>'OpenAPI spec
"get": {
"tags": [
"Agents"
],
"summary": "Get vulnerable peripherals",
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/agents/agentless/workerpollerdetails
Get worker poller
Get worker poller. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/agents/agentless/workerpollerdetails' \
-H 'Authorization: Bearer <token>'OpenAPI spec
"get": {
"tags": [
"Agents"
],
"summary": "Get worker poller",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/WorkerPollerDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkerPollerDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/WorkerPollerDetails"
}
}
}
}
}
}
GET
/prime/webui/agents/RiskInsights/UncommonPeripherals/Reload
Reload uncommon peripherals
Reload uncommon peripherals. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/agents/RiskInsights/UncommonPeripherals/Reload' \
-H 'Authorization: Bearer <token>'OpenAPI spec
"get": {
"tags": [
"Agents"
],
"summary": "Reload uncommon peripherals",
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/agents/RiskInsights/VulnerablePeripherals/Reload
Reload vulnerable peripherals
Reload vulnerable peripherals. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/agents/RiskInsights/VulnerablePeripherals/Reload' \
-H 'Authorization: Bearer <token>'OpenAPI spec
"get": {
"tags": [
"Agents"
],
"summary": "Reload vulnerable peripherals",
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/agents/agentless/connectiondetails
Add agentless connection details
Add agentless connection details. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/agents/agentless/connectiondetails' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/AgentlessRsConnectionDetailsPostRequest"}'OpenAPI spec
"post": {
"tags": [
"Agents"
],
"summary": "Add agentless connection details",
"requestBody": {
"content": {
"application/json -patch+json": {
30
"schema": {
"$ref": "#/components/schemas/AgentlessRsConnectionDetailsPostRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentlessRsConnectionDetailsPostRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AgentlessRsConnectionDetailsPostRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AgentlessRsConnectionDetailsPostRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
},
POST
/prime/webui/agents/agentless/registration
Agentless registration
Agentless registration. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/agents/agentless/registration' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/AgentlessRsConnectionDetailsRegistrationPostRequest"}'OpenAPI spec
"post": {
"tags": [
"Agents"
],
"summary": "Agentless registration",
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"$ref":
"#/components/schemas/AgentlessRsConnectionDetailsRegistrationPostRequest"
}
},
"application/json": {
"schema": {
"$ref":
"#/components/schemas/AgentlessRsConnectionDetailsRegistrationPostRequest"
}
},
"text/json": {
"schema": {
"$ref":
"#/components/schemas/AgentlessRsConnectionDetailsRegistrationPostRequest"
}
},
"application/*+json": {
31
"schema": {
"$ref":
"#/components/schemas/AgentlessRsConnectionDetailsRegistrationPostRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/agents/agentless/unregistration
Agentless unregistration
Agentless unregistration. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/agents/agentless/unregistration' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/AgentlessRsConnectionDetailsRegistrationPostRequest"}'OpenAPI spec
"post": {
"tags": [
"Agents"
],
"summary": "Agentless unregistration",
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"$ref":
"#/components/schemas/AgentlessRsConnectionDetailsRegistrationPostRequest"
}
},
"application/json": {
"schema": {
"$ref":
"#/components/schemas/AgentlessRsConnectionDetailsRegistrationPostRequest"
}
},
"text/json": {
"schema": {
"$ref":
"#/components/schemas/AgentlessRsConnectionDetailsRegistrationPostRequest"
}
},
"application/*+json": {
"schema": {
"$ref":
"#/components/schemas/AgentlessRsConnectionDetailsRegistrationPostRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/agents/configuration
Configure agents settings (set to armed or free and approve all)
Configure agents settings (set to armed or free and approve all). Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/agents/configuration' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'OpenAPI spec
"post": {
"tags": [
"Agents"
],
"summary": "Configure agents settings (set to armed or free and approve all)",
"requestBody": {
"description": "List of agents configurations to be done",
"content": {
"application/json -patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentPendingConfigurationWrapper"
},
"description": "List of agents configurations to be done",
"nullable": true
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentPendingConfigurationWrapper"
},
"description": "List of agents configurations to be done",
"nullable": true
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentPendingConfigurationWrapper"
},
"description": "List of agents configurations to be done",
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentPendingConfigurationWrapper"
},
"description": "List of agents configurations to be done",
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
33
}
}
}
POST
/prime/webui/agents/deleteAgents
Delete agents
Delete agents. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/agents/deleteAgents' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'OpenAPI spec
"post": {
"tags": [
"Agents"
],
"summary": "Delete agents",
"requestBody": {
"description": "List of agents Uuids to be deleted",
"content": {
"application/json -patch+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of agents Uuids to be deleted",
"nullable": true
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of agents Uuids to be deleted",
"nullable": true
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of agents Uuids to be deleted",
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of agents Uuids to be deleted",
"nullable": true
}
}
}
},
34
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/agents/deleteAgentsCommands
Delete agents commands
Delete agents commands. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/agents/deleteAgentsCommands' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'OpenAPI spec
"post": {
"tags": [
"Agents"
],
"summary": "Delete agents commands",
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
}
}
},
"responses": {
"200": {
35
"description": "Success"
}
}
}
POST
/prime/webui/agents/exportagentcsv
Export agent csv
Export agent csv. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/agents/exportagentcsv' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'OpenAPI spec
"post": {
"tags": [
"Agents"
],
"summary": "Export agent csv",
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"type": "object",
"nullable": true
}
},
"application/json": {
"schema": {
"type": "object",
"nullable": true
}
},
"text/json": {
"schema": {
"type": "object",
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "object",
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/agents/exportagentpdf/exportpdf
Export agent pdf
Export agent pdf. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/agents/exportagentpdf/exportpdf' \
POST
/prime/webui/agents/agentless/exportagentlesspdf
Export agentless pdf connections
Export agentless pdf connections. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/agents/agentless/exportagentlesspdf' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'OpenAPI spec
"post": {
"tags": [
"Agents"
],
"summary": "Export agentless pdf connections",
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"type": "object",
37
"nullable": true
}
},
"application/json": {
"schema": {
"type": "object",
"nullable": true
}
},
"text/json": {
"schema": {
"type": "object",
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "object",
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/agents/agentless/exportagentlesscsv
Export agentless pdf connections
Export agentless pdf connections. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/agents/agentless/exportagentlesscsv' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'OpenAPI spec
"post": {
"tags": [
"Agents"
],
"summary": "Export agentless pdf connections",
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"type": "object",
"nullable": true
}
},
"application/json": {
"schema": {
"type": "object",
"nullable": true
}
},
"text/json": {
"schema": {
"type": "object",
"nullable": true
}
38
},
"application/*+json": {
"schema": {
"type": "object",
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/agents/agentless/exportcsvconnections
Export agents worker status
Export agents worker status. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/agents/agentless/exportcsvconnections' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'OpenAPI spec
"post": {
"tags": [
"Agents"
],
"summary": "Export agents worker status",
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"type": "object",
"nullable": true
}
},
"application/json": {
"schema": {
"type": "object",
"nullable": true
}
},
"text/json": {
"schema": {
"type": "object",
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "object",
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
39
}
POST
/prime/webui/agents/peripheralsAggExport
Export aggregated peripherals csv
Export aggregated peripherals csv. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/agents/peripheralsAggExport' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'OpenAPI spec
"post": {
"tags": [
"Agents"
],
"summary": "Export aggregated peripherals csv",
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"type": "object",
"nullable": true
}
},
"application/json": {
"schema": {
"type": "object",
"nullable": true
}
},
"text/json": {
"schema": {
"type": "object",
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "object",
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/agents/peripheralsAggExportpdf/exportpdf
Export aggregated peripherals pdf
Export aggregated peripherals pdf. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/agents/peripheralsAggExportpdf/exportpdf' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
POST
/prime/webui/agents/fetchagentsdebuglogs
Fetch agents debug logs
Fetch agents debug logs. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/agents/fetchagentsdebuglogs' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'OpenAPI spec
"post": {
"tags": [
"Agents"
],
"summary": "Fetch agents debug logs",
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
41
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/agents/updateAgents
Update agents
Update agents. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/agents/updateAgents' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'OpenAPI spec
"post": {
"tags": [
"Agents"
],
"summary": "Update agents",
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
42
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/agents/agentless/uploadconnectiondetailsfile
Upload agentless connection details file
Upload agentless connection details file. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/agents/agentless/uploadconnectiondetailsfile' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'OpenAPI spec
"post": {
"tags": [
"Agents"
],
"summary": "Upload agentless connection details file",
"requestBody": {
"content": {
"multipart/form -data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"nullable": true
}
}
},
43
"encoding": {
"file": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
PUT
/prime/webui/agents/agentless/workerpollerdetails/activatedstatus
Activate worker poller
Activate worker poller. Use this to update data.
curl example
curl -X PUT 'https://<host>/prime/webui/agents/agentless/workerpollerdetails/activatedstatus' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/WorkerAppActivatePollerPutRequest"}'OpenAPI spec
"put": {
"tags": [
"Agents"
],
"summary": "Activate worker poller",
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"$ref": "#/components/schemas/WorkerAppActivatePollerPutRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkerAppActivatePollerPutRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/WorkerAppActivatePollerPutRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/WorkerAppActivatePollerPutRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
PUT
/prime/webui/agents/agentless/connectiondetails
Update agentless connection details
Update agentless connection details. Use this to update data.
curl example
curl -X PUT 'https://<host>/prime/webui/agents/agentless/connectiondetails' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/AgentlessRsConnectionDetailsUpdateRequest"}'OpenAPI spec
"put": {
"tags": [
"Agents"
],
"summary": "Update agentless connection details",
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"$ref": "#/components/schemas/AgentlessRsConnectionDetailsUpdateRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentlessRsConnectionDetailsUpdateRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AgentlessRsConnectionDetailsUpdateRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AgentlessRsConnectionDetailsUpdateRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
},