API controls for Air Marshal settings are now available

[John-K]

We have recently released API controls for our wireless Air Marshal feature, which helps wireless admins manage wireless threats. With these new API operations, you can configure and manage default Air Marshal policies and per-network rules. These operations augment the existing getNetworkWirelessAirMarshal operation, which returns scan results from a specific network. The new operations are fully available for immediate use and will be included in the upcoming May 2024 updates to our documentation and Python libraries.

First, to manage your per-network rules, we have a standard CRUD suite:

Create a new rule with createNetworkWirelessAirMarshalRule:

POST /networks/{networkId}/wireless/airMarshal/rules

Update or delete a rule with updateNetworkWirelessAirMarshalRule or deleteNetworkWirelessAirMarshalRule:

PUT /networks/{networkId}/wireless/airMarshal/rules/{ruleId}

DELETE /networks/{networkId}/wireless/airMarshal/rules/{ruleId}

Fetch all rules for all networks with getOrganizationWirelessAirMarshalRules:

GET /organizations/{organizationId}/wireless/airMarshal/rules

Example output

{
    "items": [
        {
            "network": {
                "id": "N_12345",
                "name": "Network 1"
            },
            "ruleId": "5239",
            "type": "allow",
            "updatedAt": "2023-05-23 12:02:46.298",
            "createdAt": "2023-05-23 12:02:46.298",
            "match": {
                "string": "ipsum",
                "type": "contains"
            }
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 1
            }
        }
    }
}

To manage your default per-network rules, you can use these new operations:

To update the default policy per network, use updateNetworkWirelessAirMarshalSettings:

PUT /networks/{networkId}/wireless/airMarshal/settings

To retrieve all default policies for all networks, getOrganizationWirelessAirMarshalSettingsByNetwork:

GET /organizations/{organizationId}/wireless/airMarshal/settings/byNetwork

Example output

{
    "items": [
        {
            "networkId": "N_12345",
            "defaultPolicy": "allow"
        }
    ],
    "meta": {
        "counts": {
            "items": {
                "total": 1,
                "remaining": 0
            }
        }
    }
}

For more detail on these operations, please consult the relevant sections of the OpenAPI specification. We're excited to enable your automated control and validation of these operations and look forward to your feedback!