@itentialopensource/adapter-cisco_prime
Version:
This adapter integrates with system described as: cisco prime
1,740 lines (1,551 loc) • 813 kB
YAML
openapi: 3.0.0
info:
title: https://developer.cisco.com
contact: {}
version: '1.0.0'
servers:
- url: https://{defaultHost}
variables:
defaultHost:
default: www.example.com
paths:
/webacs/api/v4/op/aaa/tacacsPlusServer:
delete:
summary: >-
DELETE Delete Server
DELETE op/aaa/tacacsPlusServer
description: >-
DELETE Delete Server
DELETE op/aaa/tacacsPlusServer
operationId: >-
DELETEDeleteServer
DELETEop/aaa/tacacsPlusServer
parameters:
- name: serverIp
in: query
description: IP address of the TACACS+ server to be deleted. Either serverHostName of serverIp must be specified.
style: form
explode: true
schema:
type: string
- name: serverHostName
in: query
description: Host name of the TACACS+ server to be deleted. Either serverHostName of serverIp must be specified.
style: form
explode: true
schema:
type: string
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpAaaTacacsPlusServerResponse'
deprecated: false
get:
summary: >-
GET List Servers
GET op/aaa/tacacsPlusServer
description: >-
GET List Servers
GET op/aaa/tacacsPlusServer
operationId: >-
GETListServers
GETop/aaa/tacacsPlusServer
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpAaaTacacsPlusServerResponse1'
deprecated: false
post:
summary: >-
POST Add Server
POST op/aaa/tacacsPlusServer
description: >-
POST Add Server
POST op/aaa/tacacsPlusServer
operationId: >-
POSTAddServer
POSTop/aaa/tacacsPlusServer
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpAaaTacacsPlusServerRequest'
required: false
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpAaaTacacsPlusServerResponse2'
deprecated: false
put:
summary: >-
PUT Update Server
PUT op/aaa/tacacsPlusServer
description: >-
PUT Update Server
PUT op/aaa/tacacsPlusServer
operationId: >-
PUTUpdateServer
PUTop/aaa/tacacsPlusServer
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpAaaTacacsPlusServerRequest'
required: false
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpAaaTacacsPlusServerResponse2'
deprecated: false
/webacs/api/v4/data/ApOnboardingProfile:
get:
summary: >-
GET Get AP onboarding profiles
GET data/ApOnboardingProfile
description: >-
GET Get AP onboarding profiles
GET data/ApOnboardingProfile
operationId: >-
GETGetAPonboardingprofiles
GETdata/ApOnboardingProfile
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4DataApOnboardingProfileResponse'
deprecated: false
/webacs/api/v4/op/apOnboarding/profile:
delete:
summary: >-
DELETE Delete AP onboarding profiles
DELETE op/apOnboarding/profile
description: >-
DELETE Delete AP onboarding profiles
DELETE op/apOnboarding/profile
operationId: >-
DELETEDeleteAPonboardingprofiles
DELETEop/apOnboarding/profile
parameters:
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
enum:
- application/json
type: string
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpApOnboardingProfileResponse'
deprecated: false
post:
summary: >-
POST Create AP onboarding profiles
POST op/apOnboarding/profile
description: >-
POST Create AP onboarding profiles
POST op/apOnboarding/profile
operationId: >-
POSTCreateAPonboardingprofiles
POSTop/apOnboarding/profile
parameters:
- name: overrideOption
in: query
description: verride existing profiles
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpApOnboardingProfileResponse1'
deprecated: false
put:
summary: >-
PUT Modify AP onboarding profile
PUT op/apOnboarding/profile
description: >-
PUT Modify AP onboarding profile
PUT op/apOnboarding/profile
operationId: >-
PUTModifyAPonboardingprofile
PUTop/apOnboarding/profile
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpApOnboardingProfileResponse2'
deprecated: false
/webacs/api/v4/data/ApiHealthRecords:
get:
summary: >-
GET API Health Record
GET data/ApiHealthRecords
description: >-
GET API Health Record
GET data/ApiHealthRecords
operationId: >-
GETAPIHealthRecord
GETdata/ApiHealthRecords
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4DataApiHealthRecordsResponse'
deprecated: false
/webacs/api/v4/data/ApiResponseTimeSummary:
get:
summary: >-
GET API Response Time Summary
GET data/ApiResponseTimeSummary
description: >-
GET API Response Time Summary
GET data/ApiResponseTimeSummary
operationId: >-
GETAPIResponseTimeSummary
GETdata/ApiResponseTimeSummary
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4DataApiResponseTimeSummaryResponse'
deprecated: false
/webacs/api/v4/op/apiHealth/callsPerClient:
get:
summary: >-
GET API Calls Per Client
GET op/apiHealth/callsPerClient
description: >-
GET API Calls Per Client
GET op/apiHealth/callsPerClient
operationId: >-
GETAPICallsPerClient
GETop/apiHealth/callsPerClient
parameters:
- name: service
in: query
description: The service path. If unspecified, data will be returned for all services.
style: form
explode: true
schema:
type: string
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpApiHealthCallsPerClientResponse'
deprecated: false
/webacs/api/v4/op/apiHealth/requestCountTrend:
get:
summary: >-
GET API Request Count Trend
GET op/apiHealth/requestCountTrend
description: >-
GET API Request Count Trend
GET op/apiHealth/requestCountTrend
operationId: >-
GETAPIRequestCountTrend
GETop/apiHealth/requestCountTrend
parameters:
- name: service
in: query
description: The service path. If unspecified, data will be returned for all services.
style: form
explode: true
schema:
type: string
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpApiHealthRequestCountTrendResponse'
deprecated: false
/webacs/api/v4/op/apiHealth/responseTimeTrend:
get:
summary: >-
GET API Response Time Trend
GET op/apiHealth/responseTimeTrend
description: >-
GET API Response Time Trend
GET op/apiHealth/responseTimeTrend
operationId: >-
GETAPIResponseTimeTrend
GETop/apiHealth/responseTimeTrend
parameters:
- name: service
in: query
description: The service path. If unspecified, data will be returned for all services.
style: form
explode: true
schema:
type: string
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpApiHealthResponseTimeTrendResponse'
deprecated: false
/webacs/api/v4/op/apiHealth/serviceNameList:
get:
summary: >-
GET API Service Name List
GET op/apiHealth/serviceNameList
description: >-
GET API Service Name List
GET op/apiHealth/serviceNameList
operationId: >-
GETAPIServiceNameList
GETop/apiHealth/serviceNameList
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpApiHealthServiceNameListResponse'
deprecated: false
/webacs/api/v4/op/apService/rxNeighbors:
get:
summary: >-
GET Get Rx Neighbors
GET op/apService/rxNeighbors
description: >-
GET Get Rx Neighbors
GET op/apService/rxNeighbors
operationId: >-
GETGetRxNeighbors
GETop/apService/rxNeighbors
parameters:
- name: apId
in: query
description: RequiredId of an access point to get Rx Neighbors.
required: true
style: form
explode: true
schema:
type: number
format: double
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpApServiceRxNeighborsResponse'
deprecated: false
/webacs/api/v4/op/apService/deleteById:
put:
summary: >-
PUT Delete Access Points By IDs
PUT op/apService/deleteById
description: >-
PUT Delete Access Points By IDs
PUT op/apService/deleteById
operationId: >-
PUTDeleteAccessPointsByIDs
PUTop/apService/deleteById
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpApServiceDeleteByIdRequest'
required: false
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpApServiceDeleteByIdResponse'
deprecated: false
/webacs/api/v4/op/apService/deleteAp:
put:
summary: >-
PUT Delete Access Points By Names
PUT op/apService/deleteAp
description: >-
PUT Delete Access Points By Names
PUT op/apService/deleteAp
operationId: >-
PUTDeleteAccessPointsByNames
PUTop/apService/deleteAp
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpApServiceDeleteApRequest'
required: false
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpApServiceDeleteApResponse'
deprecated: false
/webacs/api/v4/op/apService/accessPoint:
put:
summary: >-
PUT Modify Unified Access Point
PUT op/apService/accessPoint
description: >-
PUT Modify Unified Access Point
PUT op/apService/accessPoint
operationId: >-
PUTModifyUnifiedAccessPoint
PUTop/apService/accessPoint
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpApServiceAccessPointRequest'
required: false
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpApServiceAccessPointResponse'
deprecated: false
/webacs/api/v4/op/rogueAp/classification:
put:
summary: >-
PUT Set Classification Type And Rogue State
PUT op/rogueAp/classification
description: >-
PUT Set Classification Type And Rogue State
PUT op/rogueAp/classification
operationId: >-
PUTSetClassificationTypeAndRogueState
PUTop/rogueAp/classification
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpRogueApClassificationResponse'
deprecated: false
/webacs/api/v4/op/alarms/acknowledge:
put:
summary: >-
PUT Acknowledges Alarms
PUT op/alarms/acknowledge
description: >-
PUT Acknowledges Alarms
PUT op/alarms/acknowledge
operationId: >-
PUTAcknowledgesAlarms
PUTop/alarms/acknowledge
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpAlarmsAcknowledgeResponse'
deprecated: false
/webacs/api/v4/op/alarms/annotate:
put:
summary: >-
PUT Annotates Alarms
PUT op/alarms/annotate
description: >-
PUT Annotates Alarms
PUT op/alarms/annotate
operationId: >-
PUTAnnotatesAlarms
PUTop/alarms/annotate
parameters:
- name: note
in: query
description: Annotation note
style: form
explode: true
schema:
type: string
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpAlarmsAnnotateResponse'
deprecated: false
/webacs/api/v4/op/alarms/clear:
put:
summary: >-
PUT Clears Alarms
PUT op/alarms/clear
description: >-
PUT Clears Alarms
PUT op/alarms/clear
operationId: >-
PUTClearsAlarms
PUTop/alarms/clear
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpAlarmsClearResponse'
deprecated: false
/webacs/api/v4/op/alarms/clearByEventType:
put:
summary: >-
PUT Clears Alarms with provided event type
PUT op/alarms/clearByEventType
description: >-
PUT Clears Alarms with provided event type
PUT op/alarms/clearByEventType
operationId: >-
PUTClearsAlarmswithprovidedeventtype
PUTop/alarms/clearByEventType
parameters:
- name: setSeverityToInfo
in: query
description: True if need to set alarm severity to Info once it's cleared. False by default
style: form
explode: true
schema:
type: boolean
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpAlarmsClearByEventTypeResponse'
deprecated: false
/webacs/api/v4/op/alarms/unacknowledge:
put:
summary: >-
PUT Unacknowledges Alarms
PUT op/alarms/unacknowledge
description: >-
PUT Unacknowledges Alarms
PUT op/alarms/unacknowledge
operationId: >-
PUTUnacknowledgesAlarms
PUTop/alarms/unacknowledge
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpAlarmsUnacknowledgeResponse'
deprecated: false
/webacs/api/v4/data/Applications:
get:
summary: >-
GET Predefined and User-defined Applications
GET data/Applications
description: >-
GET Predefined and User-defined Applications
GET data/Applications
operationId: >-
GETPredefinedandUser-definedApplications
GETdata/Applications
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4DataApplicationsResponse'
deprecated: false
/webacs/api/v4/data/CliTemplate:
get:
summary: >-
GET CLI Configuration Templates
GET data/CliTemplate
description: >-
GET CLI Configuration Templates
GET data/CliTemplate
operationId: >-
GETCLIConfigurationTemplates
GETdata/CliTemplate
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4DataCliTemplateResponse'
deprecated: false
/webacs/api/v4/op/cliTemplateConfiguration/deleteTemplate:
delete:
summary: >-
DELETE Delete Configuration Template
DELETE op/cliTemplateConfiguration/deleteTemplate
description: >-
DELETE Delete Configuration Template
DELETE op/cliTemplateConfiguration/deleteTemplate
operationId: >-
DELETEDeleteConfigurationTemplate
DELETEop/cliTemplateConfiguration/deleteTemplate
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpCliTemplateConfigurationDeleteTemplateResponse'
deprecated: false
/webacs/api/v4/op/cliTemplateConfiguration/folder:
delete:
summary: >-
DELETE Delete Configuration Template Folder
DELETE op/cliTemplateConfiguration/folder
description: >-
DELETE Delete Configuration Template Folder
DELETE op/cliTemplateConfiguration/folder
operationId: >-
DELETEDeleteConfigurationTemplateFolder
DELETEop/cliTemplateConfiguration/folder
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpCliTemplateConfigurationFolderResponse'
deprecated: false
get:
summary: >-
GET List Configuration Template Folders
GET op/cliTemplateConfiguration/folder
description: >-
GET List Configuration Template Folders
GET op/cliTemplateConfiguration/folder
operationId: >-
GETListConfigurationTemplateFolders
GETop/cliTemplateConfiguration/folder
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpCliTemplateConfigurationFolderResponse1'
deprecated: false
/webacs/api/v4/op/cliTemplateConfiguration/deviceTypes:
get:
summary: >-
GET List Device Types
GET op/cliTemplateConfiguration/deviceTypes
description: >-
GET List Device Types
GET op/cliTemplateConfiguration/deviceTypes
operationId: >-
GETListDeviceTypes
GETop/cliTemplateConfiguration/deviceTypes
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpCliTemplateConfigurationDeviceTypesResponse'
deprecated: false
post:
summary: >-
POST Create Configuration Template Folder
POST op/cliTemplateConfiguration/folder
description: >-
POST Create Configuration Template Folder
POST op/cliTemplateConfiguration/folder
operationId: >-
POSTCreateConfigurationTemplateFolder
POSTop/cliTemplateConfiguration/folder
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpCliTemplateConfigurationDeviceTypesResponse1'
deprecated: false
/webacs/api/v4/op/cliTemplateConfiguration/upload:
post:
summary: >-
POST Upload Configuration Template
POST op/cliTemplateConfiguration/upload
description: >-
POST Upload Configuration Template
POST op/cliTemplateConfiguration/upload
operationId: >-
POSTUploadConfigurationTemplate
POSTop/cliTemplateConfiguration/upload
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpCliTemplateConfigurationUploadResponse'
deprecated: false
/webacs/api/v4/op/cliTemplateConfiguration/deployTemplateThroughJob:
put:
summary: >-
PUT Deploy Configuration Template Through Job
PUT op/cliTemplateConfiguration/deployTemplateThroughJob
description: >-
PUT Deploy Configuration Template Through Job
PUT op/cliTemplateConfiguration/deployTemplateThroughJob
operationId: >-
PUTDeployConfigurationTemplateThroughJob
PUTop/cliTemplateConfiguration/deployTemplateThroughJob
parameters:
- name: startTime
in: query
description: The time when the CLI template will be deployed. If the start time is not defined the deployment will start immediately. The start time should be provided in the ISO 8601 format.
style: form
explode: true
schema:
type: number
format: double
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpCliTemplateConfigurationDeployTemplateThroughJobResponse'
deprecated: false
/webacs/api/v4/op/cliTemplateConfiguration/template:
put:
summary: >-
PUT Modify Configuration Template Content
PUT op/cliTemplateConfiguration/template
description: >-
PUT Modify Configuration Template Content
PUT op/cliTemplateConfiguration/template
operationId: >-
PUTModifyConfigurationTemplateContent
PUTop/cliTemplateConfiguration/template
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpCliTemplateConfigurationTemplateResponse'
deprecated: false
/webacs/api/v4/data/ClientCounts:
get:
summary: >-
GET Client Counts
GET data/ClientCounts
description: >-
GET Client Counts
GET data/ClientCounts
operationId: >-
GETClientCounts
GETdata/ClientCounts
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4DataClientCountsResponse'
deprecated: false
/webacs/api/v4/data/ClientSessions:
get:
summary: >-
GET Client Sessions
GET data/ClientSessions
description: >-
GET Client Sessions
GET data/ClientSessions
operationId: >-
GETClientSessions
GETdata/ClientSessions
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4DataClientSessionsResponse'
deprecated: false
/webacs/api/v4/data/ClientTraffics:
get:
summary: >-
GET Client Traffic Information
GET data/ClientTraffics
description: >-
GET Client Traffic Information
GET data/ClientTraffics
operationId: >-
GETClientTrafficInformation
GETdata/ClientTraffics
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4DataClientTrafficsResponse'
deprecated: false
/webacs/api/v4/data/HistoricalClientCounts:
get:
summary: >-
GET Historical Client Counts
GET data/HistoricalClientCounts
description: >-
GET Historical Client Counts
GET data/HistoricalClientCounts
operationId: >-
GETHistoricalClientCounts
GETdata/HistoricalClientCounts
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4DataHistoricalClientCountsResponse'
deprecated: false
/webacs/api/v4/data/HistoricalClientTraffics:
get:
summary: >-
GET Historical Client Traffic Information
GET data/HistoricalClientTraffics
description: >-
GET Historical Client Traffic Information
GET data/HistoricalClientTraffics
operationId: >-
GETHistoricalClientTrafficInformation
GETdata/HistoricalClientTraffics
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4DataHistoricalClientTrafficsResponse'
deprecated: false
/webacs/api/v4/op/compliance/check:
get:
summary: >-
GET Checks status of Check Job
GET op/compliance/check
description: >-
GET Checks status of Check Job
GET op/compliance/check
operationId: >-
GETChecksstatusofCheckJob
GETop/compliance/check
parameters:
- name: jobName
in: query
description: RequiredName of check compliance job
required: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpComplianceCheckResponse'
deprecated: false
/webacs/api/v4/op/compliance/policy:
post:
summary: >-
POST Add policy
POST op/compliance/policy
description: >-
POST Add policy
POST op/compliance/policy
operationId: >-
POSTAddpolicy
POSTop/compliance/policy
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpCompliancePolicyRequest'
required: false
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpCompliancePolicyResponse'
deprecated: false
/webacs/api/v4/op/compliance/profile:
post:
summary: >-
POST Add profile
POST op/compliance/profile
description: >-
POST Add profile
POST op/compliance/profile
operationId: >-
POSTAddprofile
POSTop/compliance/profile
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpComplianceProfileRequest'
required: false
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpComplianceProfileResponse'
deprecated: false
/webacs/api/v4/op/compliance/policy/import:
post:
summary: >-
POST Import policy
POST op/compliance/policy/import
description: >-
POST Import policy
POST op/compliance/policy/import
operationId: >-
POSTImportpolicy
POSTop/compliance/policy/import
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpCompliancePolicyImportRequest'
required: false
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpCompliancePolicyImportResponse'
deprecated: false
/webacs/api/v4/op/compliance/run:
post:
summary: >-
POST Schedule a Check Job
POST op/compliance/run
description: >-
POST Schedule a Check Job
POST op/compliance/run
operationId: >-
POSTScheduleaCheckJob
POSTop/compliance/run
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpComplianceRunRequest'
required: false
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpComplianceRunResponse'
deprecated: false
/webacs/api/v4/data/BulkSanitizedConfigArchives:
get:
summary: >-
GET Bulk export sanitized configuration archives
GET data/BulkSanitizedConfigArchives
description: >-
GET Bulk export sanitized configuration archives
GET data/BulkSanitizedConfigArchives
operationId: >-
GETBulkexportsanitizedconfigurationarchives
GETdata/BulkSanitizedConfigArchives
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4DataBulkSanitizedConfigArchivesResponse'
deprecated: false
/webacs/api/v4/data/BulkUnsanitizedConfigArchives:
get:
summary: >-
GET Bulk export unsanitized configuration archives
GET data/BulkUnsanitizedConfigArchives
description: >-
GET Bulk export unsanitized configuration archives
GET data/BulkUnsanitizedConfigArchives
operationId: >-
GETBulkexportunsanitizedconfigurationarchives
GETdata/BulkUnsanitizedConfigArchives
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4DataBulkUnsanitizedConfigArchivesResponse'
deprecated: false
/webacs/api/v4/data/ConfigArchives:
get:
summary: >-
GET Configuration archive list
GET data/ConfigArchives
description: >-
GET Configuration archive list
GET data/ConfigArchives
operationId: >-
GETConfigurationarchivelist
GETdata/ConfigArchives
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4DataConfigArchivesResponse'
deprecated: false
/webacs/api/v4/data/ConfigVersions:
get:
summary: >-
GET Configuration versions and files list
GET data/ConfigVersions
description: >-
GET Configuration versions and files list
GET data/ConfigVersions
operationId: >-
GETConfigurationversionsandfileslist
GETdata/ConfigVersions
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4DataConfigVersionsResponse'
deprecated: false
/webacs/api/v4/op/configArchiveService/configDiff/{device}:
get:
summary: >-
GET Configuration Diff
GET op/configArchiveService/configDiff/{device}
description: >-
GET Configuration Diff
GET op/configArchiveService/configDiff/{device}
operationId: >-
GETConfigurationDiff
GETop/configArchiveService/configDiff/{device}
parameters:
- name: device
in: path
description: RequiredThe device name or the management address of the device. The management address is the address used to add the device to the managed inventory, either an IP address or hostname.
required: true
style: simple
schema:
type: string
- name: timeStamp
in: query
description: mestamp in UTC milliseconds. When provided, API computes any diff from provided timeStamp till latest.
style: form
explode: true
schema:
type: number
format: double
- name: diffType
in: query
description: Config Archive Diff Type (Processed/Unprocessed). Unprocessed is raw diff.
style: form
explode: true
schema:
type: string
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpConfigArchiveServiceConfigDiffResponse'
deprecated: false
/webacs/api/v4/op/configArchiveService/extractSanitizedFile:
get:
summary: >-
GET Download the sanitized configuration file
GET op/configArchiveService/extractSanitizedFile
description: >-
GET Download the sanitized configuration file
GET op/configArchiveService/extractSanitizedFile
operationId: >-
GETDownloadthesanitizedconfigurationfile
GETop/configArchiveService/extractSanitizedFile
parameters:
- name: fileId
in: query
description: RequiredfileId parameter from configuration version
required: true
style: form
explode: true
schema:
type: number
format: double
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpConfigArchiveServiceExtractSanitizedFileResponse'
deprecated: false
/webacs/api/v4/op/configArchiveService/extractUnsanitizedFile:
get:
summary: >-
GET Download the unsanitized configuration file
GET op/configArchiveService/extractUnsanitizedFile
description: >-
GET Download the unsanitized configuration file
GET op/configArchiveService/extractUnsanitizedFile
operationId: >-
GETDownloadtheunsanitizedconfigurationfile
GETop/configArchiveService/extractUnsanitizedFile
parameters:
- name: fileId
in: query
description: RequiredfileId parameter from configuration version
required: true
style: form
explode: true
schema:
type: number
format: double
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpConfigArchiveServiceExtractUnsanitizedFileResponse'
deprecated: false
/webacs/api/v4/op/credentialProfilesManagement/credentialProfiles:
delete:
summary: >-
DELETE Delete credential profile
DELETE op/credentialProfilesManagement/credentialProfiles
description: >-
DELETE Delete credential profile
DELETE op/credentialProfilesManagement/credentialProfiles
operationId: >-
DELETEDeletecredentialprofile
DELETEop/credentialProfilesManagement/credentialProfiles
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpCredentialProfilesManagementCredentialProfilesResponse'
deprecated: false
get:
summary: >-
GET Get credential profiles
GET op/credentialProfilesManagement/credentialProfiles
description: >-
GET Get credential profiles
GET op/credentialProfilesManagement/credentialProfiles
operationId: >-
GETGetcredentialprofiles
GETop/credentialProfilesManagement/credentialProfiles
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpCredentialProfilesManagementCredentialProfilesResponse1'
deprecated: false
/webacs/api/v4/op/credentialProfilesManagement/deviceList:
get:
summary: >-
GET Get list of configured devices
GET op/credentialProfilesManagement/deviceList
description: >-
GET Get list of configured devices
GET op/credentialProfilesManagement/deviceList
operationId: >-
GETGetlistofconfigureddevices
GETop/credentialProfilesManagement/deviceList
parameters:
- name: profileName
in: query
description: RequiredThe name of credential profile to retrieve device list.
required: true
style: form
explode: true
schema:
type: string
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpCredentialProfilesManagementDeviceListResponse'
deprecated: false
post:
summary: >-
POST Create credential profile
POST op/credentialProfilesManagement/credentialProfiles
description: >-
POST Create credential profile
POST op/credentialProfilesManagement/credentialProfiles
operationId: >-
POSTCreatecredentialprofile
POSTop/credentialProfilesManagement/credentialProfiles
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpCredentialProfilesManagementDeviceListResponse1'
deprecated: false
put:
summary: >-
PUT Update credential profile
PUT op/credentialProfilesManagement/credentialProfiles
description: >-
PUT Update credential profile
PUT op/credentialProfilesManagement/credentialProfiles
operationId: >-
PUTUpdatecredentialprofile
PUTop/credentialProfilesManagement/credentialProfiles
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpCredentialProfilesManagementDeviceListResponse1'
deprecated: false
/webacs/api/v4/data/InventoryDetails:
get:
summary: >-
GET Inventory Details
GET data/InventoryDetails
description: >-
GET Inventory Details
GET data/InventoryDetails
operationId: >-
GETInventoryDetails
GETdata/InventoryDetails
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4DataInventoryDetailsResponse'
deprecated: false
/webacs/api/v4/data/MerakiAccessPoints:
get:
summary: >-
GET Meraki Access Points
GET data/MerakiAccessPoints
description: >-
GET Meraki Access Points
GET data/MerakiAccessPoints
operationId: >-
GETMerakiAccessPoints
GETdata/MerakiAccessPoints
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4DataMerakiAccessPointsResponse'
deprecated: false
/webacs/api/v4/data/MerakiDevices:
get:
summary: >-
GET Meraki Devices
GET data/MerakiDevices
description: >-
GET Meraki Devices
GET data/MerakiDevices
operationId: >-
GETMerakiDevices
GETdata/MerakiDevices
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4DataMerakiDevicesResponse'
deprecated: false
/webacs/api/v4/op/devices/exportDevices:
get:
summary: >-
GET Export Devices
GET op/devices/exportDevices
description: >-
GET Export Devices
GET op/devices/exportDevices
operationId: >-
GETExportDevices
GETop/devices/exportDevices
parameters:
- name: ipAddress
in: query
description: Management address of the device to be exported. The management address is the address used to add the device to the managed inventory, either an IP address or hostname.
style: form
explode: true
schema:
type: string
- name: groupId
in: query
description: The ids of the groups of the devices to be exported. A group logically organizes devices. A group could be a device type, a site or a user defined group
style: form
explode: true
schema:
type: string
- name: groupPath
in: query
description: The name of a group
style: form
explode: true
schema:
type: string
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpDevicesExportDevicesResponse'
deprecated: false
/webacs/api/v4/op/devices/removalJob:
post:
summary: >-
POST Delete devices through job
POST op/devices/removalJob
description: >-
POST Delete devices through job
POST op/devices/removalJob
operationId: >-
POSTDeletedevicesthroughjob
POSTop/devices/removalJob
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpDevicesRemovalJobRequest'
required: false
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpDevicesRemovalJobResponse'
deprecated: false
/webacs/api/v4/op/devices/syncDevices:
post:
summary: >-
POST Synchronize devices
POST op/devices/syncDevices
description: >-
POST Synchronize devices
POST op/devices/syncDevices
operationId: >-
POSTSynchronizedevices
POSTop/devices/syncDevices
parameters: []
responses:
'200':
description: Successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpDevicesSyncDevicesResponse'
deprecated: false
/webacs/api/v4/op/devices/bulkImport:
put:
summary: >-
PUT Bulk Import
PUT op/devices/bulkImport
description: >-
PUT Bulk Import
PUT op/devices/bulkImport
operationId: >-
PUTBulkImport
PUTop/devices/bulkImport
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WebacsApiV4OpDevicesBulkImportRequest'
required: fal