DELETE
/prime/webui/agents/agentless/connectiondetails
→ in agents
DELETE /prime/webui/agents/agentless/connectiondetails
DELETE
/prime/webui/agents/agentless/workerpollerdetails
→ in agents
Delete worker poller
Delete worker poller. Use this to delete data.
GET
/prime/webui/agents/AgentExportFile
→ in agents
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}
→ in agents
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 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
→ in agents
Get agents classification summary
Get agents classification summary. Use this to fetch data.
GET
/prime/webui/agents/getloggedagents
→ in agents
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
→ in agents
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
→ in agents
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
→ in agents
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
→ in agents
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
→ in agents
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
→ in agents
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
→ in agents
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
→ in agents
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
→ in agents
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
→ in agents
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
→ in agents
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
→ in agents
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
→ in agents
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
→ in agents
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
→ in agents
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
→ in agents
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
→ in agents
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
→ in agents
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
→ in agents
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
→ in agents
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
→ in agents
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
→ in agents
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
→ in agents
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
→ in agents
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
→ in agents
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
→ in agents
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
→ in agents
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"
}
}
},
GET
/prime/webui/Switches/CheckPassword
→ in netapi
Check password
Check password. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/CheckPassword' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
"summary": "Check password",
"parameters": [
{
"name": "id",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/Switches/InfrastructureIDs
→ in netapi
Get all Infrastructure IDs
Get all Infrastructure IDs. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/InfrastructureIDs' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
"summary": "Get all Infrastructure IDs",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
100
"type": "string"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
GET
/prime/webui/Switches/Switches
→ in netapi
Get all Switches
Get all Switches. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/Switches' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
"summary": "Get all Switches",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SwitchDataViewResource"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SwitchDataViewResource"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SwitchDataViewResource"
}
}
}
}
}
}
}
GET
/prime/webui/Switches/getinfradata
→ in netapi
Get Infrastructure Data
Get Infrastructure Data. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/getinfradata' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
"summary": "Get Infrastructure Data",
"parameters": [
{
"name": "InfraViewQuery",
"in": "query",
"description": "Dictionary of key value for search, the supported keys are
ipAddressIDTooltip, \r\n ID, ipAddress, assignedName, ios, model, statusDescription,
hashtags, lastUpdatedDisplayString, protocol, \r\n pollingGroupN ame, groupName,
pageSize, pageNumber, sortBy \r\n For example if you want to get switch with \r\n
infrastructureName Floor1 and ipAddressIDTooltip 192.168.10.172 you need to send in the
query Ports?assignedName=Floor1&ipAddressIDTooltip =192.168.10.172.",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Dictionary of key value for search, the supported keys are
ipAddressIDTooltip, \r\n ID, ipAddress, assignedName, ios, model, statusDescription,
hashtags, lastUpdatedDisplayString, protocol, \r\n pollingGrou pName, groupName,
pageSize, pageNumber, sortBy \r\n For example if you want to get switch with \r\n
infrastructureName Floor1 and ipAddressIDTooltip 192.168.10.172 you need to send in the
query Ports?assignedName=Floor1&ipAddressIDToolt ip=192.168.10.172.",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/NetworkInfraDataViewResourceTableWrapper"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NetworkInfraDataViewResourceTableWrapper"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/NetworkInfraDataViewResourceTableWrapper"
}
}
}
}
}
}
GET
/prime/webui/Switches/SwitchesConnection/{switchConnectionaId}
→ in netapi
GET /prime/webui/Switches/SwitchesConnection/{switchConnectionaId}
GET
/prime/webui/Switches/getswitches
→ in netapi
Get Switches
Get Switches. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/getswitches' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
"summary": "Get Switches",
"parameters": [
{
"name": "switchesViewQuery",
"in": "query",
"description": "Dictionary of key value for search, the supported keys are
ipAddressSwitchIDTooltip, \r\n switchID, ipAddress, assignedName, ios, model,
statusDescription, hashtags, lastUpdatedDisplayString, protocol, \r\n
pollingGroupName, groupName, pageSize, pageNumber, sortBy \r\n For example if
you want to get switch with \r\n switchName Floor1 and ipAddressSwitchIDTooltip
192.168.10.172 you need to send in the query
Ports?assignedName=Floor1&ipAddres sSwitchIDTooltip=192.168.10.172.",
"schema": {
"type": "object",
"additionalProperties": {
103
"type": "string"
},
"description": "Dictionary of key value for search, the supported keys are
ipAddressSwitchIDTooltip, \r\n switchID, ipAddress, assignedName, ios, model,
statusDescription, hashtags, lastUpdatedDisplayString, protocol, \r\n
pollingGroupName, groupName, pageSize, pageNumber, sortBy \r\n For example if
you want to get switch with \r\n switchName Floor1 and ipAddressSwitchIDTooltip
192.168.10.172 you need to send in the query
Ports?assignedName=Floor1&ipAddr essSwitchIDTooltip=192.168.10.172.",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/SwitchDataViewResourceTableWrapper"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SwitchDataViewResourceTableWrapper"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SwitchDataViewResourceTableWrapper"
}
}
}
}
}
}
GET
/prime/webui/Switches/SwitchesConnection
→ in netapi
Get switches connections
Get switches connections. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/SwitchesConnection' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
"summary": "Get switches connections",
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/Switches/healthcheck
→ in netapi
Healthcheck
Healthcheck. Use this to fetch data.
GET
/prime/webui/Switches/apscontroller/{WlanControllerDataId}
→ in netapi
prime webui Switches apscontroller WlanControllerDataId
Calls GET /prime/webui/Switches/apscontroller/{WlanControllerDataId}. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/apscontroller/{WlanControllerDataId}' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
"parameters": [
{
"name": "WlanControllerDataId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/Switches/CmdPorts
→ in netapi
prime webui Switches CmdPorts
Calls GET /prime/webui/Switches/CmdPorts. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/CmdPorts' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
"responses": {
"200": {
"description": "Success"
}
105
}
}
GET
/prime/webui/Switches/domainscanload
→ in netapi
prime webui Switches domainscanload
Calls GET /prime/webui/Switches/domainscanload. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/domainscanload' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/Switches/ExportFile
→ in netapi
prime webui Switches ExportFile
Calls GET /prime/webui/Switches/ExportFile. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/ExportFile' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/Switches/ExportZeroMacPDF/exportpdf
→ in netapi
prime webui Switches ExportZeroMacPDF exportpdf
Calls GET /prime/webui/Switches/ExportZeroMacPDF/exportpdf. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/ExportZeroMacPDF/exportpdf' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
106
"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"
}
}
}
GET
/prime/webui/Switches/FingerPrints
→ in netapi
prime webui Switches FingerPrints
Calls GET /prime/webui/Switches/FingerPrints. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/FingerPrints' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/Switches/GetDomains
→ in netapi
prime webui Switches GetDomains
Calls GET /prime/webui/Switches/GetDomains. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/GetDomains' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
107
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/Switches/getloggednetpollers
→ in netapi
prime webui Switches getloggednetpollers
Calls GET /prime/webui/Switches/getloggednetpollers. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/getloggednetpollers' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/Switches/GetNetworkConfigItemsByPrefix/{prefixes}
→ in netapi
prime webui Switches GetNetworkConfigItemsByPrefix prefixes
Calls GET /prime/webui/Switches/GetNetworkConfigItemsByPrefix/{prefixes}. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/GetNetworkConfigItemsByPrefix/{prefixes}' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
"parameters": [
{
"name": "prefixes",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/Switches/GetScanEnginesDomains
→ in netapi
prime webui Switches GetScanEnginesDomains
GET
/prime/webui/Switches/GetWlanControllers
→ in netapi
prime webui Switches GetWlanControllers
Calls GET /prime/webui/Switches/GetWlanControllers. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/GetWlanControllers' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/Switches/MACAddressesWithoutSepioClassification
→ in netapi
prime webui Switches MACAddressesWithoutSepioClassification
Calls GET /prime/webui/Switches/MACAddressesWithoutSepioClassification. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/MACAddressesWithoutSepioClassification' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/Switches/MacPrefixPolicies
→ in netapi
prime webui Switches MacPrefixPolicies
Calls GET /prime/webui/Switches/MacPrefixPolicies. Use this to fetch data.
GET
/prime/webui/Switches/NetDebug
→ in netapi
prime webui Switches NetDebug
Calls GET /prime/webui/Switches/NetDebug. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/NetDebug' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/Switches/netpollers
→ in netapi
prime webui Switches netpollers
Calls GET /prime/webui/Switches/netpollers. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/netpollers' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/Switches/NetsClassificationSummary
→ in netapi
prime webui Switches NetsClassificationSummary
Calls GET /prime/webui/Switches/NetsClassificationSummary. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/NetsClassificationSummary' \
-H 'Authorization: Bearer <token>'
GET
/prime/webui/Switches/NetworkPolicies
→ in netapi
prime webui Switches NetworkPolicies
Calls GET /prime/webui/Switches/NetworkPolicies. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/NetworkPolicies' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
"responses": {
"200": {
"description": "Success"
}
}
},
GET
/prime/webui/Switches/PollingGroups
→ in netapi
prime webui Switches PollingGroups
Calls GET /prime/webui/Switches/PollingGroups. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/PollingGroups' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/Switches/PollingGroups/{pollingGroupId}
→ in netapi
prime webui Switches PollingGroups pollingGroupId
Calls GET /prime/webui/Switches/PollingGroups/{pollingGroupId}. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/PollingGroups/{pollingGroupId}' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
111
"NetApi"
],
"parameters": [
{
"name": "pollingGroupId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/Switches/Ports/FilterFields
→ in netapi
prime webui Switches Ports FilterFields
Calls GET /prime/webui/Switches/Ports/FilterFields. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/Ports/FilterFields' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
"parameters": [
{
"name": "portViewQuery",
"in": "query",
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/Switches/RiskInsights/PortAnomalies
→ in netapi
prime webui Switches RiskInsights PortAnomalies
Calls GET /prime/webui/Switches/RiskInsights/PortAnomalies. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/RiskInsights/PortAnomalies' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
112
"NetApi"
],
"parameters": [
{
"name": "switchDataId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "portDataId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/Switches/RiskInsights/VulnerableSwitch
→ in netapi
prime webui Switches RiskInsights VulnerableSwitch
Calls GET /prime/webui/Switches/RiskInsights/VulnerableSwitch. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/RiskInsights/VulnerableSwitch' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
"parameters": [
{
"name": "switchDataId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "portDataId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success"
113
}
}
}
GET
/prime/webui/Switches/scanpolicy
→ in netapi
prime webui Switches scanpolicy
Calls GET /prime/webui/Switches/scanpolicy. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/scanpolicy' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/Switches/Switches/{switchDataId}/{portDataId}
→ in netapi
prime webui Switches Switches switchDataId portDataId
Calls GET /prime/webui/Switches/Switches/{switchDataId}/{portDataId}. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/Switches/{switchDataId}/{portDataId}' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
"parameters": [
{
"name": "switchDataId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
},
{
"name": "portDataId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/Switches/Wlancontrollers/info/{WlanControllerDataId}
→ in netapi
prime webui Switches Wlancontrollers info WlanControllerDataId
Calls GET /prime/webui/Switches/Wlancontrollers/info/{WlanControllerDataId}. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/Wlancontrollers/info/{WlanControllerDataId}' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
"parameters": [
{
"name": "WlanControllerDataId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/Switches/Wlancontrollers/{WlanControllerDataId}
→ in netapi
prime webui Switches Wlancontrollers WlanControllerDataId
Calls GET /prime/webui/Switches/Wlancontrollers/{WlanControllerDataId}. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/Wlancontrollers/{WlanControllerDataId}' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
"parameters": [
{
"name": "WlanControllerDataId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/Switches/ZeroMacPorts
→ in netapi
prime webui Switches ZeroMacPorts
Calls GET /prime/webui/Switches/ZeroMacPorts. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/Switches/ZeroMacPorts' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"NetApi"
],
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/AddOrUpdatePollerNetPolicyVerification
→ in netapi
Add or update net policy verification
Add or update net policy verification. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/AddOrUpdatePollerNetPolicyVerification' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"summary": "Add or update net policy verification",
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"text/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
116
"application/*+json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/AddOrUpdateNetworkPolicyToPorts
→ in netapi
Add or update policy to ports
Add or update policy to ports. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/AddOrUpdateNetworkPolicyToPorts' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/NetworkPolicyActionDto"}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"summary": "Add or update policy to ports",
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"$ref": "#/components/schemas/NetworkPolicyActionDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NetworkPolicyActionDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/NetworkPolicyActionDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/NetworkPolicyActionDto"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/AddSwitch
→ in netapi
Add switch
Add switch. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/AddSwitch' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/SwitchConnectionViewResource"}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"summary": "Add switch",
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"$ref": "#/components/schemas/SwitchConnectionViewResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SwitchConnectionViewResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SwitchConnectionViewResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SwitchConnectionViewResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/AddSwitches
→ in netapi
Add switches
Add switches. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/AddSwitches' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"summary": "Add switches",
118
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SwitchConnectionViewResource"
},
"nullable": true
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SwitchConnectionViewResource"
},
"nullable": true
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SwitchConnectionViewResource"
},
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SwitchConnectionViewResource"
},
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/CancelRemoveAlarmPort
→ in netapi
Cancel Remove Alarm state and returns the port to a normal state
Cancel Remove Alarm state and returns the port to a normal state. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/CancelRemoveAlarmPort' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/ZeroizePortViewResource"}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"summary": "Cancel Remove Alarm state and returns the port to a normal state",
"requestBody": {
"description": "",
119
"content": {
"application/json -patch+json": {
"schema": {
"$ref": "#/components/schemas/ZeroizePortViewResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ZeroizePortViewResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ZeroizePortViewResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ZeroizePortViewResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/CancelRemoveAlarmSwitch
→ in netapi
Cancel Remove Alarm state and returns the switch to a normal state
Cancel Remove Alarm state and returns the switch to a normal state. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/CancelRemoveAlarmSwitch' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"summary": "Cancel Remove Alarm state and returns the switch to a normal state",
"requestBody": {
"description": "",
"content": {
"application/json -patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ZeroizePortViewResource"
},
"description": "",
"nullable": true
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ZeroizePortViewResource"
},
120
"description": "",
"nullable": true
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ZeroizePortViewResource"
},
"description": "",
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ZeroizePortViewResource"
},
"description": "",
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/CancelAcceptAlarmPort
→ in netapi
Cancel the AcceptAlarm state and returns the port to a normal state.
Cancel the AcceptAlarm state and returns the port to a normal state. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/CancelAcceptAlarmPort' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/AcknowledgePortViewResource"}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"summary": "Cancel the AcceptAlarm state and returns the port to a normal state.",
"requestBody": {
"description": "",
"content": {
"application/json -patch+json": {
"schema": {
"$ref": "#/components/schemas/AcknowledgePortViewResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcknowledgePortViewResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AcknowledgePortViewResource"
121
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AcknowledgePortViewResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/CancelAcceptAlarmSwitch
→ in netapi
Cancel the AcceptAlarm state and returns the switch to a normal state
Cancel the AcceptAlarm state and returns the switch to a normal state. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/CancelAcceptAlarmSwitch' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"summary": "Cancel the AcceptAlarm state and returns the switch to a normal state",
"requestBody": {
"description": "",
"content": {
"application/json -patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AcknowledgePortViewResource"
},
"description": "",
"nullable": true
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AcknowledgePortViewResource"
},
"description": "",
"nullable": true
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AcknowledgePortViewResource"
},
"description": "",
"nullable": true
}
},
122
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AcknowledgePortViewResource"
},
"description": "",
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/CancelDontAlarmSwitch
→ in netapi
Cancel the Don't Alarm state and returns the switch to a normal state
Cancel the Don't Alarm state and returns the switch to a normal state. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/CancelDontAlarmSwitch' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"summary": "Cancel the Don't Alarm state and returns the switch to a normal state",
"requestBody": {
"description": "",
"content": {
"application/json -patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuditProofPortView"
},
"description": "",
"nullable": true
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuditProofPortView"
},
"description": "",
"nullable": true
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuditProofPortView"
},
"description": "",
123
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuditProofPortView"
},
"description": "",
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/CancelDontAlarmPort
→ in netapi
Cancel the Don't Alarm state and returns to port to a normal state.
Cancel the Don't Alarm state and returns to port to a normal state. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/CancelDontAlarmPort' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/AuditProofPortView"}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"summary": "Cancel the Don't Alarm state and returns to port to a normal state.",
"requestBody": {
"description": "",
"content": {
"application/json -patch+json": {
"schema": {
"$ref": "#/components/schemas/AuditProofPortView"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuditProofPortView"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AuditProofPortView"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AuditProofPortView"
}
}
}
},
"responses": {
"200": {
124
"description": "Success"
}
}
}
POST
/prime/webui/Switches/DeleteNetworkPolicyFromPorts
→ in netapi
Delete policy from ports
Delete policy from ports. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/DeleteNetworkPolicyFromPorts' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"summary": "Delete policy from ports",
"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": {
"description": "Success"
}
125
}
}
POST
/prime/webui/Switches/disableport
→ in netapi
Disable Ports
Disable Ports. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/disableport' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/BlockPortViewResource"}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"summary": "Disable Ports",
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"$ref": "#/components/schemas/BlockPortViewResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlockPortViewResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/BlockPortViewResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/BlockPortViewResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/enableport
→ in netapi
Enable Ports
Enable Ports. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/enableport' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/BlockPortViewResource"}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
126
],
"summary": "Enable Ports",
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"$ref": "#/components/schemas/BlockPortViewResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/BlockPortViewResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/BlockPortViewResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/BlockPortViewResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/exportinfracsv
→ in netapi
Export infrastructure CSV
Export infrastructure CSV. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/exportinfracsv' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"summary": "Export infrastructure CSV",
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"type": "object",
"nullable": true
}
},
"application/json": {
"schema": {
"type": "object",
"nullable": true
}
},
"text/json": {
"schema": {
127
"type": "object",
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "object",
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/exportinfrapdf/exportpdf
→ in netapi
Export infrastructure PDF
Export infrastructure PDF. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/exportinfrapdf/exportpdf' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"summary": "Export infrastructure PDF",
"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": {
128
"description": "Success"
}
}
}
POST
/prime/webui/Switches/pollnowinfrastructure
→ in netapi
Poll Infrastructure Now
Poll Infrastructure Now. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/pollnowinfrastructure' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"summary": "Poll Infrastructure Now",
"requestBody": {
"description": "List of infrastructures ids to be polled",
"content": {
"application/json -patch+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of infrastructures ids to be polled",
"nullable": true
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of infrastructures ids to be polled",
"nullable": true
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of infrastructures ids to be polled",
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of infrastructures ids to be polled",
"nullable": true
}
}
}
129
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/PollNowSwitch
→ in netapi
Poll Switches Now
Poll Switches Now. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/PollNowSwitch' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"summary": "Poll Switches Now",
"requestBody": {
"description": "List of switches ids to be polled",
"content": {
"application/json -patch+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of switches ids to be polled",
"nullable": true
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of switches ids to be polled",
"nullable": true
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of switches ids to be polled",
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of switches ids to be polled",
"nullable": true
130
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/ActiveNetPollers
→ in netapi
prime webui Switches ActiveNetPollers
Calls POST /prime/webui/Switches/ActiveNetPollers. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/ActiveNetPollers' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"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
}
}
}
131
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/changepollerloglevel
→ in netapi
prime webui Switches changepollerloglevel
Calls POST /prime/webui/Switches/changepollerloglevel. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/changepollerloglevel' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/NetPollerConfigurationUpdate"}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"$ref": "#/components/schemas/NetPollerConfigurationUpdate"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NetPollerConfigurationUpdate"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/NetPollerConfigurationUpdate"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/NetPollerConfigurationUpdate"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/DeactivateNetpollers
→ in netapi
prime webui Switches DeactivateNetpollers
Calls POST /prime/webui/Switches/DeactivateNetpollers. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/DeactivateNetpollers' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
POST
/prime/webui/Switches/DeleteMacPrefixPolicy
→ in netapi
prime webui Switches DeleteMacPrefixPolicy
Calls POST /prime/webui/Switches/DeleteMacPrefixPolicy. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/DeleteMacPrefixPolicy' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
133
"tags": [
"NetApi"
],
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MacPrefixPolicyView"
},
"nullable": true
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MacPrefixPolicyView"
},
"nullable": true
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MacPrefixPolicyView"
},
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MacPrefixPolicyView"
},
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/DeleteNetworkPolicy
→ in netapi
prime webui Switches DeleteNetworkPolicy
Calls POST /prime/webui/Switches/DeleteNetworkPolicy. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/DeleteNetworkPolicy' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/NetworkPolicyView"}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
134
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"$ref": "#/components/schemas/NetworkPolicyView"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NetworkPolicyView"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/NetworkPolicyView"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/NetworkPolicyView"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/exportalarmedcsv
→ in netapi
prime webui Switches exportalarmedcsv
Calls POST /prime/webui/Switches/exportalarmedcsv. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/exportalarmedcsv' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"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
}
135
},
"application/*+json": {
"schema": {
"type": "object",
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/ExportAlarmedPDF/exportpdf
→ in netapi
prime webui Switches ExportAlarmedPDF exportpdf
Calls POST /prime/webui/Switches/ExportAlarmedPDF/exportpdf. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/ExportAlarmedPDF/exportpdf' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"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/Switches/exportportscsv
→ in netapi
prime webui Switches exportportscsv
Calls POST /prime/webui/Switches/exportportscsv. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/exportportscsv' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"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/Switches/exportportspdf/exportpdf
→ in netapi
prime webui Switches exportportspdf exportpdf
Calls POST /prime/webui/Switches/exportportspdf/exportpdf. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/exportportspdf/exportpdf' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
137
"NetApi"
],
"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/Switches/exportzeromaccsv
→ in netapi
prime webui Switches exportzeromaccsv
Calls POST /prime/webui/Switches/exportzeromaccsv. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/exportzeromaccsv' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"type": "object",
"nullable": true
}
},
"application/json": {
"schema": {
"type": "object",
"nullable": true
}
138
},
"text/json": {
"schema": {
"type": "object",
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "object",
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/fetchInfrastracturesdebuglogs
→ in netapi
prime webui Switches fetchInfrastracturesdebuglogs
Calls POST /prime/webui/Switches/fetchInfrastracturesdebuglogs. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/fetchInfrastracturesdebuglogs' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FetchSessionLogsRequest"
},
"nullable": true
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FetchSessionLogsRequest"
},
"nullable": true
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FetchSessionLogsRequest"
},
"nullable": true
}
139
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FetchSessionLogsRequest"
},
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/fetchnetpollersdebuglogs
→ in netapi
prime webui Switches fetchnetpollersdebuglogs
Calls POST /prime/webui/Switches/fetchnetpollersdebuglogs. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/fetchnetpollersdebuglogs' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"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": {
140
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/MacPrefixPolicies
→ in netapi
prime webui Switches MacPrefixPolicies
Calls POST /prime/webui/Switches/MacPrefixPolicies. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/MacPrefixPolicies' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/MacPrefixPolicyView"}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"$ref": "#/components/schemas/MacPrefixPolicyView"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/MacPrefixPolicyView"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/MacPrefixPolicyView"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/MacPrefixPolicyView"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/NetworkPolicies
→ in netapi
prime webui Switches NetworkPolicies
Calls POST /prime/webui/Switches/NetworkPolicies. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/NetworkPolicies' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/NetworkPolicyView"}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"$ref": "#/components/schemas/NetworkPolicyView"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/NetworkPolicyView"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/NetworkPolicyView"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/NetworkPolicyView"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/TestMerakiConnection
→ in netapi
prime webui Switches TestMerakiConnection
Calls POST /prime/webui/Switches/TestMerakiConnection. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/TestMerakiConnection' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
142
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"text/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/updateInfrastructurescanpolicy
→ in netapi
prime webui Switches updateInfrastructurescanpolicy
Calls POST /prime/webui/Switches/updateInfrastructurescanpolicy. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/updateInfrastructurescanpolicy' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/InfrastructurePollingGroup"}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"$ref": "#/components/schemas/InfrastructurePollingGroup"
}
},
143
"application/json": {
"schema": {
"$ref": "#/components/schemas/InfrastructurePollingGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/InfrastructurePollingGroup"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/InfrastructurePollingGroup"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/UpdateInfrastructuresDomain
→ in netapi
prime webui Switches UpdateInfrastructuresDomain
Calls POST /prime/webui/Switches/UpdateInfrastructuresDomain. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/UpdateInfrastructuresDomain' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/UpdateDomainQueryViewResource"}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateDomainQueryViewResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDomainQueryViewResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDomainQueryViewResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateDomainQueryViewResource"
}
}
}
},
"responses": {
"200": {
144
"description": "Success"
}
}
}
POST
/prime/webui/Switches/UpdateNetpoller
→ in netapi
prime webui Switches UpdateNetpoller
Calls POST /prime/webui/Switches/UpdateNetpoller. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/UpdateNetpoller' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"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": {
"description": "Success"
}
}
145
}
POST
/prime/webui/Switches/UpdateNetpollersDomain
→ in netapi
prime webui Switches UpdateNetpollersDomain
Calls POST /prime/webui/Switches/UpdateNetpollersDomain. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/UpdateNetpollersDomain' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/UpdateDomainQueryViewResource"}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateDomainQueryViewResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDomainQueryViewResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDomainQueryViewResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateDomainQueryViewResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/UpdatePollingGroup
→ in netapi
prime webui Switches UpdatePollingGroup
Calls POST /prime/webui/Switches/UpdatePollingGroup. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/UpdatePollingGroup' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/ScanPolicyViewResource"}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"requestBody": {
146
"content": {
"application/json -patch+json": {
"schema": {
"$ref": "#/components/schemas/ScanPolicyViewResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScanPolicyViewResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ScanPolicyViewResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ScanPolicyViewResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/UpdateScanPolicy
→ in netapi
prime webui Switches UpdateScanPolicy
Calls POST /prime/webui/Switches/UpdateScanPolicy. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/UpdateScanPolicy' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/SwitchPollingGroup"}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"$ref": "#/components/schemas/SwitchPollingGroup"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SwitchPollingGroup"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SwitchPollingGroup"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SwitchPollingGroup"
147
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/UpdateSwitchConnection
→ in netapi
prime webui Switches UpdateSwitchConnection
Calls POST /prime/webui/Switches/UpdateSwitchConnection. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/UpdateSwitchConnection' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/SwitchConnectionViewResource"}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"$ref": "#/components/schemas/SwitchConnectionViewResource"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/SwitchConnectionViewResource"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/SwitchConnectionViewResource"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/SwitchConnectionViewResource"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/UploadFile
→ in netapi
prime webui Switches UploadFile
Calls POST /prime/webui/Switches/UploadFile. Use this to create data.
POST
/prime/webui/Switches/wlcconnection
→ in netapi
prime webui Switches wlcconnection
Calls POST /prime/webui/Switches/wlcconnection. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/wlcconnection' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/WifiRsWlcConnectionPostRequest"}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"$ref": "#/components/schemas/WifiRsWlcConnectionPostRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/WifiRsWlcConnectionPostRequest"
}
},
"text/json": {
149
"schema": {
"$ref": "#/components/schemas/WifiRsWlcConnectionPostRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/WifiRsWlcConnectionPostRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
},
POST
/prime/webui/Switches/removeitems
→ in netapi
Remove infrastructure items
Remove infrastructure items. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/Switches/removeitems' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"NetApi"
],
"summary": "Remove infrastructure items",
"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": {
150
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/Switches/DontAlarmOnPort
→ in netapi
removes the port completely from monitoring by the system (added tag and the port is greyed ou
removes the port completely from monitoring by the system (added tag
POST
/prime/webui/Switches/DontAlarmOnSwitch
→ in netapi
removes the switch completely from monitoring by the system (added tag and the ports are greye
removes the switch completely from monitoring by the system (added tag
POST
/prime/webui/Switches/RemoveAlarmPort
→ in netapi
The alarmed port is acknowledged by admin and the alarmed state removed (added tag and red ala
The alarmed port is acknowledged by admin and the alarmed state
POST
/prime/webui/Switches/AcceptAlarmPort
→ in netapi
The alarmed port is acknowledged by admin but the alarmed state remains (added tag and yellow
The alarmed port is acknowledged by admin but the alarmed state
POST
/prime/webui/Switches/RemoveAlarmSwitch
→ in netapi
The alarmed switch is acknowledged by admin and the alarmed state removed (added tag and red a
The alarmed switch is acknowledged by admin and the alarmed state
POST
/prime/webui/Switches/AcceptAlarmSwitch
→ in netapi
The alarmed switch is acknowledged by admin but the alarmed state remains (added tag and yello
The alarmed switch is acknowledged by admin but the alarmed state
PUT
/prime/webui/Switches/wlcconnection
→ in netapi
prime webui Switches wlcconnection
Calls PUT /prime/webui/Switches/wlcconnection. Use this to update data.
curl example
curl -X PUT 'https://<host>/prime/webui/Switches/wlcconnection' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/WifiRsWlcConnectionUpdateRequest"}'
OpenAPI spec
"put": {
"tags": [
"NetApi"
],
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"$ref": "#/components/schemas/WifiRsWlcConnectionUpdateRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/WifiRsWlcConnectionUpdateRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/WifiRsWlcConnectionUpdateRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/WifiRsWlcConnectionUpdateRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
Get authentication modes
Get authentication modes. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/serversettings/GetAuthModes' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"ServerSettings"
],
"summary": "Get authentication modes",
"responses": {
"200": {
"description": "Success"
}
}
}
Get NAC modes
Get NAC modes. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/serversettings/GetNACModes' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"ServerSettings"
],
"summary": "Get NAC modes",
"responses": {
"200": {
"description": "Success"
}
}
}
Get server authentication mode
Get server authentication mode. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/serversettings/GetServerAuthMode' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"ServerSettings"
],
"summary": "Get server authentication mode",
"responses": {
"200": {
"description": "Success"
206
}
}
}
Get server NAC mode
Get server NAC mode. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/serversettings/GetServerNACMode' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"ServerSettings"
],
"summary": "Get server NAC mode",
"responses": {
"200": {
"description": "Success"
}
}
}
Get server settings
Get server settings. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/serversettings/GetServerSettings' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"ServerSettings"
],
"summary": "Get server settings",
"parameters": [
{
"name": "generalConfigItem",
"in": "query",
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
Gets the data file status
Gets the data file status. Use this to fetch data.
Gets the file with all the agents and nets archive data, if there is already a file that is cre
Gets the file with all the agents and nets archive data, if there is already a
Gets the file with all the agents and nets archive data, if there is already a file that is cre
Gets the file with all the agents and nets archive data, if there is already a
GET /prime/webui/serversettings/GetCrowdstrikeJwtDetails
prime webui serversettings GetJwt
Calls GET /prime/webui/serversettings/GetJwt. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/serversettings/GetJwt' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"ServerSettings"
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
},
"application/json": {
"schema": {
"type": "string"
}
},
"text/json": {
"schema": {
"type": "string"
}
}
}
}
}
}
prime webui serversettings GetJwtDetails
Calls GET /prime/webui/serversettings/GetJwtDetails. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/serversettings/GetJwtDetails' \
-H 'Authorization: Bearer <token>'
prime webui serversettings primedata status
Calls GET /prime/webui/serversettings/primedata/status. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/serversettings/primedata/status' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"get": {
"tags": [
"ServerSettings"
],
"responses": {
"200": {
"description": "Success"
}
}
}
Gets the file with all the agents and nets archive data, if there is already a file that is cr
Gets the file with all the agents and nets archive data, if there is already a
Post CrowdStrike settings
Post CrowdStrike settings. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/serversettings/CrowdStrikeSettings' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"ServerSettings"
],
"summary": "Post CrowdStrike settings",
"requestBody": {
"description": "",
"content": {
"application/json -patch+json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "",
"nullable": true
}
},
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
211
"type": "string"
},
"description": "",
"nullable": true
}
},
"text/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "",
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "",
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
Post Guardicore settings
Post Guardicore settings. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/serversettings/GuardicoreSettings' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"ServerSettings"
],
"summary": "Post Guardicore settings",
"requestBody": {
"description": "",
"content": {
"application/json -patch+json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "",
"nullable": true
}
},
"application/json": {
212
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "",
"nullable": true
}
},
"text/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "",
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "",
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
Post Guardicore settings
Post Guardicore settings. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/serversettings/MerakiSettings' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"ServerSettings"
],
"summary": "Post Guardicore settings",
"requestBody": {
"description": "",
"content": {
"application/json -patch+json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "",
"nullable": true
213
}
},
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "",
"nullable": true
}
},
"text/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "",
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "",
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
Post Saml settings
Post Saml settings. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/serversettings/SamlSettings' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"ServerSettings"
],
"summary": "Post Saml settings",
"requestBody": {
"description": "",
"content": {
"application/json -patch+json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
214
},
"description": "",
"nullable": true
}
},
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "",
"nullable": true
}
},
"text/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "",
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "",
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
prime webui serversettings agentdefaultsettings
Calls POST /prime/webui/serversettings/agentdefaultsettings. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/serversettings/agentdefaultsettings' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"ServerSettings"
],
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"type": "object",
"additionalProperties": {
215
"type": "string"
},
"nullable": true
}
},
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"text/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
prime webui serversettings agentlessdefaultsettings
Calls POST /prime/webui/serversettings/agentlessdefaultsettings. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/serversettings/agentlessdefaultsettings' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"ServerSettings"
],
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
216
}
},
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"text/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
prime webui serversettings DisableSplunk
Calls POST /prime/webui/serversettings/DisableSplunk. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/serversettings/DisableSplunk' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"post": {
"tags": [
"ServerSettings"
],
"responses": {
"200": {
"description": "Success"
}
}
}
prime webui serversettings emergencykey updatesettings
Calls POST /prime/webui/serversettings/emergencykey/updatesettings. Use this to create data.
prime webui serversettings GenerateCrowdstrikeJwt
Calls POST /prime/webui/serversettings/GenerateCrowdstrikeJwt. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/serversettings/GenerateCrowdstrikeJwt' \
prime webui serversettings GenerateJwt
Calls POST /prime/webui/serversettings/GenerateJwt. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/serversettings/GenerateJwt' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"ServerSettings"
],
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"text/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
220
}
}
prime webui serversettings outdatedtimesupdate
Calls POST /prime/webui/serversettings/outdatedtimesupdate. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/serversettings/outdatedtimesupdate' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"ServerSettings"
],
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"text/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
prime webui serversettings ToggleSaml
Calls POST /prime/webui/serversettings/ToggleSaml. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/serversettings/ToggleSaml' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"ServerSettings"
],
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"text/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST /prime/webui/serversettings/SetAuthMode/{authMode}
Set server NAC mode
Set server NAC mode. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/serversettings/SetServerNACMode/{nacMode}' \
-H 'Authorization: Bearer <token>'
OpenAPI spec
"post": {
"tags": [
"ServerSettings"
],
"summary": "Set server NAC mode",
"parameters": [
{
"name": "nacMode",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
POST /prime/webui/serversettings/TestDataExchange
Test export connection Guardicore
Test export connection Guardicore. Use this to create data.
Test import connection Guardicore
Test import connection Guardicore. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/serversettings/GuardicoreTestConnectionImport' \
Test ISE administration connection
Test ISE administration connection. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/serversettings/TestIseAdministrationConnection' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
Test ISE monitoring connection
Test ISE monitoring connection. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/serversettings/TestIseMonitoringConnection' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
Test LDAP connection
Test LDAP connection. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/serversettings/TestLDAPConnection' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/LdapTestConnection"}'
OpenAPI spec
"post": {
"tags": [
229
"ServerSettings"
],
"summary": "Test LDAP connection",
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"$ref": "#/components/schemas/LdapTestConnection"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/LdapTestConnection"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/LdapTestConnection"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/LdapTestConnection"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
Test WebAPI
Test WebAPI. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/serversettings/TestWebAPI' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'
OpenAPI spec
"post": {
"tags": [
"ServerSettings"
],
"summary": "Test WebAPI",
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {
230
"type": "string"
},
"nullable": true
}
},
"text/json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
},
"application/*+json": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"nullable": true
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
Try authentication as user
Try authentication as user. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/serversettings/TryAuthenticateAsUser' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/LdapTestConnection"}'
OpenAPI spec
"post": {
"tags": [
"ServerSettings"
],
"summary": "Try authentication as user",
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"$ref": "#/components/schemas/LdapTestConnection"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/LdapTestConnection"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/LdapTestConnection"
}
},
231
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/LdapTestConnection"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
