Misc

Miscellaneous utility APIs for system configuration and monitoring

get

https://localhost:3000/apihttp://localhost:3000/api

/misc/isFmEnabled

Returns whether Fabric Manager (FM) is enabled and available.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/misc/isFmEnabled

HTTPcURLJavaScriptPython

GET /api/misc/isFmEnabled HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/misc/world-map-data

Returns compressed world map topology data in GeoJSON format.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

500

Internal Server Error

get

/misc/world-map-data

HTTPcURLJavaScriptPython

GET /api/misc/world-map-data HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/misc/is-ai-assistant-enabled

Returns whether AI assistant feature is enabled.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

500

Internal Server Error

get

/misc/is-ai-assistant-enabled

HTTPcURLJavaScriptPython

GET /api/misc/is-ai-assistant-enabled HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/misc/get-illustrator-yaml

Returns YAML configuration for fabric illustrator/designer by fabric name.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

fabricNamestringRequired

Fabric name

Example: {"value":"fabric1"}

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/misc/get-illustrator-yaml

HTTPcURLJavaScriptPython

GET /api/misc/get-illustrator-yaml?fabricName=text HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

post

https://localhost:3000/apihttp://localhost:3000/api

/misc/disable-yaml

Disables YAML onboarding mode and switches to CSV mode.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/misc/disable-yaml

HTTPcURLJavaScriptPython

POST /api/misc/disable-yaml HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/misc/region-list

Returns list of all regions from both device table and region configuration table.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/misc/region-list

HTTPcURLJavaScriptPython

GET /api/misc/region-list HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/misc/recent-activity

Returns recent activity logs filtered by time range and optionally by fabric ID.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Query parameters

timestringOptional

all

Note: Time range options are 1h, 2h, 4h, 12h, 1d, 1w, 2w, all

fabricidstringOptional

Fabric ID to filter by

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

get

/misc/recent-activity

HTTPcURLJavaScriptPython

GET /api/misc/recent-activity HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

get

https://localhost:3000/apihttp://localhost:3000/api

/misc/telemetry-preferences

Returns telemetry subscription preferences including platform metrics, feature protocol, and QoS telemetry settings.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

404

Not Found - Default profile not found

500

Internal Server Error

get

/misc/telemetry-preferences

HTTPcURLJavaScriptPython

GET /api/misc/telemetry-preferences HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Accept: */*

No content

post

https://localhost:3000/apihttp://localhost:3000/api

/misc/upload-yaml

Uploads YAML configuration file for processing.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Body

multipart/form-data

filestringRequired

YAML file to upload

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

post

/misc/upload-yaml

HTTPcURLJavaScriptPython

POST /api/misc/upload-yaml HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 15

{
  "file": "text"
}

No content

patch

https://localhost:3000/apihttp://localhost:3000/api

/misc/update-telemetry-preferences

Updates telemetry subscription preferences for platform metrics, feature protocol, and QoS telemetry.

Authorizations

api_key

authorizationstringRequired

Use User's Api for authorization

Body

application/json

typestringOptionalExample: object

Responses

200

OK

No content

401

Unauthorized

403

Forbidden

500

Internal Server Error

patch

/misc/update-telemetry-preferences

HTTPcURLJavaScriptPython

PATCH /api/misc/update-telemetry-preferences HTTP/1.1
Host: localhost:3000
authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 188

{
  "type": "object",
  "properties": {
    "platformMetrics": {
      "type": "boolean",
      "examples": null
    },
    "featureProtocol": {
      "type": "boolean",
      "examples": null
    },
    "qosTelemetry": {
      "type": "boolean",
      "examples": null
    }
  }
}

No content