Keypools

Endpoints related to keypool management for network operators.

List Keypools

post

Returns a list of all keypools managed by the network operator, including SSID, scope, authentication mechanism, and venue associations.

Header parameters
originstringRequired

The full URL of the calling console. This must match the expected value for your environment (e.g., https://demo.roamingiq.com). This header is required for all API calls and must be set exactly as expected by the backend.

Default: https://demo.roamingiq.comExample: https://demo.roamingiq.com
Body
AccessTokenstringRequired

The access token for the network operator admin session.

Responses
200
List of keypools returned successfully.
application/json
post
POST /preview/networkoperatorconsole/keypools/listKeypools HTTP/1.1
Host: api.wifikey.io
origin: https://demo.roamingiq.com
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "AccessToken": "{{NetworkOperatorAdmin-AccessToken}}"
}
{
  "myKeyPoolCount": 2,
  "myKeyPoolList": {
    "USA.MA.67890.Customer.SAMPLETOWN4._V3SSID.Sample Address Resident.njfumtff": {
      "ConnectedVenueCount": 1,
      "ConnectedVenueList": {
        "USA.MA.67890.CustomerSERVICEDPROPERTIES.SAMPLETOWN4._V3VENUE.USA.RI.13579.SAMPLEADDRESS.SAMPLETOWN5": {
          "VenueName": "Sample Address",
          "AddressLine1": "Sample Address St",
          "AddressLine2": "",
          "City": "SAMPLETOWN5",
          "State": "RI",
          "Country.ISO3166A3": "USA",
          "PostalCode": "13579",
          "NAS-Identifier": "USA.RI.13579.SAMPLEADDRESS.SAMPLETOWN5"
        }
      },
      "ssid": "Sample Address Resident",
      "Scope": "njfumtff",
      "DisplayOrder": 49,
      "AuthenticationMechanism": "WPA2 PSK",
      "KeyCount": 210,
      "SubscriberCount": 199,
      "SubscriberList": [],
      "InactiveSubscriberCount": 0,
      "InactiveSubscriberList": [],
      "dateAddedUTC.ISO8601": "2023-11-14T13:56:44.443Z"
    },
    "USA.MA.67890.Customer.SAMPLETOWN4._V3SSID.7607 Resident.qhnnhbgy": {
      "ConnectedVenueCount": 1,
      "ConnectedVenueList": {
        "USA.MA.67890.CustomerSERVICEDPROPERTIES.SAMPLETOWN4._V3VENUE.USA.MD.20814.Venue.City": {
          "VenueName": "Example",
          "AddressLine1": "123 Fake Street",
          "AddressLine2": "",
          "City": "Anytown",
          "State": "MD",
          "Country.ISO3166A3": "USA",
          "PostalCode": "20814",
          "NAS-Identifier": "USA.MD.20814.Venue.City"
        }
      },
      "ssid": "7607 Resident",
      "Scope": "qhnnhbgy",
      "DisplayOrder": 48,
      "AuthenticationMechanism": "WPA2 PSK",
      "KeyCount": 120,
      "SubscriberCount": 118,
      "SubscriberList": [],
      "InactiveSubscriberCount": 0,
      "InactiveSubscriberList": [],
      "dateAddedUTC.ISO8601": "2024-01-04T18:39:49.689Z"
    }
  },
  "errorProcessing": false
}

Add Keypool

post

Adds a new keypool for the network operator. Requires SSID and AccessToken. Optionally accepts Scope, VenueID, and AuthenticationMechanism. Returns the created KeyPoolID and SSID.

Header parameters
originstringRequired

The full URL of the calling console. This must match the expected value for your environment (e.g., https://demo.roamingiq.com). This header is required for all API calls and must be set exactly as expected by the backend.

Default: https://demo.roamingiq.comExample: https://demo.roamingiq.com
Body
AccessTokenstringRequired

The access token for the network operator admin session.

SSIDstringRequired

The SSID for the new keypool (2-32 chars, must conform to standards).

ScopestringOptional

Optional. Scope for the keypool (e.g., 'global').

VenueIDstringOptional

Optional. The VenueID to associate the keypool with a specific venue.

AuthenticationMechanismstringOptional

Optional. Authentication mechanism (default: WPA2 PSK). Allowed: 'WPA2 PSK', 'PEAP MSCHAPv2'.

Responses
200
Keypool added successfully.
application/json
post
POST /preview/networkoperatorconsole/keypools/addKeypool HTTP/1.1
Host: api.wifikey.io
origin: https://demo.roamingiq.com
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "AccessToken": "{{NetworkOperatorAdmin-AccessToken}}",
  "SSID": "TestSSID",
  "Scope": "global",
  "AuthenticationMechanism": "WPA2 PSK"
}
{
  "message": "Keypool linked to all venues. ",
  "KeyPoolID": "USA.SAMPLE.12345.SAMPLEPROPERTY.SAMPLECITY._V3SSID.TestSSID.global",
  "SSID": "TestSSID",
  "errorProcessing": false
}

Configure Keypool

post

Updates configuration for an existing keypool, such as DisplayOrder. Requires KeyPoolID and the field(s) to update.

Header parameters
originstringRequired

The full URL of the calling console. This must match the expected value for your environment (e.g., https://demo.roamingiq.com). This header is required for all API calls and must be set exactly as expected by the backend.

Default: https://demo.roamingiq.comExample: https://demo.roamingiq.com
Body
KeyPoolIDstringRequired

The ID of the keypool to configure.

DisplayOrderintegerOptional

Optional. Display order (0-100).

Responses
200
Keypool configuration updated successfully.
application/json
post
POST /preview/networkoperatorconsole/keypools/configureKeypool HTTP/1.1
Host: api.wifikey.io
origin: https://demo.roamingiq.com
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "KeyPoolID": "OP123._V3SSID.FakeSSID1.global",
  "DisplayOrder": 10
}
{
  "message": "Updated DisplayOrder to 10"
}
PreviousShopping CartNextVenue

Was this helpful?