
Cisco Evolved Programmable Network Manager API
Evolved Programmable Network Manager API Documentation

# PUT configure/ap/maintenanceMode

Sets the maintenance mode for unified access points. For other device types should use PUT Set Device Maintenance Mode. Maintenance mode status for a unified AP can be retrieved with the response parameter "unifiedApInfo.maintenanceMode" from the API GET Wireless Access Point Details.

Since Product Version: 3.4

- Jump To

- v1
- v2
- v3
- v4

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

Resource unavailable for this API version

This resource was introduced in API version 4.

Resource unavailable for this API version

This resource was introduced in API version 4.

Resource unavailable for this API version

This resource was introduced in API version 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[] | Required List of unified AP IDs.
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 MaintenanceModeResultDTO[] | List of operation results
Attribute | Description
--- | ---
id Long | Entity ID
message String | Result message

## 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://10.64.88.203/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://10.64.88.203/webacs/api/v4/op/configure/ap/maintenanceMode.json

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

### Sample XML Response Payload

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

    <?xml version="1.0" ?>
    <mgmtResponse responseType="operation" requestUrl="../../../../../../pages/common/login.jsp.html" rootUrl="https://10.64.88.203/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://10.64.88.203/webacs/api/v4/op/configure/ap/maintenanceMode.json

    {
      "mgmtResponse" : {
        "@requestUrl" : "../../../../../../pages/common/login.jsp.html",
        "@responseType" : "operation",
        "@rootUrl" : "https://10.64.88.203/webacs/api/v4/op",
        "maintenanceModeResultsDTO" : [ {
          "message" : "String value",
          "results" : {
            "result" : [ {
              "id" : 15,
              "message" : "String value"
            }, {
              "id" : 25,
              "message" : "Another string value"
            } ]
          }
        } ]
      }
    }