Meet CybrIQ at InfoComm 2026 · Booth C5052 · June 13–19 · Las Vegas · Pre-book a working session →
API Documentation · ServerSettings

ServerSettings

Server-side platform settings. 35 endpoints.

Endpoints in this group

GET /prime/webui/serversettings/GetAuthModes

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 /prime/webui/serversettings/GetNACModes

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 /prime/webui/serversettings/GetServerAuthMode

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 /prime/webui/serversettings/GetServerNACMode

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 /prime/webui/serversettings/GetServerSettings

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"
                }
             }
           }
GET /prime/webui/serversettings/primedata/fileStatus

Gets the data file status

Gets the data file status. Use this to fetch data.

GET /prime/webui/serversettings/primedata/datafile

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/primedata/getdatafileasync

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

GET /prime/webui/serversettings/GetCrowdstrikeJwtDetails

GET /prime/webui/serversettings/GetJwt

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"
                       }
                    }
                  }
                }
             }
           }
GET /prime/webui/serversettings/GetJwtDetails

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>'
GET /prime/webui/serversettings/primedata/status

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"
               }
            }
          }
POST /prime/webui/serversettings/primedata/startdatafileasync

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 /prime/webui/serversettings/CrowdStrikeSettings

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 /prime/webui/serversettings/GuardicoreSettings

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 /prime/webui/serversettings/MerakiSettings

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 /prime/webui/serversettings/SamlSettings

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"
                 }
              }
          }
POST /prime/webui/serversettings/agentdefaultsettings

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"
                 }
              }
          }
POST /prime/webui/serversettings/agentlessdefaultsettings

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"
                 }
              }
          }
POST /prime/webui/serversettings/DisableSplunk

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"
               }
            }
          }
POST /prime/webui/serversettings/emergencykey/updatesettings

prime webui serversettings emergencykey updatesettings

Calls POST /prime/webui/serversettings/emergencykey/updatesettings. Use this to create data.

POST /prime/webui/serversettings/GenerateCrowdstrikeJwt

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' \
POST /prime/webui/serversettings/GenerateJwt

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

              }
          }
POST /prime/webui/serversettings/outdatedtimesupdate

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"
               }
            }
          }
POST /prime/webui/serversettings/ToggleSaml

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}

POST /prime/webui/serversettings/SetAuthMode/{authMode}

POST /prime/webui/serversettings/SetServerNACMode/{nacMode}

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

POST /prime/webui/serversettings/TestDataExchange

POST /prime/webui/serversettings/GuardicoreTestConnectionExport

Test export connection Guardicore

Test export connection Guardicore. Use this to create data.

POST /prime/webui/serversettings/GuardicoreTestConnectionImport

Test import connection Guardicore

Test import connection Guardicore. Use this to create data.

curl example
curl -X POST 'https://<host>/prime/webui/serversettings/GuardicoreTestConnectionImport' \
POST /prime/webui/serversettings/TestIseAdministrationConnection

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' \
POST /prime/webui/serversettings/TestIseMonitoringConnection

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 '{}'
POST /prime/webui/serversettings/TestLDAPConnection

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"
                 }
              }
          }
POST /prime/webui/serversettings/TestWebAPI

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"
                 }
              }
          }
POST /prime/webui/serversettings/TryAuthenticateAsUser

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"
                  }
               }
           }
Patented Device DNA™ SOC 2 Type II aligned NDAA 889 aligned Engineered for the AV channel InfoComm 2026 · Booth C5052