API Changelog

The following sections describe API changes in each release of Nexus Dashboard Insights.

Release 6.2.1 (2021-03-27)

For additional information about the release, see the Release Notes for ACI and Release Notes for DCNM.

What's New

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/flowrules/interfaceInfo

Get specified info for an interface to create interface FT rules

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/flowrules/nodes

Get list of nodes for a given fabric to create interface FT rules

GET /api/v1/advisories/details

Get the advisories

GET /api/v1/advisories/summary

Get the summary of advisories

GET /api/v1/advisories/topFabrics

Get Top Fabrics based on Advisory Score

GET /api/v1/anomalies/buckets

Return the anomalies buckets

GET /api/v1/anomalies/details

Get Anomalies details list

GET /api/v1/anomalies/relatedMetrics

Get the list of default resources

POST /api/v1/anomalies/relatedMetrics

Get the list of default resources

GET /api/v1/anomalies/relatedObjects

Get the list of related objects

GET /api/v1/anomalies/summary

Get the summary of anomalies

GET /api/v1/anomalies/topFabrics

Get Top Fabrics based on Anomaly Score

GET /api/v1/anomalies/topFlowRecords

Get top flow records by anomalies

GET /api/v1/anomalies/topFlows

Get the top flows by anomalies

GET /api/v1/anomalies/topNodes

Get top nodes list based on anomaly score

GET /api/v1/applications/browse

Browse API for different application objects

GET /api/v1/applications/details

Details API for different application objects

GET /api/v1/applications/summary

Get summary of applications

GET /api/v1/applications/topEntities

Top Entities API for different application objects

GET /api/v1/applications/topologies

Get topology of an application

GET /api/v1/bgp/details

BGP protocol details

POST /api/v1/config/addJob

Add a config job to be scheduled

POST /api/v1/config/deleteJob

Delete a scheduled job

GET /api/v1/config/fastStart

Get status of fastStart job

POST /api/v1/config/fastStart

Start a fastStart job

GET /api/v1/config/siteGroups/{siteGroupName}/status

summary: Get status of onboarding config and flow config

GET /api/v1/config/siteGroups/{siteGroupName}/systemanomalies/summary

summary: Get active config system anomaly summary

GET /api/v1/endpoints

Get the snapshot of entire site or a particular node at a given time

GET /api/v1/endpoints/anomalies

Get the anomaly history of an endpoint.

GET /api/v1/endpoints/count

Get the Endpoints Count of entire site or given a condition

GET /api/v1/endpoints/details

Get the history of an endpoint

GET /api/v1/endpoints/duplicateIps

Get the count of duplicate IPs.

GET /api/v1/endpoints/history

Get the history of an endpoint

GET /api/v1/endpoints/statistics

Get the top nodes by endpoint statistics.

GET /api/v1/endpoints/summary

Get the Endpoint Summary of entire fabric or given a condition

GET /api/v1/endpoints/topEndpoints

Get the top nodes by endpoint anomaly score.

GET /api/v1/endpoints/topNodes

Get the top nodes by endpoint stat.

GET /api/v1/events/buckets

Events buckets

GET /api/v1/events/details

Events details

GET /api/v1/events/summary

Events summary

GET /api/v1/features

Get the site features

GET /api/v1/firmwareAnalysis/recommendedFirmware

Get the Recommended firmware path for the given recommendation Ids

GET /api/v1/flowEvents/details

Get detailed flow events

GET /api/v1/flows

Browse flows

GET /api/v1/flows/details

Get detailed flows

GET /api/v1/flows/flowMatchingSites

Get sites for the given flow parameters

GET /api/v1/flows/multiSiteDetails

Get detailed flows for multi sites

GET /api/v1/flows/multiSitePaths

Get detailed paths across sites

GET /api/v1/flows/paths

Get detailed paths

GET /api/v1/flows/topFlows

Get the top flows.

GET /api/v1/flows/topNodes

API for top nodes for flows

GET /api/v1/ftExpectedConfig

summary: Get Flow Telemetry Expected Config

GET /api/v1/health/collectionStats

Get collection status for last hour, status of bug scan and best practices(NX/DCNM) run for the devices

GET /api/v1/hostPlatforms

Get Host Platform

GET /api/v1/igmp/details

IGMP protocol details

GET /api/v1/igmpsnoop/details

IGMP snoop protocol details

GET /api/v1/inbox/messages

Get Inbox Messages

POST /api/v1/inbox/messages

Update inbox notifications

GET /api/v1/integrations

Get operational info of currently onboarded integrations

GET /api/v1/integrations/summary

Get summary of integrations

POST /api/v1/job/techSupportUpload

Trigger techsupport upload

POST /api/v1/job/techSupportUploadAll

Trigger techsupport upload

GET /api/v1/jobs/nodeStates

Node state of fabric nodes

POST /api/v1/jobs/stop

Stop a scheduled job

GET /api/v1/jobs/summary

Get Job Summary

POST /api/v1/metadata/cloudSync

Update to Latest Metadata

GET /api/v1/metadata/latest

Get Latest Metadata

GET /api/v1/microburst/queues

Get interface queues

GET /api/v1/microburst/status

Get microburst status of all fabrics

GET /api/v1/microburst/summary

Get summary of microburst

GET /api/v1/microburst/topBursts

Top microbursts based on peak or duration

GET /api/v1/nodeCapabilities

Get the features available on the node

GET /api/v1/nodes

Get nodes list

GET /api/v1/portchannel/details

Port channel details

GET /api/v1/protocols/details

Get protocol details

GET /api/v1/protocols/topEntities

Protocol top entities

GET /api/v1/protocols/topNodes

Protocol top nodes

GET /api/v1/reports/details

Get conformance details of a reportType for a siteName over an outlookPeriod

GET /api/v1/reports/inventory

Get Inventory reports for a siteName

GET /api/v1/reports/summary

Get conformance summary of a reportType for a siteName over an outlookPeriod

GET /api/v1/siteGroups

Insights Groups Info

POST /api/v1/siteGroups/{siteGroupName}/sites/{siteName}/alert/remediate

Remediate a diagnostic check for an anomaly

GET /api/v1/siteGroups/{siteGroupName}/sites/{siteName}/alert/remediationDetails

Remediation details information of an anomaly

GET /api/v1/siteGroups/{siteGroupName}/sites/{siteName}/alert/remediationProgress

Remediation progress of all diagnostic checks for an anomaly

GET /api/v1/sites

Get fabrics list

GET /api/v1/sites/topNodes

Get Fabric wide Top Nodes

GET /api/v1/sitesSummary

Get fabric anomaly summary

GET /api/v1/svi/details

IGMP protocol details

GET /api/v1/swExpectedConfigs

Get Software Telemetry Expected Config

GET /api/v1/tenants

Get List of tenants in a site

GET /api/v1/topologies

Get topology of the fabric

GET /api/v1/utilization/nodeDetails

Utilization details of fabric nodes

GET /api/v1/utilization/resources

Get resources list

GET /api/v1/utilization/sitesSummary

Get fabric utilization stats summary

GET /api/v1/utilization/topNodes

Get utilization top nodes

GET /api/v1/vcenter/browse

Browse API for different vcenter objects

GET /api/v1/vcenter/details

Details API for different vcenter objects

GET /api/v1/vcenter/summary

Get summary of vms

GET /api/v1/vcenter/topEntities

Top Entities API for different vcenter objects

GET /api/v1/vcenter/topology

Get topology of a vcenter entity

GET /api/v1/vrfs

Get list of vrfs from a tenant

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/fabric/{fabricName}/interfaceFlowRules/refresh

Refresh interface flow rules

GET /fullIntegrations

Get all integrations with full details

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/interfaceFlowRules

Get interface flow rules for a specific fabric

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/interfaceFlowRules

Create new interface flow rules

DELETE /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/interfaceFlowRules/batchDelete

Delete interface flow rule

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/interfaceFlowRules/{id}

Get interface flow rule

PUT /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/interfaceFlowRules/{id}

Update interface flow rules

DELETE /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/interfaceFlowRules/{id}

Delete interface flow rule

POST /insightsGroup/{igName}/objectSelectors/{id}/preview/file/template

API to generate Object Selectors for Template Requirements

GET /siteGroups

Get All Site Groups

GET /sites

Get sites

What's Deleted

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/advisories/details.json

Get the advisories

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/advisories/summary.json

Get the summary of advisories

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/anomalies/buckets.json

Return the anomalies buckets

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/anomalies/details.json

Get Anomalies details list

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/anomalies/relatedMetrics.json

Get the list of default resources

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/anomalies/relatedMetrics.json

Get the list of default resources

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/anomalies/relatedObjects.json

Get the list of related objects

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/anomalies/summary.json

Get the summary of anomalies

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/anomalies/topFlowRecords.json

Get top flow records by anomalies

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/anomalies/topFlows.json

Get the top flows by anomalies

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/anomalies/topNodes.json

Get top nodes list based on anomaly score

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/applications/browse.json

Browse API for different application objects

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/applications/details.json

Details API for different application objects

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/applications/summary.json

Get summary of applications

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/applications/topEntities.json

Top Entities API for different application objects

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/applications/topology.json

Get topology of an application

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/bgp/details.json

BGP protocol details

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/config/addJob.json

Add a config job to be scheduled

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/config/deleteJob.json

Delete a scheduled job

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/config/fastStart.json

Start a fastStart job

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/endpoints/anomalies.json

Get the anomaly history of an endpoint.

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/endpoints/browse.json

Get the snapshot of entire fabric or a particular node at a given time

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/endpoints/details.json

Get the history of an endpoint

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/endpoints/duplicateIps.json

Get the count of duplicate IPs.

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/endpoints/epStatistics.json

Get the top nodes by endpoint statistics.

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/endpoints/history.json

Get the history of an endpoint

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/endpoints/topEndpoints.json

Get the top nodes by endpoint anomaly score.

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/endpoints/topNodes.json

Get the top nodes by endpoint stat.

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/events/buckets.json

Events buckets

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/events/details.json

Events details

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/events/summary.json

Events summary

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/fabrics.json

Get fabrics list

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/fabrics/topNodes.json

Get Fabric wide Top Nodes

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/fabricsSummary.json

Get fabric anomaly summary

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/features.json

Get the fabric features

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/firmwareAnalysis/recommendedFirmware.json

Get the Recommended firmware path for the given recommendation Ids

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/firmwareAnalysis/recommendedPath.json

Get the Recommended firmware path for the given recommendation Ids

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/flowEvents/details.json

Get detailed flow events

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/flows/details.json

Get detailed flows

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/flows/flowmatchingsites.json

Get sites for the given flow parameters

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/flows/multisitedetails.json

Get detailed flows for multi sites

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/flows/multisitepaths.json

Get detailed paths across sites

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/flows/paths.json

Get detailed paths

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/flows/summary.json

Browse Flows

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/flows/topFlows.json

Get the top flows.

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/flows/topNodes.json

API for top nodes for flows

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/ftExpectedConfig.json

summary: Get Flow Telemetry Expected Config

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/health/collectionStats.json

Get collection status for last hour

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/hostPlatform.json

Get Host Platform

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/igmpsnoop/details.json

IGMP snoop protocol details

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/inbox/message.json

Get Inbox Messages

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/inbox/message.json

Update inbox notifications

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/integrations.json

Get operational info of currently onboarded integrations

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/integrations/summary.json

Get summary of integrations

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/job/techsupportupload.json

Trigger techsupport upload

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/job/techsupportuploadall.json

Trigger techsupport upload

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/jobs/nodeState.json

Node state of fabric nodes

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/jobs/stop.json

Stop a scheduled job

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/metadata/latest.json

Get Latest Metadata

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/metadata/update.json

Update to Latest Metadata

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/microburst/microburstStatus.json

Get microburst status of all fabrics

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/microburst/queues.json

Get interface queues

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/microburst/summary.json

Get summary of microburst

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/microburst/topBursts.json

Top microbursts based on peak or duration

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/nodeCapability.json

Get the features available on the node

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/nodes.json

Get nodes list

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/portchannel/details.json

Port channel details

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/protocols/details.json

Get protocol details

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/protocols/topEntities.json

Protocol top entities

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/protocols/topNodes.json

Protocol top nodes

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/swExpectedConfig.json

Get Software Telemetry Expected Config

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/tenants.json

Get List of tenants in a fabric

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/topology.json

Get topology of the fabric

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/utilization/fabricSummary.json

Get fabric utilization stats summary

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/utilization/nodeDetails.json

Utilization details of fabric nodes

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/utilization/resources.json

Get resources list

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/utilization/topNodes.json

Get utilization top nodes

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v1/insightsGroups.json

Insights Groups Info

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/advisories/details.json

Get the advisories

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/advisories/summary.json

Get the summary of advisories

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/advisories/topFabrics.json

Get Top Fabrics based on Advisory Score

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/anomalies/details.json

Get Anomalies details list

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/anomalies/summary.json

Get the summary of anomalies

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/anomalies/topFabrics.json

Get Top Fabrics based on Anomaly Score

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igname}/status.json

summary: Get status of onboarding config and flow config

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igname}/systemanomalies/summary.json

summary: Get active config system anomaly summary

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/events/buckets.json

Events buckets

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/events/details.json

Events details

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/events/summary.json

Events summary

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/insightsGroup/{igName}/fabric/{fabricName}/alert/remediate.json

Remediate a diagnostic check for an anomaly

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/insightsGroup/{igName}/fabric/{fabricName}/alert/remediationDetails.json

Remediation details information of an anomaly

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/insightsGroup/{igName}/fabric/{fabricName}/alert/remediationProgress.json

Remediation progress of all diagnostic checks for an anomaly

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/insightsGroups.json

Insights Groups Info

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/vcenter/browse.json

Browse API for different vcenter objects

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/vcenter/details.json

Details API for different vcenter objects

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/vcenter/summary.json

Get summary of vms

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/vcenter/topEntities.json

Top Entities API for different vcenter objects

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/vcenter/topology.json

Get topology of a vcenter entity

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/vrfs.json

Get list of vrfs from a tenant

What's Changed

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/uploadFile/{uuid}/chunk

Return Type:

Deleted response : **default **

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/runEpochDelta

Request:

Changed content type : */*

• Changed property priorEpochUuid (string)

  Prior epoch delta job uuid

• Changed property laterEpochUuid (string)

  Later epoch delta job uuid

• Changed property priorEpochTime (integer)

  Prior epoch time of epoch delta job

• Changed property laterEpochTime (integer)

  Later epoch time of epoch delta job

• Changed property priorEpochWid (integer)

  Prior epoch wid

• Changed property laterEpochWid (integer)

  Later epoch wid

• Changed property jobName (string)

  Prior epoch delta job name

• Changed property pcvJobId (string)

  Pcv epoch delta job id

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property configId (string)

    Job config id of assurance analysis

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/runOfflineAnalysis

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property configId (string)

    Job config id of assurance analysis

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/systemSettings/earlyAccessMode

Get Early Access Mode

Return Type:

New response : 400 Bad Request

Bad Request

New response : 500 Internal Server Error

Internal Server Error

New response : **default ** Changed response : 200 OK

Successful Operation

New header : Date

date

New header : Location

Get Early Access mode

• Changed content type : application/json

  • Added property status (string)

    Early access mode status

    Enum values:

    • ENABLED
    • DISABLED

  • Added property statusLastModifiedTime (integer)

    Time when status was last modified

  • Added property onboardingCompleteLastModifiedTime (integer)

    Time when on-boarding completion was last modified

  • Added property complete (boolean)

    Completed on-boarding

  • Deleted property success (boolean)

  • Deleted property messages (array)

  • Deleted property value (object)

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/systemSettings/earlyAccessMode

Save Early Access Mode

Request:

Changed content type : */*

• Changed property status (string)

  Early access mode status

• Changed property statusLastModifiedTime (integer)

  Time when status was last modified

• Changed property onboardingCompleteLastModifiedTime (integer)

  Time when on-boarding completion was last modified

• Changed property complete (boolean)

  Completed on-boarding

Return Type:

New response : 201 Created

Successful Operation

New response : 400 Bad Request

Bad Request

New response : 500 Internal Server Error

Internal Server Error

New response : **default ** Changed response : 200 OK

success

New header : Date

date

• Changed content type : application/json

  • Added property status (string)

    Early access mode status

  • Added property statusLastModifiedTime (integer)

    Time when status was last modified

  • Added property onboardingCompleteLastModifiedTime (integer)

    Time when on-boarding completion was last modified

  • Added property complete (boolean)

    Completed on-boarding

  • Deleted property success (boolean)

  • Deleted property messages (array)

  • Deleted property value (object)

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/flowRules

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  Changed items (object):

  • Changed property fabricName (string)

    Fabric name

  • Changed property name (string)

    Flow rule name

  • Changed property tenant (string)

    Tenant

  • Changed property vrf (string)

    Vrf

  • Changed property flowRuleAttributeList (array)

    list of flow rule attribute

    Changed items (object):

    • Added property operation (string)

      Flow rule operation

      Enum values:

      • ADD
      • DELETE

    • Changed property flowRuleAttributeUuid (string)

      Flow rule attribute uuid

    • Changed property subnet (string)

      Subnet flow rule attribute

    • Changed property srcIp (string)

      Source ip

    • Changed property srcPort (string)

      Source port

    • Changed property dstIp (string)

      Destination ip

    • Changed property dstPort (string)

      Destination port

    • Changed property protocol (string)

      Protocol

    • Changed property bidirectional (boolean)

      Bidirectional

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/kafkaFastSettings

Request:

Changed content type : */*

• Changed property securedSslSettings (object)

  • Added property encryptedCaCert (string)

    Encrypted ca cert of secure ssl

  • Added property encryptedClientCert (string)

    Encrypted client cert of secured ssl

  • Added property encryptedClientKey (string)

    Encrypted client key

  • Changed property caCert (string)

    Ca cert of secured ssl

  • Changed property clientCert (string)

    Client cert

  • Changed property clientKey (string)

    Secure ssl client key

• Changed property saslPlainSettings (object)

  • Added property encryptedPassword (string)

    Encrypted password of user

  • Changed property username (string)

    User name in ssl plain settings

  • Changed property password (string)

    Password of user

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property securedSslSettings (object)

    • Added property encryptedCaCert (string)

      Encrypted ca cert of secure ssl

    • Added property encryptedClientCert (string)

      Encrypted client cert of secured ssl

    • Added property encryptedClientKey (string)

      Encrypted client key

    • Changed property caCert (string)

      Ca cert of secured ssl

    • Changed property clientCert (string)

      Client cert

    • Changed property clientKey (string)

      Secure ssl client key

  • Changed property saslPlainSettings (object)

    • Added property encryptedPassword (string)

      Encrypted password of user

    • Changed property username (string)

      User name in ssl plain settings

    • Changed property password (string)

      Password of user

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/kafkaFastSettings/{id}

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property securedSslSettings (object)

    • Added property encryptedCaCert (string)

      Encrypted ca cert of secure ssl

    • Added property encryptedClientCert (string)

      Encrypted client cert of secured ssl

    • Added property encryptedClientKey (string)

      Encrypted client key

    • Changed property caCert (string)

      Ca cert of secured ssl

    • Changed property clientCert (string)

      Client cert

    • Changed property clientKey (string)

      Secure ssl client key

  • Changed property saslPlainSettings (object)

    • Added property encryptedPassword (string)

      Encrypted password of user

    • Changed property username (string)

      User name in ssl plain settings

    • Changed property password (string)

      Password of user

PUT /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/kafkaFastSettings/{id}

Request:

Changed content type : */*

• Changed property securedSslSettings (object)

  • Added property encryptedCaCert (string)

    Encrypted ca cert of secure ssl

  • Added property encryptedClientCert (string)

    Encrypted client cert of secured ssl

  • Added property encryptedClientKey (string)

    Encrypted client key

  • Changed property caCert (string)

    Ca cert of secured ssl

  • Changed property clientCert (string)

    Client cert

  • Changed property clientKey (string)

    Secure ssl client key

• Changed property saslPlainSettings (object)

  • Added property encryptedPassword (string)

    Encrypted password of user

  • Changed property username (string)

    User name in ssl plain settings

  • Changed property password (string)

    Password of user

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property securedSslSettings (object)

    • Added property encryptedCaCert (string)

      Encrypted ca cert of secure ssl

    • Added property encryptedClientCert (string)

      Encrypted client cert of secured ssl

    • Added property encryptedClientKey (string)

      Encrypted client key

    • Changed property caCert (string)

      Ca cert of secured ssl

    • Changed property clientCert (string)

      Client cert

    • Changed property clientKey (string)

      Secure ssl client key

  • Changed property saslPlainSettings (object)

    • Added property encryptedPassword (string)

      Encrypted password of user

    • Changed property username (string)

      User name in ssl plain settings

    • Changed property password (string)

      Password of user

DELETE /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/kafkaFastSettings/{id}

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property securedSslSettings (object)

    • Added property encryptedCaCert (string)

      Encrypted ca cert of secure ssl

    • Added property encryptedClientCert (string)

      Encrypted client cert of secured ssl

    • Added property encryptedClientKey (string)

      Encrypted client key

    • Changed property caCert (string)

      Ca cert of secured ssl

    • Changed property clientCert (string)

      Client cert

    • Changed property clientKey (string)

      Secure ssl client key

  • Changed property saslPlainSettings (object)

    • Added property encryptedPassword (string)

      Encrypted password of user

    • Changed property username (string)

      User name in ssl plain settings

    • Changed property password (string)

      Password of user

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/kafkaFastSettings

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  Changed items (object):

  • Changed property securedSslSettings (object)

    • Added property encryptedCaCert (string)

      Encrypted ca cert of secure ssl

    • Added property encryptedClientCert (string)

      Encrypted client cert of secured ssl

    • Added property encryptedClientKey (string)

      Encrypted client key

    • Changed property caCert (string)

      Ca cert of secured ssl

    • Changed property clientCert (string)

      Client cert

    • Changed property clientKey (string)

      Secure ssl client key

  • Changed property saslPlainSettings (object)

    • Added property encryptedPassword (string)

      Encrypted password of user

    • Changed property username (string)

      User name in ssl plain settings

    • Changed property password (string)

      Password of user

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/kafkaFastSettings

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  Changed items (object):

  • Changed property securedSslSettings (object)

    • Added property encryptedCaCert (string)

      Encrypted ca cert of secure ssl

    • Added property encryptedClientCert (string)

      Encrypted client cert of secured ssl

    • Added property encryptedClientKey (string)

      Encrypted client key

    • Changed property caCert (string)

      Ca cert of secured ssl

    • Changed property clientCert (string)

      Client cert

    • Changed property clientKey (string)

      Secure ssl client key

  • Changed property saslPlainSettings (object)

    • Added property encryptedPassword (string)

      Encrypted password of user

    • Changed property username (string)

      User name in ssl plain settings

    • Changed property password (string)

      Password of user

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/uploadFile

Request:

Changed content type : */*

• Added property siteGroupUuid (string)

  SiteGroup Uuid

• Added property siteUuid (string)

  Site uuid

• Added property siteName (string)

  Name of site

• Added property lastAnalysisTimestamp (integer)

  Timestamp of last assurance analysis

• Added property lastAnalysisTimeRfc3339 (string)

  Timestamp of last assurance analysis in RFC 339 format

• Added property analysisJobId (string)

  Assurance analysis job id

• Added property nodeIPList (array)

  List of node IP

  Items (string):

• Changed property uniqueName (string)

  Unique name

• Changed property insightGroupUuid (string)

  InsightGroupUuid or SiteGroupUuid

• Changed property importJobUuid (string)

  File import job uuid of file

• Changed property uploadType (string)

  Upload type of file

• Changed property comment (string)

  Comments

• Changed property filename (string)

  Name of file

• Changed property associatedSiteName (string)

  Associated site name

• Changed property sizeInBytes (integer)

  Operation type of insightGroup or siteGroup - Offline/Online

• Changed property status (string)

  Status of offline file upload

• Changed property uploadTimeMsecs (integer)

  Uploaded time of offline file in milliseconds

• Changed property assuranceEntityId (string)

  Operation type of insightGroup or siteGroup - Offline/Online

• Changed property fileExtension (string)

  File extension format

• Changed property nodeCount (integer)

  Total node count

• Changed property uploadTimeRfc3339 (string)

  Uploaded time of offline file in RFC 3339 format

• Changed property checksum (string)

  Checksum

• Changed property collectionScriptVersion (string)

  Collection script version

• Changed property collectionTimeMsecs (integer)

  Collection time in milliseconds

• Changed property collectionTimeRfc3339 (string)

  Collection timestamp in RFC 3339 format

• Changed property collectionTimeLastMsecs (integer)

  Last collection timestamp in milliseconds

• Changed property collectionTimeLastRfc3339 (string)

  Last collection time in RFC 3339 format

• Changed property installationTimeMsecs (integer)

  Installation timestamp in milliseconds

• Changed property installationTimeRfc3339 (string)

  Installation time in RFC 3339 format

• Changed property upgradeBundleInstallationStatus (string)

  Operation type of insightGroup or siteGroup - Offline/Online

• Changed property upgradeBundleVersion (string)

  Upgraded bundle version

• Changed property uploadedUserName (string)

  Name of file upload user

• Changed property isCurrentInstalledBundle (boolean)

  Boolean field to represent currently installed bundle

• Changed property assuranceEntityType (string)

  Type of assurance entity or site - ACI, NXOS etc

• Changed property upgradeTargetVersion (string)

  Target version for upgrade

Return Type:

Changed response : **default **

• Changed content type : application/xml

  • Added property siteGroupUuid (string)

    SiteGroup Uuid

  • Added property siteUuid (string)

    Site uuid

  • Added property siteName (string)

    Name of site

  • Added property lastAnalysisTimestamp (integer)

    Timestamp of last assurance analysis

  • Added property lastAnalysisTimeRfc3339 (string)

    Timestamp of last assurance analysis in RFC 339 format

  • Added property analysisJobId (string)

    Assurance analysis job id

  • Added property nodeIPList (array)

    List of node IP

  • Changed property uniqueName (string)

    Unique name

  • Changed property insightGroupUuid (string)

    InsightGroupUuid or SiteGroupUuid

  • Changed property importJobUuid (string)

    File import job uuid of file

  • Changed property uploadType (string)

    Upload type of file

  • Changed property comment (string)

    Comments

  • Changed property filename (string)

    Name of file

  • Changed property associatedSiteName (string)

    Associated site name

  • Changed property sizeInBytes (integer)

    Operation type of insightGroup or siteGroup - Offline/Online

  • Changed property status (string)

    Status of offline file upload

  • Changed property uploadTimeMsecs (integer)

    Uploaded time of offline file in milliseconds

  • Changed property assuranceEntityId (string)

    Operation type of insightGroup or siteGroup - Offline/Online

  • Changed property fileExtension (string)

    File extension format

  • Changed property nodeCount (integer)

    Total node count

  • Changed property uploadTimeRfc3339 (string)

    Uploaded time of offline file in RFC 3339 format

  • Changed property checksum (string)

    Checksum

  • Changed property collectionScriptVersion (string)

    Collection script version

  • Changed property collectionTimeMsecs (integer)

    Collection time in milliseconds

  • Changed property collectionTimeRfc3339 (string)

    Collection timestamp in RFC 3339 format

  • Changed property collectionTimeLastMsecs (integer)

    Last collection timestamp in milliseconds

  • Changed property collectionTimeLastRfc3339 (string)

    Last collection time in RFC 3339 format

  • Changed property installationTimeMsecs (integer)

    Installation timestamp in milliseconds

  • Changed property installationTimeRfc3339 (string)

    Installation time in RFC 3339 format

  • Changed property upgradeBundleInstallationStatus (string)

    Operation type of insightGroup or siteGroup - Offline/Online

  • Changed property upgradeBundleVersion (string)

    Upgraded bundle version

  • Changed property uploadedUserName (string)

    Name of file upload user

  • Changed property isCurrentInstalledBundle (boolean)

    Boolean field to represent currently installed bundle

  • Changed property assuranceEntityType (string)

    Type of assurance entity or site - ACI, NXOS etc

  • Changed property upgradeTargetVersion (string)

    Target version for upgrade

• Changed content type : application/json

  • Added property siteGroupUuid (string)

    SiteGroup Uuid

  • Added property siteUuid (string)

    Site uuid

  • Added property siteName (string)

    Name of site

  • Added property lastAnalysisTimestamp (integer)

    Timestamp of last assurance analysis

  • Added property lastAnalysisTimeRfc3339 (string)

    Timestamp of last assurance analysis in RFC 339 format

  • Added property analysisJobId (string)

    Assurance analysis job id

  • Added property nodeIPList (array)

    List of node IP

  • Changed property uniqueName (string)

    Unique name

  • Changed property insightGroupUuid (string)

    InsightGroupUuid or SiteGroupUuid

  • Changed property importJobUuid (string)

    File import job uuid of file

  • Changed property uploadType (string)

    Upload type of file

  • Changed property comment (string)

    Comments

  • Changed property filename (string)

    Name of file

  • Changed property associatedSiteName (string)

    Associated site name

  • Changed property sizeInBytes (integer)

    Operation type of insightGroup or siteGroup - Offline/Online

  • Changed property status (string)

    Status of offline file upload

  • Changed property uploadTimeMsecs (integer)

    Uploaded time of offline file in milliseconds

  • Changed property assuranceEntityId (string)

    Operation type of insightGroup or siteGroup - Offline/Online

  • Changed property fileExtension (string)

    File extension format

  • Changed property nodeCount (integer)

    Total node count

  • Changed property uploadTimeRfc3339 (string)

    Uploaded time of offline file in RFC 3339 format

  • Changed property checksum (string)

    Checksum

  • Changed property collectionScriptVersion (string)

    Collection script version

  • Changed property collectionTimeMsecs (integer)

    Collection time in milliseconds

  • Changed property collectionTimeRfc3339 (string)

    Collection timestamp in RFC 3339 format

  • Changed property collectionTimeLastMsecs (integer)

    Last collection timestamp in milliseconds

  • Changed property collectionTimeLastRfc3339 (string)

    Last collection time in RFC 3339 format

  • Changed property installationTimeMsecs (integer)

    Installation timestamp in milliseconds

  • Changed property installationTimeRfc3339 (string)

    Installation time in RFC 3339 format

  • Changed property upgradeBundleInstallationStatus (string)

    Operation type of insightGroup or siteGroup - Offline/Online

  • Changed property upgradeBundleVersion (string)

    Upgraded bundle version

  • Changed property uploadedUserName (string)

    Name of file upload user

  • Changed property isCurrentInstalledBundle (boolean)

    Boolean field to represent currently installed bundle

  • Changed property assuranceEntityType (string)

    Type of assurance entity or site - ACI, NXOS etc

  • Changed property upgradeTargetVersion (string)

    Target version for upgrade

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/fabric

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  Changed items (object):

  • Added property siteName (string)

  • Added property accountId (string)

  • Added property siteGroupUuid (string)

  • Added property microBurstCloudSettings (object)

    • Property status (string)

      Enum values:

      • DISABLED
      • ENABLED

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Added property siteName (string)

  • Added property accountId (string)

  • Added property siteGroupUuid (string)

  • Added property microBurstCloudSettings (object)

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/analysisSettings

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Added property siteName (string)

  • Added property accountId (string)

  • Added property siteGroupUuid (string)

  • Added property microBurstCloudSettings (object)

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/bestPracticesSettings

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Added property siteName (string)

  • Added property accountId (string)

  • Added property siteGroupUuid (string)

  • Added property microBurstCloudSettings (object)

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/bugScanSettings

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Added property siteName (string)

  • Added property accountId (string)

  • Added property siteGroupUuid (string)

  • Added property microBurstCloudSettings (object)

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/flowRules

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  Changed items (object):

  • Changed property fabricName (string)

    Fabric name

  • Changed property name (string)

    Flow rule name

  • Changed property tenant (string)

    Tenant

  • Changed property vrf (string)

    Vrf

  • Changed property flowRuleAttributeList (array)

    list of flow rule attribute

    Changed items (object):

    • Added property operation (string)

      Flow rule operation

    • Changed property flowRuleAttributeUuid (string)

      Flow rule attribute uuid

    • Changed property subnet (string)

      Subnet flow rule attribute

    • Changed property srcIp (string)

      Source ip

    • Changed property srcPort (string)

      Source port

    • Changed property dstIp (string)

      Destination ip

    • Changed property dstPort (string)

      Destination port

    • Changed property protocol (string)

      Protocol

    • Changed property bidirectional (boolean)

      Bidirectional

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/flowRules

Request:

Changed content type : */*

• Changed property flowRulesList (array)

  List of flow rules

  Changed items (object):

  • Changed property fabricName (string)

    Fabric name

  • Changed property name (string)

    Flow rule name

  • Changed property tenant (string)

    Tenant

  • Changed property vrf (string)

    Vrf

  • Changed property flowRuleAttributeList (array)

    list of flow rule attribute

    Changed items (object):

    • Added property operation (string)

      Flow rule operation

    • Changed property flowRuleAttributeUuid (string)

      Flow rule attribute uuid

    • Changed property subnet (string)

      Subnet flow rule attribute

    • Changed property srcIp (string)

      Source ip

    • Changed property srcPort (string)

      Source port

    • Changed property dstIp (string)

      Destination ip

    • Changed property dstPort (string)

      Destination port

    • Changed property protocol (string)

      Protocol

    • Changed property bidirectional (boolean)

      Bidirectional

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  Changed items (object):

  • Changed property fabricName (string)

    Fabric name

  • Changed property name (string)

    Flow rule name

  • Changed property tenant (string)

    Tenant

  • Changed property vrf (string)

    Vrf

  • Changed property flowRuleAttributeList (array)

    list of flow rule attribute

    Changed items (object):

    • Added property operation (string)

      Flow rule operation

    • Changed property flowRuleAttributeUuid (string)

      Flow rule attribute uuid

    • Changed property subnet (string)

      Subnet flow rule attribute

    • Changed property srcIp (string)

      Source ip

    • Changed property srcPort (string)

      Source port

    • Changed property dstIp (string)

      Destination ip

    • Changed property dstPort (string)

      Destination port

    • Changed property protocol (string)

      Protocol

    • Changed property bidirectional (boolean)

      Bidirectional

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/flowSettings

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Added property siteName (string)

  • Added property accountId (string)

  • Added property siteGroupUuid (string)

  • Added property microBurstCloudSettings (object)

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/microBurstSettings

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Added property siteName (string)

  • Added property accountId (string)

  • Added property siteGroupUuid (string)

  • Added property microBurstCloudSettings (object)

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/status

Request:

Changed content type : */*

• Added property siteName (string)

• Added property siteGroupUuid (string)

• Added property microBurstCloudSettings (object)

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Added property siteName (string)

  • Added property accountId (string)

  • Added property siteGroupUuid (string)

  • Added property microBurstCloudSettings (object)

POST /insightsGroup/{igName}/fabric/{fabricName}/syslogSettings

Request:

Changed content type : */*

• Changed property fabricName (string)

  Fabric name

• Changed property name (string)

  Name

• Changed property securityMode (string)

  Systems settings security mode - Unsecured/Secured

• Changed property ipAddress (string)

  Ip address

• Changed property port (integer)

  Port

• Changed property facility (string)

  Facility

• Changed property transport (string)

  Transport protocol

• Changed property securedSslSettings (object)

  • Added property encryptedCaCert (string)

    Syslog encrypted ca cert

  • Changed property caCert (string)

    Syslog secured ca cert

• Changed property collectionSettings (object)

  • Changed property syslogSettings (object)

    • Changed property eventTypes (array)

      List of event types

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property fabricName (string)

    Fabric name

  • Changed property name (string)

    Name

  • Changed property securityMode (string)

    Systems settings security mode - Unsecured/Secured

  • Changed property ipAddress (string)

    Ip address

  • Changed property port (integer)

    Port

  • Changed property facility (string)

    Facility

  • Changed property transport (string)

    Transport protocol

  • Changed property securedSslSettings (object)

    • Added property encryptedCaCert (string)

      Syslog encrypted ca cert

    • Changed property caCert (string)

      Syslog secured ca cert

  • Changed property collectionSettings (object)

    • Changed property syslogSettings (object)

      • Changed property eventTypes (array)

        List of event types

DELETE /insightsGroup/{igName}/fabric/{fabricName}/syslogSettings/{Id}

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property fabricName (string)

    Fabric name

  • Changed property name (string)

    Name

  • Changed property securityMode (string)

    Systems settings security mode - Unsecured/Secured

  • Changed property ipAddress (string)

    Ip address

  • Changed property port (integer)

    Port

  • Changed property facility (string)

    Facility

  • Changed property transport (string)

    Transport protocol

  • Changed property securedSslSettings (object)

    • Added property encryptedCaCert (string)

      Syslog encrypted ca cert

    • Changed property caCert (string)

      Syslog secured ca cert

  • Changed property collectionSettings (object)

    • Changed property syslogSettings (object)

      • Changed property eventTypes (array)

        List of event types

GET /insightsGroup/{igName}/fabric/{fabricName}/syslogSettings/{id}

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property fabricName (string)

    Fabric name

  • Changed property name (string)

    Name

  • Changed property securityMode (string)

    Systems settings security mode - Unsecured/Secured

  • Changed property ipAddress (string)

    Ip address

  • Changed property port (integer)

    Port

  • Changed property facility (string)

    Facility

  • Changed property transport (string)

    Transport protocol

  • Changed property securedSslSettings (object)

    • Added property encryptedCaCert (string)

      Syslog encrypted ca cert

    • Changed property caCert (string)

      Syslog secured ca cert

  • Changed property collectionSettings (object)

    • Changed property syslogSettings (object)

      • Changed property eventTypes (array)

        List of event types

PUT /insightsGroup/{igName}/fabric/{fabricName}/syslogSettings/{updateId}

Request:

Changed content type : */*

• Changed property fabricName (string)

  Fabric name

• Changed property name (string)

  Name

• Changed property securityMode (string)

  Systems settings security mode - Unsecured/Secured

• Changed property ipAddress (string)

  Ip address

• Changed property port (integer)

  Port

• Changed property facility (string)

  Facility

• Changed property transport (string)

  Transport protocol

• Changed property securedSslSettings (object)

  • Added property encryptedCaCert (string)

    Syslog encrypted ca cert

  • Changed property caCert (string)

    Syslog secured ca cert

• Changed property collectionSettings (object)

  • Changed property syslogSettings (object)

    • Changed property eventTypes (array)

      List of event types

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property fabricName (string)

    Fabric name

  • Changed property name (string)

    Name

  • Changed property securityMode (string)

    Systems settings security mode - Unsecured/Secured

  • Changed property ipAddress (string)

    Ip address

  • Changed property port (integer)

    Port

  • Changed property facility (string)

    Facility

  • Changed property transport (string)

    Transport protocol

  • Changed property securedSslSettings (object)

    • Added property encryptedCaCert (string)

      Syslog encrypted ca cert

    • Changed property caCert (string)

      Syslog secured ca cert

  • Changed property collectionSettings (object)

    • Changed property syslogSettings (object)

      • Changed property eventTypes (array)

        List of event types

GET /insightsGroup/{igName}/syslogSettings

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  Changed items (object):

  • Changed property fabricName (string)

    Fabric name

  • Changed property name (string)

    Name

  • Changed property securityMode (string)

    Systems settings security mode - Unsecured/Secured

  • Changed property ipAddress (string)

    Ip address

  • Changed property port (integer)

    Port

  • Changed property facility (string)

    Facility

  • Changed property transport (string)

    Transport protocol

  • Changed property securedSslSettings (object)

    • Added property encryptedCaCert (string)

      Syslog encrypted ca cert

    • Changed property caCert (string)

      Syslog secured ca cert

  • Changed property collectionSettings (object)

    • Changed property syslogSettings (object)

      • Changed property eventTypes (array)

        List of event types

GET /syslogSettings

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  Changed items (object):

  • Changed property fabricName (string)

    Fabric name

  • Changed property name (string)

    Name

  • Changed property securityMode (string)

    Systems settings security mode - Unsecured/Secured

  • Changed property ipAddress (string)

    Ip address

  • Changed property port (integer)

    Port

  • Changed property facility (string)

    Facility

  • Changed property transport (string)

    Transport protocol

  • Changed property securedSslSettings (object)

    • Added property encryptedCaCert (string)

      Syslog encrypted ca cert

    • Changed property caCert (string)

      Syslog secured ca cert

  • Changed property collectionSettings (object)

    • Changed property syslogSettings (object)

      • Changed property eventTypes (array)

        List of event types

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/emailSettings

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  Changed items (object):

  • Added property activeOnly (boolean)

  • Changed property collectionSettings (object)

    • Changed property anomalySettings (object)

      • Changed property email (string)

        Email

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

          Added enum values:

          • ADC
          • APPLICATION
          • CHANGE_ANALYSIS
          • COMPLIANCE
          • CONNECTIVITY_ANALYSIS
          • FORWARDING
          • ORCHESTRATOR_ASSURANCE
          • SECURITY
          • SYSTEM
          • TOPOLOGY
          • VCENTER
          • VMM
          • UNKNOWN

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property advisoriesSettings (object)

      • Changed property email (string)

        Email

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property faultsSettings (object)

      • Changed property email (string)

        Email

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property auditLogsSettings (object)

      • Changed property email (string)

        Email

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property riskConformanceSettings (object)

      • Changed property email (string)

        Email

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/alertRules/matchCriterion/{uuid}

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property value (object)

    • Changed property data (array)

      Changed items (object):

      • Changed property uuid (string)

        Alert rule match criteria uuid

      • Changed property alertRuleId (string)

        Alert rule uuid

      • Changed property siteId (string)

        Site uuid

• Changed content type : application/xml

  • Changed property value (object)

    • Changed property data (array)

      Changed items (object):

      • Changed property uuid (string)

        Alert rule match criteria uuid

      • Changed property alertRuleId (string)

        Alert rule uuid

      • Changed property siteId (string)

        Site uuid

DELETE /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/alertRules/matchCriterion/{uuid}

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property value (object)

    • Changed property data (array)

      Changed items (object):

      • Changed property uuid (string)

        Alert rule match criteria uuid

      • Changed property alertRuleId (string)

        Alert rule uuid

      • Changed property siteId (string)

        Site uuid

• Changed content type : application/xml

  • Changed property value (object)

    • Changed property data (array)

      Changed items (object):

      • Changed property uuid (string)

        Alert rule match criteria uuid

      • Changed property alertRuleId (string)

        Alert rule uuid

      • Changed property siteId (string)

        Site uuid

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/alertRules/{uuid}/matchCriterion

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property value (object)

    • Changed property data (array)

      Changed items (object):

      • Changed property uuid (string)

        Alert rule match criteria uuid

      • Changed property alertRuleId (string)

        Alert rule uuid

      • Changed property siteId (string)

        Site uuid

• Changed content type : application/xml

  • Changed property value (object)

    • Changed property data (array)

      Changed items (object):

      • Changed property uuid (string)

        Alert rule match criteria uuid

      • Changed property alertRuleId (string)

        Alert rule uuid

      • Changed property siteId (string)

        Site uuid

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/emailSettings

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  Changed items (object):

  • Added property activeOnly (boolean)

  • Changed property collectionSettings (object)

    • Changed property anomalySettings (object)

      • Changed property email (string)

        Email

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

          Added enum values:

          • ADC
          • APPLICATION
          • CHANGE_ANALYSIS
          • COMPLIANCE
          • CONNECTIVITY_ANALYSIS
          • FORWARDING
          • ORCHESTRATOR_ASSURANCE
          • SECURITY
          • SYSTEM
          • TOPOLOGY
          • VCENTER
          • VMM
          • UNKNOWN

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property advisoriesSettings (object)

      • Changed property email (string)

        Email

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property faultsSettings (object)

      • Changed property email (string)

        Email

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property auditLogsSettings (object)

      • Changed property email (string)

        Email

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property riskConformanceSettings (object)

      • Changed property email (string)

        Email

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/emailSettings

Request:

Changed content type : */*

• Added property activeOnly (boolean)

• Changed property collectionSettings (object)

  • Changed property anomalySettings (object)

    • Changed property email (string)

      Email

    • Changed property categories (array)

      Changed items (object):

      • Changed property categoryName (string)

        Category name of export settings

        Added enum values:

        • ADC
        • APPLICATION
        • CHANGE_ANALYSIS
        • COMPLIANCE
        • CONNECTIVITY_ANALYSIS
        • FORWARDING
        • ORCHESTRATOR_ASSURANCE
        • SECURITY
        • SYSTEM
        • TOPOLOGY
        • VCENTER
        • VMM
        • UNKNOWN

      • Changed property eventTypes (array)

        List of event types in export settings

  • Changed property advisoriesSettings (object)

    • Changed property email (string)

      Email

    • Changed property categories (array)

      Changed items (object):

      • Changed property categoryName (string)

        Category name of export settings

      • Changed property eventTypes (array)

        List of event types in export settings

  • Changed property faultsSettings (object)

    • Changed property email (string)

      Email

    • Changed property categories (array)

      Changed items (object):

      • Changed property categoryName (string)

        Category name of export settings

      • Changed property eventTypes (array)

        List of event types in export settings

  • Changed property auditLogsSettings (object)

    • Changed property email (string)

      Email

    • Changed property categories (array)

      Changed items (object):

      • Changed property categoryName (string)

        Category name of export settings

      • Changed property eventTypes (array)

        List of event types in export settings

  • Changed property riskConformanceSettings (object)

    • Changed property email (string)

      Email

    • Changed property categories (array)

      Changed items (object):

      • Changed property categoryName (string)

        Category name of export settings

      • Changed property eventTypes (array)

        List of event types in export settings

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Added property activeOnly (boolean)

  • Changed property collectionSettings (object)

    • Changed property anomalySettings (object)

      • Changed property email (string)

        Email

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

          Added enum values:

          • ADC
          • APPLICATION
          • CHANGE_ANALYSIS
          • COMPLIANCE
          • CONNECTIVITY_ANALYSIS
          • FORWARDING
          • ORCHESTRATOR_ASSURANCE
          • SECURITY
          • SYSTEM
          • TOPOLOGY
          • VCENTER
          • VMM
          • UNKNOWN

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property advisoriesSettings (object)

      • Changed property email (string)

        Email

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property faultsSettings (object)

      • Changed property email (string)

        Email

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property auditLogsSettings (object)

      • Changed property email (string)

        Email

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property riskConformanceSettings (object)

      • Changed property email (string)

        Email

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/emailSettings/{id}

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property securedSslSettings (object)

    • Added property encryptedCaCert (string)

      Encrypted ca cert of secure ssl

    • Added property encryptedClientCert (string)

      Encrypted client cert of secured ssl

    • Added property encryptedClientKey (string)

      Encrypted client key

    • Changed property caCert (string)

      Ca cert of secured ssl

    • Changed property clientCert (string)

      Client cert

    • Changed property clientKey (string)

      Secure ssl client key

  • Changed property saslPlainSettings (object)

    • Added property encryptedPassword (string)

      Encrypted password of user

    • Changed property username (string)

      User name in ssl plain settings

    • Changed property password (string)

      Password of user

  • Changed property collectionSettings (object)

    • Changed property anomalySettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

          Added enum values:

          • ADC
          • APPLICATION
          • CHANGE_ANALYSIS
          • COMPLIANCE
          • CONNECTIVITY_ANALYSIS
          • FORWARDING
          • ORCHESTRATOR_ASSURANCE
          • SECURITY
          • SYSTEM
          • TOPOLOGY
          • VCENTER
          • VMM
          • UNKNOWN

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property advisoriesSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property faultsSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property auditLogsSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property statisticsSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

PUT /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/emailSettings/{id}

Request:

Changed content type : */*

• Added property activeOnly (boolean)

• Changed property collectionSettings (object)

  • Changed property anomalySettings (object)

    • Changed property email (string)

      Email

    • Changed property categories (array)

      Changed items (object):

      • Changed property categoryName (string)

        Category name of export settings

        Added enum values:

        • ADC
        • APPLICATION
        • CHANGE_ANALYSIS
        • COMPLIANCE
        • CONNECTIVITY_ANALYSIS
        • FORWARDING
        • ORCHESTRATOR_ASSURANCE
        • SECURITY
        • SYSTEM
        • TOPOLOGY
        • VCENTER
        • VMM
        • UNKNOWN

      • Changed property eventTypes (array)

        List of event types in export settings

  • Changed property advisoriesSettings (object)

    • Changed property email (string)

      Email

    • Changed property categories (array)

      Changed items (object):

      • Changed property categoryName (string)

        Category name of export settings

      • Changed property eventTypes (array)

        List of event types in export settings

  • Changed property faultsSettings (object)

    • Changed property email (string)

      Email

    • Changed property categories (array)

      Changed items (object):

      • Changed property categoryName (string)

        Category name of export settings

      • Changed property eventTypes (array)

        List of event types in export settings

  • Changed property auditLogsSettings (object)

    • Changed property email (string)

      Email

    • Changed property categories (array)

      Changed items (object):

      • Changed property categoryName (string)

        Category name of export settings

      • Changed property eventTypes (array)

        List of event types in export settings

  • Changed property riskConformanceSettings (object)

    • Changed property email (string)

      Email

    • Changed property categories (array)

      Changed items (object):

      • Changed property categoryName (string)

        Category name of export settings

      • Changed property eventTypes (array)

        List of event types in export settings

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Added property activeOnly (boolean)

  • Changed property collectionSettings (object)

    • Changed property anomalySettings (object)

      • Changed property email (string)

        Email

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

          Added enum values:

          • ADC
          • APPLICATION
          • CHANGE_ANALYSIS
          • COMPLIANCE
          • CONNECTIVITY_ANALYSIS
          • FORWARDING
          • ORCHESTRATOR_ASSURANCE
          • SECURITY
          • SYSTEM
          • TOPOLOGY
          • VCENTER
          • VMM
          • UNKNOWN

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property advisoriesSettings (object)

      • Changed property email (string)

        Email

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property faultsSettings (object)

      • Changed property email (string)

        Email

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property auditLogsSettings (object)

      • Changed property email (string)

        Email

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property riskConformanceSettings (object)

      • Changed property email (string)

        Email

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

DELETE /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/emailSettings/{id}

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Added property activeOnly (boolean)

  • Changed property collectionSettings (object)

    • Changed property anomalySettings (object)

      • Changed property email (string)

        Email

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

          Added enum values:

          • ADC
          • APPLICATION
          • CHANGE_ANALYSIS
          • COMPLIANCE
          • CONNECTIVITY_ANALYSIS
          • FORWARDING
          • ORCHESTRATOR_ASSURANCE
          • SECURITY
          • SYSTEM
          • TOPOLOGY
          • VCENTER
          • VMM
          • UNKNOWN

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property advisoriesSettings (object)

      • Changed property email (string)

        Email

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property faultsSettings (object)

      • Changed property email (string)

        Email

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property auditLogsSettings (object)

      • Changed property email (string)

        Email

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property riskConformanceSettings (object)

      • Changed property email (string)

        Email

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

DELETE /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/flowRules/batchDelete

Request:

Changed content type : */*

• Changed property flowRuleUuids (array)

  List of flow rule uuid

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/flowRules/{id}

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  Changed items (object):

  • Changed property fabricName (string)

    Fabric name

  • Changed property name (string)

    Flow rule name

  • Changed property tenant (string)

    Tenant

  • Changed property vrf (string)

    Vrf

  • Changed property flowRuleAttributeList (array)

    list of flow rule attribute

    Changed items (object):

    • Added property operation (string)

      Flow rule operation

    • Changed property flowRuleAttributeUuid (string)

      Flow rule attribute uuid

    • Changed property subnet (string)

      Subnet flow rule attribute

    • Changed property srcIp (string)

      Source ip

    • Changed property srcPort (string)

      Source port

    • Changed property dstIp (string)

      Destination ip

    • Changed property dstPort (string)

      Destination port

    • Changed property protocol (string)

      Protocol

    • Changed property bidirectional (boolean)

      Bidirectional

PUT /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/flowRules/{id}

Request:

Changed content type : */*

• Changed property flowRuleAttributeList (array)

  List of flow rule attribute

  Changed items (object):

  • Changed property flowRuleAttributeUuid (string)

    Flow rule attribute uuid

  • Changed property subnet (string)

    Subnet flow rule attribute

  • Changed property srcIp (string)

    Source ip

  • Changed property srcPort (string)

    Source port

  • Changed property dstIp (string)

    Destination ip

  • Changed property dstPort (string)

    Destination port

  • Changed property protocol (string)

    Protocol

  • Changed property bidirectional (boolean)

    Bidirectional

  • Changed property operation (string)

    Flow rule operation

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  Changed items (object):

  • Changed property flowRulesList (array)

    List of flow rules

    Changed items (object):

    • Changed property fabricName (string)

      Fabric name

    • Changed property name (string)

      Flow rule name

    • Changed property tenant (string)

      Tenant

    • Changed property vrf (string)

      Vrf

    • Changed property flowRuleAttributeList (array)

      list of flow rule attribute

      Changed items (object):

      • Added property operation (string)

        Flow rule operation

      • Changed property flowRuleAttributeUuid (string)

        Flow rule attribute uuid

      • Changed property subnet (string)

        Subnet flow rule attribute

      • Changed property srcIp (string)

        Source ip

      • Changed property srcPort (string)

        Source port

      • Changed property dstIp (string)

        Destination ip

      • Changed property dstPort (string)

        Destination port

      • Changed property protocol (string)

        Protocol

      • Changed property bidirectional (boolean)

        Bidirectional

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/kafkaSettings

Request:

Changed content type : */*

• Changed property securedSslSettings (object)

  • Added property encryptedCaCert (string)

    Encrypted ca cert of secure ssl

  • Added property encryptedClientCert (string)

    Encrypted client cert of secured ssl

  • Added property encryptedClientKey (string)

    Encrypted client key

  • Changed property caCert (string)

    Ca cert of secured ssl

  • Changed property clientCert (string)

    Client cert

  • Changed property clientKey (string)

    Secure ssl client key

• Changed property saslPlainSettings (object)

  • Added property encryptedPassword (string)

    Encrypted password of user

  • Changed property username (string)

    User name in ssl plain settings

  • Changed property password (string)

    Password of user

• Changed property collectionSettings (object)

  • Changed property anomalySettings (object)

    • Changed property categories (array)

      Changed items (object):

      • Changed property categoryName (string)

        Category name of export settings

        Added enum values:

        • ADC
        • APPLICATION
        • CHANGE_ANALYSIS
        • COMPLIANCE
        • CONNECTIVITY_ANALYSIS
        • FORWARDING
        • ORCHESTRATOR_ASSURANCE
        • SECURITY
        • SYSTEM
        • TOPOLOGY
        • VCENTER
        • VMM
        • UNKNOWN

      • Changed property eventTypes (array)

        List of event types in export settings

  • Changed property advisoriesSettings (object)

    • Changed property categories (array)

      Changed items (object):

      • Changed property categoryName (string)

        Category name of export settings

      • Changed property eventTypes (array)

        List of event types in export settings

  • Changed property faultsSettings (object)

    • Changed property categories (array)

      Changed items (object):

      • Changed property categoryName (string)

        Category name of export settings

      • Changed property eventTypes (array)

        List of event types in export settings

  • Changed property auditLogsSettings (object)

    • Changed property categories (array)

      Changed items (object):

      • Changed property categoryName (string)

        Category name of export settings

      • Changed property eventTypes (array)

        List of event types in export settings

  • Changed property statisticsSettings (object)

    • Changed property categories (array)

      Changed items (object):

      • Changed property categoryName (string)

        Category name of export settings

      • Changed property eventTypes (array)

        List of event types in export settings

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property securedSslSettings (object)

    • Added property encryptedCaCert (string)

      Encrypted ca cert of secure ssl

    • Added property encryptedClientCert (string)

      Encrypted client cert of secured ssl

    • Added property encryptedClientKey (string)

      Encrypted client key

    • Changed property caCert (string)

      Ca cert of secured ssl

    • Changed property clientCert (string)

      Client cert

    • Changed property clientKey (string)

      Secure ssl client key

  • Changed property saslPlainSettings (object)

    • Added property encryptedPassword (string)

      Encrypted password of user

    • Changed property username (string)

      User name in ssl plain settings

    • Changed property password (string)

      Password of user

  • Changed property collectionSettings (object)

    • Changed property anomalySettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

          Added enum values:

          • ADC
          • APPLICATION
          • CHANGE_ANALYSIS
          • COMPLIANCE
          • CONNECTIVITY_ANALYSIS
          • FORWARDING
          • ORCHESTRATOR_ASSURANCE
          • SECURITY
          • SYSTEM
          • TOPOLOGY
          • VCENTER
          • VMM
          • UNKNOWN

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property advisoriesSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property faultsSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property auditLogsSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property statisticsSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/kafkaSettings/{id}

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property securedSslSettings (object)

    • Added property encryptedCaCert (string)

      Encrypted ca cert of secure ssl

    • Added property encryptedClientCert (string)

      Encrypted client cert of secured ssl

    • Added property encryptedClientKey (string)

      Encrypted client key

    • Changed property caCert (string)

      Ca cert of secured ssl

    • Changed property clientCert (string)

      Client cert

    • Changed property clientKey (string)

      Secure ssl client key

  • Changed property saslPlainSettings (object)

    • Added property encryptedPassword (string)

      Encrypted password of user

    • Changed property username (string)

      User name in ssl plain settings

    • Changed property password (string)

      Password of user

  • Changed property collectionSettings (object)

    • Changed property anomalySettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

          Added enum values:

          • ADC
          • APPLICATION
          • CHANGE_ANALYSIS
          • COMPLIANCE
          • CONNECTIVITY_ANALYSIS
          • FORWARDING
          • ORCHESTRATOR_ASSURANCE
          • SECURITY
          • SYSTEM
          • TOPOLOGY
          • VCENTER
          • VMM
          • UNKNOWN

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property advisoriesSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property faultsSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property auditLogsSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property statisticsSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

PUT /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/kafkaSettings/{id}

Request:

Changed content type : */*

• Changed property securedSslSettings (object)

  • Added property encryptedCaCert (string)

    Encrypted ca cert of secure ssl

  • Added property encryptedClientCert (string)

    Encrypted client cert of secured ssl

  • Added property encryptedClientKey (string)

    Encrypted client key

  • Changed property caCert (string)

    Ca cert of secured ssl

  • Changed property clientCert (string)

    Client cert

  • Changed property clientKey (string)

    Secure ssl client key

• Changed property saslPlainSettings (object)

  • Added property encryptedPassword (string)

    Encrypted password of user

  • Changed property username (string)

    User name in ssl plain settings

  • Changed property password (string)

    Password of user

• Changed property collectionSettings (object)

  • Changed property anomalySettings (object)

    • Changed property categories (array)

      Changed items (object):

      • Changed property categoryName (string)

        Category name of export settings

        Added enum values:

        • ADC
        • APPLICATION
        • CHANGE_ANALYSIS
        • COMPLIANCE
        • CONNECTIVITY_ANALYSIS
        • FORWARDING
        • ORCHESTRATOR_ASSURANCE
        • SECURITY
        • SYSTEM
        • TOPOLOGY
        • VCENTER
        • VMM
        • UNKNOWN

      • Changed property eventTypes (array)

        List of event types in export settings

  • Changed property advisoriesSettings (object)

    • Changed property categories (array)

      Changed items (object):

      • Changed property categoryName (string)

        Category name of export settings

      • Changed property eventTypes (array)

        List of event types in export settings

  • Changed property faultsSettings (object)

    • Changed property categories (array)

      Changed items (object):

      • Changed property categoryName (string)

        Category name of export settings

      • Changed property eventTypes (array)

        List of event types in export settings

  • Changed property auditLogsSettings (object)

    • Changed property categories (array)

      Changed items (object):

      • Changed property categoryName (string)

        Category name of export settings

      • Changed property eventTypes (array)

        List of event types in export settings

  • Changed property statisticsSettings (object)

    • Changed property categories (array)

      Changed items (object):

      • Changed property categoryName (string)

        Category name of export settings

      • Changed property eventTypes (array)

        List of event types in export settings

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property securedSslSettings (object)

    • Added property encryptedCaCert (string)

      Encrypted ca cert of secure ssl

    • Added property encryptedClientCert (string)

      Encrypted client cert of secured ssl

    • Added property encryptedClientKey (string)

      Encrypted client key

    • Changed property caCert (string)

      Ca cert of secured ssl

    • Changed property clientCert (string)

      Client cert

    • Changed property clientKey (string)

      Secure ssl client key

  • Changed property saslPlainSettings (object)

    • Added property encryptedPassword (string)

      Encrypted password of user

    • Changed property username (string)

      User name in ssl plain settings

    • Changed property password (string)

      Password of user

  • Changed property collectionSettings (object)

    • Changed property anomalySettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

          Added enum values:

          • ADC
          • APPLICATION
          • CHANGE_ANALYSIS
          • COMPLIANCE
          • CONNECTIVITY_ANALYSIS
          • FORWARDING
          • ORCHESTRATOR_ASSURANCE
          • SECURITY
          • SYSTEM
          • TOPOLOGY
          • VCENTER
          • VMM
          • UNKNOWN

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property advisoriesSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property faultsSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property auditLogsSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property statisticsSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

DELETE /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/fabric/{fabricName}/kafkaSettings/{id}

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property securedSslSettings (object)

    • Added property encryptedCaCert (string)

      Encrypted ca cert of secure ssl

    • Added property encryptedClientCert (string)

      Encrypted client cert of secured ssl

    • Added property encryptedClientKey (string)

      Encrypted client key

    • Changed property caCert (string)

      Ca cert of secured ssl

    • Changed property clientCert (string)

      Client cert

    • Changed property clientKey (string)

      Secure ssl client key

  • Changed property saslPlainSettings (object)

    • Added property encryptedPassword (string)

      Encrypted password of user

    • Changed property username (string)

      User name in ssl plain settings

    • Changed property password (string)

      Password of user

  • Changed property collectionSettings (object)

    • Changed property anomalySettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

          Added enum values:

          • ADC
          • APPLICATION
          • CHANGE_ANALYSIS
          • COMPLIANCE
          • CONNECTIVITY_ANALYSIS
          • FORWARDING
          • ORCHESTRATOR_ASSURANCE
          • SECURITY
          • SYSTEM
          • TOPOLOGY
          • VCENTER
          • VMM
          • UNKNOWN

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property advisoriesSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property faultsSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property auditLogsSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property statisticsSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

PUT /insightsGroup/{igName}/integration/{name}

Request:

Changed content type : application/json

• Changed property associatedSites (array)

  Changed items (object):

  • Added property siteName (string)

  • Added property siteGroupUuid (string)

  • Added property microBurstCloudSettings (object)

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/kafkaSettings

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  Changed items (object):

  • Changed property securedSslSettings (object)

    • Added property encryptedCaCert (string)

      Encrypted ca cert of secure ssl

    • Added property encryptedClientCert (string)

      Encrypted client cert of secured ssl

    • Added property encryptedClientKey (string)

      Encrypted client key

    • Changed property caCert (string)

      Ca cert of secured ssl

    • Changed property clientCert (string)

      Client cert

    • Changed property clientKey (string)

      Secure ssl client key

  • Changed property saslPlainSettings (object)

    • Added property encryptedPassword (string)

      Encrypted password of user

    • Changed property username (string)

      User name in ssl plain settings

    • Changed property password (string)

      Password of user

  • Changed property collectionSettings (object)

    • Changed property anomalySettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

          Added enum values:

          • ADC
          • APPLICATION
          • CHANGE_ANALYSIS
          • COMPLIANCE
          • CONNECTIVITY_ANALYSIS
          • FORWARDING
          • ORCHESTRATOR_ASSURANCE
          • SECURITY
          • SYSTEM
          • TOPOLOGY
          • VCENTER
          • VMM
          • UNKNOWN

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property advisoriesSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property faultsSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property auditLogsSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property statisticsSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/kafkaSettings

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  Changed items (object):

  • Changed property securedSslSettings (object)

    • Added property encryptedCaCert (string)

      Encrypted ca cert of secure ssl

    • Added property encryptedClientCert (string)

      Encrypted client cert of secured ssl

    • Added property encryptedClientKey (string)

      Encrypted client key

    • Changed property caCert (string)

      Ca cert of secured ssl

    • Changed property clientCert (string)

      Client cert

    • Changed property clientKey (string)

      Secure ssl client key

  • Changed property saslPlainSettings (object)

    • Added property encryptedPassword (string)

      Encrypted password of user

    • Changed property username (string)

      User name in ssl plain settings

    • Changed property password (string)

      Password of user

  • Changed property collectionSettings (object)

    • Changed property anomalySettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

          Added enum values:

          • ADC
          • APPLICATION
          • CHANGE_ANALYSIS
          • COMPLIANCE
          • CONNECTIVITY_ANALYSIS
          • FORWARDING
          • ORCHESTRATOR_ASSURANCE
          • SECURITY
          • SYSTEM
          • TOPOLOGY
          • VCENTER
          • VMM
          • UNKNOWN

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property advisoriesSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property faultsSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property auditLogsSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

    • Changed property statisticsSettings (object)

      • Changed property categories (array)

        Changed items (object):

        • Changed property categoryName (string)

          Category name of export settings

        • Changed property eventTypes (array)

          List of event types in export settings

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/purge

Request:

Changed content type : application/json

• Added property jobID (string)

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/systemSettings/onboarding

Save Onboarding Status

Request:

Changed content type : */*

• Changed property status (string)

  Early access mode status

• Changed property statusLastModifiedTime (integer)

  Time when status was last modified

• Changed property onboardingCompleteLastModifiedTime (integer)

  Time when on-boarding completion was last modified

• Changed property complete (boolean)

  Completed on-boarding

Return Type:

New response : 400 Bad Request

Bad Request

New response : 500 Internal Server Error

Internal Server Error

New response : **default ** Changed response : 200 OK

Successful Operation

New header : Date

date

New header : Location

Save Onboarding status

• Changed content type : application/json

  • Added property status (string)

    Early access mode status

  • Added property statusLastModifiedTime (integer)

    Time when status was last modified

  • Added property onboardingCompleteLastModifiedTime (integer)

    Time when on-boarding completion was last modified

  • Added property complete (boolean)

    Completed on-boarding

  • Deleted property success (boolean)

  • Deleted property messages (array)

  • Deleted property value (object)

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/systemSettings/onboarding

Get Onboarding Status

Return Type:

New response : 400 Bad Request

Bad Request

New response : 500 Internal Server Error

Internal Server Error

New response : **default ** Changed response : 200 OK

Successful Operation

New header : Date

date

New header : Location

Get Onboarding status

• Changed content type : application/json

  • Changed property value (object)

    • Changed property data (object)

      • Changed property status (string)

        Early access mode status

      • Changed property statusLastModifiedTime (integer)

        Time when status was last modified

      • Changed property onboardingCompleteLastModifiedTime (integer)

        Time when on-boarding completion was last modified

      • Changed property complete (boolean)

        Completed on-boarding

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/userSettings

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property value (object)

    • Changed property data (object)

      • Changed property username (string)

        User name

      • Changed property disableWelcomeScreen (string)

        Disables the welcome screen

      • Changed property disableWelcomeScreenLastModifiedTime (integer)

        Time when disableWelcomeScreen was last modified

      • Changed property dashboards (string)

        User defined dashboards

      • Changed property dashboardsLastModifiedTime (integer)

        Time when dashboards were modified

      • Changed property bookmarks (string)

        User defined bookmarks

      • Changed property bookmarksLastModifiedTime (integer)

        Time when bookmarks field was last modified

      • Changed property prerequisitesAcked (boolean)

        Prerequisites acked

      • Changed property prerequisitesAckedLastModifiedTime (integer)

        Time when prerequisitesAcked field was last modified

      • Changed property mergeWithExistingSettings (boolean)

        Merge with existing settings

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/userSettings

Request:

Changed content type : application/json

• Changed property username (string)

  User name

• Changed property disableWelcomeScreen (string)

  Disables the welcome screen

• Changed property disableWelcomeScreenLastModifiedTime (integer)

  Time when disableWelcomeScreen was last modified

• Changed property dashboards (string)

  User defined dashboards

• Changed property dashboardsLastModifiedTime (integer)

  Time when dashboards were modified

• Changed property bookmarks (string)

  User defined bookmarks

• Changed property bookmarksLastModifiedTime (integer)

  Time when bookmarks field was last modified

• Changed property prerequisitesAcked (boolean)

  Prerequisites acked

• Changed property prerequisitesAckedLastModifiedTime (integer)

  Time when prerequisitesAcked field was last modified

• Changed property mergeWithExistingSettings (boolean)

  Merge with existing settings

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property value (object)

    • Changed property data (object)

      • Changed property username (string)

        User name

      • Changed property disableWelcomeScreen (string)

        Disables the welcome screen

      • Changed property disableWelcomeScreenLastModifiedTime (integer)

        Time when disableWelcomeScreen was last modified

      • Changed property dashboards (string)

        User defined dashboards

      • Changed property dashboardsLastModifiedTime (integer)

        Time when dashboards were modified

      • Changed property bookmarks (string)

        User defined bookmarks

      • Changed property bookmarksLastModifiedTime (integer)

        Time when bookmarks field was last modified

      • Changed property prerequisitesAcked (boolean)

        Prerequisites acked

      • Changed property prerequisitesAckedLastModifiedTime (integer)

        Time when prerequisitesAcked field was last modified

      • Changed property mergeWithExistingSettings (boolean)

        Merge with existing settings

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/userSettings/all

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property value (object)

    • Changed property data (array)

      Changed items (object):

      • Changed property username (string)

        User name

      • Changed property disableWelcomeScreen (string)

        Disables the welcome screen

      • Changed property disableWelcomeScreenLastModifiedTime (integer)

        Time when disableWelcomeScreen was last modified

      • Changed property dashboards (string)

        User defined dashboards

      • Changed property dashboardsLastModifiedTime (integer)

        Time when dashboards were modified

      • Changed property bookmarks (string)

        User defined bookmarks

      • Changed property bookmarksLastModifiedTime (integer)

        Time when bookmarks field was last modified

      • Changed property prerequisitesAcked (boolean)

        Prerequisites acked

      • Changed property prerequisitesAckedLastModifiedTime (integer)

        Time when prerequisitesAcked field was last modified

      • Changed property mergeWithExistingSettings (boolean)

        Merge with existing settings

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/userSettings/bookmarks

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property value (object)

    • Changed property data (object)

      • Changed property username (string)

        User name

      • Changed property disableWelcomeScreen (string)

        Disables the welcome screen

      • Changed property disableWelcomeScreenLastModifiedTime (integer)

        Time when disableWelcomeScreen was last modified

      • Changed property dashboards (string)

        User defined dashboards

      • Changed property dashboardsLastModifiedTime (integer)

        Time when dashboards were modified

      • Changed property bookmarks (string)

        User defined bookmarks

      • Changed property bookmarksLastModifiedTime (integer)

        Time when bookmarks field was last modified

      • Changed property prerequisitesAcked (boolean)

        Prerequisites acked

      • Changed property prerequisitesAckedLastModifiedTime (integer)

        Time when prerequisitesAcked field was last modified

      • Changed property mergeWithExistingSettings (boolean)

        Merge with existing settings

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/userSettings/bookmarks

Request:

Changed content type : application/json

• Changed property username (string)

  User name

• Changed property disableWelcomeScreen (string)

  Disables the welcome screen

• Changed property disableWelcomeScreenLastModifiedTime (integer)

  Time when disableWelcomeScreen was last modified

• Changed property dashboards (string)

  User defined dashboards

• Changed property dashboardsLastModifiedTime (integer)

  Time when dashboards were modified

• Changed property bookmarks (string)

  User defined bookmarks

• Changed property bookmarksLastModifiedTime (integer)

  Time when bookmarks field was last modified

• Changed property prerequisitesAcked (boolean)

  Prerequisites acked

• Changed property prerequisitesAckedLastModifiedTime (integer)

  Time when prerequisitesAcked field was last modified

• Changed property mergeWithExistingSettings (boolean)

  Merge with existing settings

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/userSettings/dashboards

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property value (object)

    • Changed property data (object)

      • Changed property username (string)

        User name

      • Changed property disableWelcomeScreen (string)

        Disables the welcome screen

      • Changed property disableWelcomeScreenLastModifiedTime (integer)

        Time when disableWelcomeScreen was last modified

      • Changed property dashboards (string)

        User defined dashboards

      • Changed property dashboardsLastModifiedTime (integer)

        Time when dashboards were modified

      • Changed property bookmarks (string)

        User defined bookmarks

      • Changed property bookmarksLastModifiedTime (integer)

        Time when bookmarks field was last modified

      • Changed property prerequisitesAcked (boolean)

        Prerequisites acked

      • Changed property prerequisitesAckedLastModifiedTime (integer)

        Time when prerequisitesAcked field was last modified

      • Changed property mergeWithExistingSettings (boolean)

        Merge with existing settings

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/userSettings/dashboards

Request:

Changed content type : application/json

• Changed property username (string)

  User name

• Changed property disableWelcomeScreen (string)

  Disables the welcome screen

• Changed property disableWelcomeScreenLastModifiedTime (integer)

  Time when disableWelcomeScreen was last modified

• Changed property dashboards (string)

  User defined dashboards

• Changed property dashboardsLastModifiedTime (integer)

  Time when dashboards were modified

• Changed property bookmarks (string)

  User defined bookmarks

• Changed property bookmarksLastModifiedTime (integer)

  Time when bookmarks field was last modified

• Changed property prerequisitesAcked (boolean)

  Prerequisites acked

• Changed property prerequisitesAckedLastModifiedTime (integer)

  Time when prerequisitesAcked field was last modified

• Changed property mergeWithExistingSettings (boolean)

  Merge with existing settings

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/alertRules

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property value (object)

    • Changed property data (array)

      Changed items (object):

      • Changed property name (string)

        Name of alert rule

      • Changed property description (string)

        Description of alert rule

      • Changed property state (boolean)

        State of alert rule

      • Changed property associatedInsightGroupUuids (array)

        List of associated insighGroup ids or siteGroup ids

      • Changed property lastModifiedTime (string)

        Time when alert rule was last modified

      • Changed property customizeAnomaly (object)

        • Changed property customMessage (string)

          Custom message of anomaly

      • Changed property alertRuleActions (array)

        List of alert rule actions

        Changed items (object):

        • Changed property action (string)

          Represents alert rule

        • Changed property applyToActiveAnomaly (boolean)

          Alert rule set to active anomaly

      • Changed property alertRuleMatchCriteria (array)

        Alert rule match criteria

        Changed items (object):

        • Changed property uuid (string)

          Alert rule match criteria uuid

        • Changed property alertRuleId (string)

          Alert rule uuid

        • Changed property siteId (string)

          Site uuid

• Changed content type : application/xml

  • Changed property value (object)

    • Changed property data (array)

      Changed items (object):

      • Changed property name (string)

        Name of alert rule

      • Changed property description (string)

        Description of alert rule

      • Changed property state (boolean)

        State of alert rule

      • Changed property associatedInsightGroupUuids (array)

        List of associated insighGroup ids or siteGroup ids

      • Changed property lastModifiedTime (string)

        Time when alert rule was last modified

      • Changed property customizeAnomaly (object)

        • Changed property customMessage (string)

          Custom message of anomaly

      • Changed property alertRuleActions (array)

        List of alert rule actions

        Changed items (object):

        • Changed property action (string)

          Represents alert rule

        • Changed property applyToActiveAnomaly (boolean)

          Alert rule set to active anomaly

      • Changed property alertRuleMatchCriteria (array)

        Alert rule match criteria

        Changed items (object):

        • Changed property uuid (string)

          Alert rule match criteria uuid

        • Changed property alertRuleId (string)

          Alert rule uuid

        • Changed property siteId (string)

          Site uuid

GET /collectionSettings/integrations/{integrationUuid}

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property value (object)

    • Changed property data (object)

      • Changed property collectionEntities (array)

        Changed items (object):

        • Changed property leafEntityList (array)

          Changed items (object):

          • Added property nodeId (integer)

          • Added property nodeRole (string)

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/collectionSettings/{assuranceEntityUuid}

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property value (object)

    • Changed property data (object)

      • Changed property collectionEntities (array)

        Changed items (object):

        • Changed property leafEntityList (array)

          Changed items (object):

          • Added property nodeId (integer)

          • Added property nodeRole (string)

GET /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/alertRules

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property value (object)

    • Changed property data (array)

      Changed items (object):

      • Changed property name (string)

        Name of alert rule

      • Changed property description (string)

        Description of alert rule

      • Changed property state (boolean)

        State of alert rule

      • Changed property associatedInsightGroupUuids (array)

        List of associated insighGroup ids or siteGroup ids

      • Changed property lastModifiedTime (string)

        Time when alert rule was last modified

      • Changed property customizeAnomaly (object)

        • Changed property customMessage (string)

          Custom message of anomaly

      • Changed property alertRuleActions (array)

        List of alert rule actions

        Changed items (object):

        • Changed property action (string)

          Represents alert rule

        • Changed property applyToActiveAnomaly (boolean)

          Alert rule set to active anomaly

      • Changed property alertRuleMatchCriteria (array)

        Alert rule match criteria

        Changed items (object):

        • Changed property uuid (string)

          Alert rule match criteria uuid

        • Changed property alertRuleId (string)

          Alert rule uuid

        • Changed property siteId (string)

          Site uuid

• Changed content type : application/xml

  • Changed property value (object)

    • Changed property data (array)

      Changed items (object):

      • Changed property name (string)

        Name of alert rule

      • Changed property description (string)

        Description of alert rule

      • Changed property state (boolean)

        State of alert rule

      • Changed property associatedInsightGroupUuids (array)

        List of associated insighGroup ids or siteGroup ids

      • Changed property lastModifiedTime (string)

        Time when alert rule was last modified

      • Changed property customizeAnomaly (object)

        • Changed property customMessage (string)

          Custom message of anomaly

      • Changed property alertRuleActions (array)

        List of alert rule actions

        Changed items (object):

        • Changed property action (string)

          Represents alert rule

        • Changed property applyToActiveAnomaly (boolean)

          Alert rule set to active anomaly

      • Changed property alertRuleMatchCriteria (array)

        Alert rule match criteria

        Changed items (object):

        • Changed property uuid (string)

          Alert rule match criteria uuid

        • Changed property alertRuleId (string)

          Alert rule uuid

        • Changed property siteId (string)

          Site uuid

POST /sedgeapi/v1/cisco-nir/api/api/telemetry/v2/config/insightsGroup/{igName}/alertRules

Request:

Changed content type : application/json

• Changed property name (string)

  Name of alert rule

• Changed property description (string)

  Description of alert rule

• Changed property state (boolean)

  State of alert rule

• Changed property associatedInsightGroupUuids (array)

  List of associated insighGroup ids or siteGroup ids

• Changed property lastModifiedTime (string)

  Time when alert rule was last modified

• Changed property customizeAnomaly (object)

  • Changed property customMessage (string)

    Custom message of anomaly

• Changed property alertRuleActions (array)

  List of alert rule actions

  Changed items (object):

  • Changed property action (string)

    Represents alert rule

  • Changed property applyToActiveAnomaly (boolean)

    Alert rule set to active anomaly

• Changed property alertRuleMatchCriteria (array)

  Alert rule match criteria

  Changed items (object):

  • Changed property uuid (string)

    Alert rule match criteria uuid

  • Changed property alertRuleId (string)

    Alert rule uuid

  • Changed property siteId (string)

    Site uuid

Changed content type : application/xml

• Changed property name (string)

  Name of alert rule

• Changed property description (string)

  Description of alert rule

• Changed property state (boolean)

  State of alert rule

• Changed property associatedInsightGroupUuids (array)

  List of associated insighGroup ids or siteGroup ids

• Changed property lastModifiedTime (string)

  Time when alert rule was last modified

• Changed property customizeAnomaly (object)

  • Changed property customMessage (string)

    Custom message of anomaly

• Changed property alertRuleActions (array)

  List of alert rule actions

  Changed items (object):

  • Changed property action (string)

    Represents alert rule

  • Changed property applyToActiveAnomaly (boolean)

    Alert rule set to active anomaly

• Changed property alertRuleMatchCriteria (array)

  Alert rule match criteria

  Changed items (object):

  • Changed property uuid (string)

    Alert rule match criteria uuid

  • Changed property alertRuleId (string)

    Alert rule uuid

  • Changed property siteId (string)

    Site uuid

Return Type:

Changed response : 200 OK

successful operation

• Changed content type : application/json

  • Changed property value (object)

    • Changed property data (array)

      Changed items (object):

      • Changed property name (string)

        Name of alert rule

      • Changed property description (string)

        Description of alert rule

      • Changed property state (boolean)

        State of alert rule

      • Changed property associatedInsightGroupUuids (array)

        List of associated insighGroup ids or siteGroup ids

      • Changed property lastModifiedTime (string)

        Time when alert rule was last modified

      • Changed property customizeAnomaly (object)

        • Changed property customMessage (string)

          Custom message of anomaly

      • Changed property alertRuleActions (array)

        List of alert rule actions

        Changed items (object):

        • Changed property action (string)

          Represents alert rule

        • Changed property applyToActiveAnomaly (boolean)

          Alert rule set to active anomaly

      • Changed property alertRuleMatchCriteria (array)

        Alert rule match criteria

        Changed items (object):

        • Changed property uuid (string)

          Alert rule match criteria uuid

        • Changed property alertRuleId (string)

          Alert rule uuid

        • Changed property siteId (string)

          Site uuid

• Changed content type : application/xml

  • Changed property value (object)

    • Changed property data (array)

      Changed items (object):

      • Changed property name (string)

        Name of alert rule

      • Changed property description (string)

        Description of alert rule

      • Changed property state (boolean)

        State of alert rule

      • Changed property associatedInsightGroupUuids (array)

        List of associated insighGroup ids or siteGroup ids

      • Changed property lastModifiedTime (string)

        Time when alert rule was last modified

      • Changed property customizeAnomaly (object)

        • Changed property customMessage (string)

          Custom message of anomaly

      • Changed property alertRuleActions (array)

        List of alert rule actions

        Changed items (object):

        • Changed property action (string)

          Represents alert rule

        • Changed property applyToActiveAnomaly (boolean)

          Alert rule set to active anomaly

      • Changed property alertRuleMatchCriteria (array)

        Alert rule match criteria

        Changed items (object):

        • Changed property uuid (string)

          Alert rule match criteria uuid

        • Changed property alertRuleId (string)

          Alert rule uuid

        • Changed property siteId (string)

          Site uuid