GET
/prime/webui/generalconfig/exporttags
API Documentation · GeneralConfig
GeneralConfig
General platform configuration: tags, server settings, integrations, licensing, and SMTP. 18 endpoints.
Endpoints in this group
- GET GET /prime/webui/generalconfig/exporttags
- GET Get configuration items
- GET Get configuration items
- GET Get custom login configuration items
- GET Get icons
- GET GET /prime/webui/generalconfig/GetConfigItemsByPrefixMeraki/{prefixes}
- GET Get tags
- POST Add or update CACT server
- POST Add or update ISE server
- POST Add or update LDAP server
- POST Add or update LDAP server
- POST Add or update lisence configuration
- POST Add or update smtp configuration
- POST Add or update smtp configuration
- POST POST /prime/webui/generalconfig/addhashtags
- POST Delete tags
- POST Import tags
- POST Set server domain name
GET
/prime/webui/generalconfig/GetConfigItemsByPrefix/{prefixes}
Get configuration items
Get configuration items. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/generalconfig/GetConfigItemsByPrefix/{prefixes}' \
-H 'Authorization: Bearer <token>'OpenAPI spec
"get": {
"tags": [
"GeneralConfig"
],
"summary": "Get configuration items",
"parameters": [
{
"name": "prefixes",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/generalconfig/GetConfigItemsByName/{names}
Get configuration items
Get configuration items. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/generalconfig/GetConfigItemsByName/{names}' \
-H 'Authorization: Bearer <token>'OpenAPI spec
"get": {
"tags": [
"GeneralConfig"
],
"summary": "Get configuration items",
81
"parameters": [
{
"name": "names",
"in": "path",
"required": true,
"schema": {
"type": "string",
"nullable": true
}
}
],
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/generalconfig/GetCustomLoginConfigItems
Get custom login configuration items
Get custom login configuration items. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/generalconfig/GetCustomLoginConfigItems' \
-H 'Authorization: Bearer <token>'OpenAPI spec
"get": {
"tags": [
"GeneralConfig"
],
"summary": "Get custom login configuration items",
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/generalconfig/geticons
Get icons
Get icons. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/generalconfig/geticons' \
-H 'Authorization: Bearer <token>'OpenAPI spec
"get": {
"tags": [
"GeneralConfig"
],
"summary": "Get icons",
"responses": {
"200": {
"description": "Success"
}
}
}
GET
/prime/webui/generalconfig/GetConfigItemsByPrefixMeraki/{prefixes}
GET /prime/webui/generalconfig/GetConfigItemsByPrefixMeraki/{prefixes}
GET
/prime/webui/generalconfig/gethashtags
Get tags
Get tags. Use this to fetch data.
curl example
curl -X GET 'https://<host>/prime/webui/generalconfig/gethashtags' \
-H 'Authorization: Bearer <token>'OpenAPI spec
"get": {
"tags": [
"GeneralConfig"
],
"summary": "Get tags",
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/generalconfig/AddOrUpdateCACTServer
Add or update CACT server
Add or update CACT server. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/generalconfig/AddOrUpdateCACTServer' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'OpenAPI spec
"post": {
"tags": [
83
"GeneralConfig"
],
"summary": "Add or update CACT server",
"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/generalconfig/AddOrUpdateISEServer
Add or update ISE server
Add or update ISE server. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/generalconfig/AddOrUpdateISEServer' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'OpenAPI spec
"post": {
"tags": [
"GeneralConfig"
],
84
"summary": "Add or update ISE server",
"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/generalconfig/AddOrUpdateLDAPServer
Add or update LDAP server
Add or update LDAP server. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/generalconfig/AddOrUpdateLDAPServer' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'OpenAPI spec
"post": {
"tags": [
"GeneralConfig"
],
"summary": "Add or update LDAP server",
"requestBody": {
85
"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/generalconfig/AddOrUpdateCustomLogin
Add or update LDAP server
Add or update LDAP server. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/generalconfig/AddOrUpdateCustomLogin' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'OpenAPI spec
"post": {
"tags": [
"GeneralConfig"
],
"summary": "Add or update LDAP server",
"requestBody": {
"content": {
"application/json -patch+json": {
86
"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/generalconfig/AddOrUpdateLICENSEConfig
Add or update lisence configuration
Add or update lisence configuration. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/generalconfig/AddOrUpdateLICENSEConfig' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'OpenAPI spec
"post": {
"tags": [
"GeneralConfig"
],
"summary": "Add or update lisence configuration",
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"type": "object",
87
"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/generalconfig/RemoveSmtpPassword
Add or update smtp configuration
Add or update smtp configuration. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/generalconfig/RemoveSmtpPassword' \
-H 'Authorization: Bearer <token>'OpenAPI spec
"post": {
"tags": [
"GeneralConfig"
],
"summary": "Add or update smtp configuration",
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/generalconfig/AddOrUpdateSMPTConfig
Add or update smtp configuration
Add or update smtp configuration. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/generalconfig/AddOrUpdateSMPTConfig' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'OpenAPI spec
"post": {
"tags": [
"GeneralConfig"
],
"summary": "Add or update smtp configuration",
"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/generalconfig/addhashtags
POST /prime/webui/generalconfig/addhashtags
POST
/prime/webui/generalconfig/deletehashtags
Delete tags
Delete tags. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/generalconfig/deletehashtags' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{"$ref":"#/components/schemas/GatewayHashtagActionDto"}'OpenAPI spec
"post": {
"tags": [
"GeneralConfig"
],
"summary": "Delete tags",
"requestBody": {
"content": {
"application/json -patch+json": {
"schema": {
"$ref": "#/components/schemas/GatewayHashtagActionDto"
90
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayHashtagActionDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GatewayHashtagActionDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/GatewayHashtagActionDto"
}
}
}
},
"responses": {
"200": {
"description": "Success"
}
}
}
POST
/prime/webui/generalconfig/importtags
Import tags
Import tags. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/generalconfig/importtags' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'OpenAPI spec
"post": {
"tags": [
"GeneralConfig"
],
"summary": "Import tags",
"requestBody": {
"content": {
"multipart/form -data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"nullable": true
}
}
},
"encoding": {
"file": {
"style": "form"
}
}
}
}
},
"responses": {
"200": {
91
"description": "Success"
}
}
}
POST
/prime/webui/generalconfig/SetServerDomainName
Set server domain name
Set server domain name. Use this to create data.
curl example
curl -X POST 'https://<host>/prime/webui/generalconfig/SetServerDomainName' \
-H 'Authorization: Bearer <token>' \
-H 'Content-Type: application/json' \
-d '{}'OpenAPI spec
"post": {
"tags": [
"GeneralConfig"
],
"summary": "Set server domain name",
"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"
}
92
}
}