Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

PUT configure/ap/maintenanceMode

Sets the maintenance mode for unified access points. For other device types should use "PUT op/configure/device/maintenanceMode". Maintenance mode status for a unified AP can be retrieved with the response parameter "unifiedApInfo.maintenanceMode" from the "GET data/AccessPointDetails" resource.

Since Product Version: 3.4

Resource Information

Rate Limiting?

No

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Write

HTTP Methods

PUT

Resource URL

/webacs/api/v4/op/configure/ap/maintenanceMode

Request Payload Parameters

Attribute Description

apIds Long[]

List of unified AP IDs. Can be retrieved from the "GET data/AccessPointDetails" resource.

maintenanceMode Boolean

If true the maintenance mode will be on, if false the maintenance mode will be off. If the parameter is not specified it will be false.

Response Parameters

Attribute Description

message String

Message with the result information

results Arrow image MaintenanceModeResultDTO[]

List of operation results

Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

Sample XML Request Payload

https://localhost/webacs/api/v4/op/configure/ap/maintenanceMode

<?xml version="1.0" ?>
<apMaintenanceModeConfigDTO>
  <apIds>
    <apId>15</apId>
    <apId>25</apId>
  </apIds>
  <maintenanceMode>true</maintenanceMode>
</apMaintenanceModeConfigDTO>

Sample JSON Request Payload

https://localhost/webacs/api/v4/op/configure/ap/maintenanceMode.json

{
  "apMaintenanceModeConfigDTO" : {
    "apIds" : {
      "apId" : [ 15, 25 ]
    },
    "maintenanceMode" : true
  }
}

Sample XML Response Payload

https://localhost/webacs/api/v4/op/configure/ap/maintenanceMode

<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/configure/ap/maintenanceMode" rootUrl="https://localhost/webacs/api/v4/op">
  <maintenanceModeResultsDTO>
    <message>String value</message>
    <results>
      <result>
        <id>15</id>
        <message>String value</message>
      </result>
      <result>
        <id>25</id>
        <message>Another string value</message>
      </result>
    </results>
  </maintenanceModeResultsDTO>
</mgmtResponse>

Sample JSON Response Payload

https://localhost/webacs/api/v4/op/configure/ap/maintenanceMode.json

{
  "mgmtResponse" : {
    "@requestUrl" : "https://localhost/webacs/api/v4/op/configure/ap/maintenanceMode",
    "@responseType" : "operation",
    "@rootUrl" : "https://localhost/webacs/api/v4/op",
    "maintenanceModeResultsDTO" : [ {
      "message" : "String value",
      "results" : {
        "result" : [ {
          "id" : 15,
          "message" : "String value"
        }, {
          "id" : 25,
          "message" : "Another string value"
        } ]
      }
    } ]
  }
}