Operations for managing MAC address registrations within registration pools. MAC registrations allow devices to be authenticated and granted network access based on their MAC address.
MAC Registration//
- Update a Registration Pool
Create a Registration Pool
Delete the Specific Registration Pool
Update a Registration Poo...
MAC Registration (UNKNOWN)
The MAC Registration REST APIs and Model, allow the creation, deletion, and modification of MAC registration list, and MAC registrations.
The API uses standard HTTP status codes with detailed error messages in the response body.
All endpoints may return these common error responses:
- 400 Bad Request: Invalid input data or validation errors
- 401 Unauthorized: Missing or invalid authentication
- 403 Forbidden: Insufficient permissions
- 404 Not Found: Requested resource doesn't exist
- 409 Conflict: Resource conflict (e.g., duplicate names)
- 422 Unprocessable Entity: Business rule violations
- 500 Internal Server Error: Unexpected server errors
Download OpenAPI description
Overview
License
Languages
Servers
RUCKUS One API host for North American region.
https://api.ruckus.cloud
RUCKUS One API host for European region.
https://api.eu.ruckus.cloud
RUCKUS One API host for Asian region.
https://api.asia.ruckus.cloud
Body
- application/json
- application/vnd.ruckus.v1+json
A toggle determining whether MAC registrations that are 24 hours past the expiration time will be automatically removed from the pool.
Default true
Defines the rule for expiration date calculation.
Enum"SPECIFIED_DATE""MINUTES_AFTER_TIME""HOURS_AFTER_TIME""DAYS_AFTER_TIME""WEEKS_AFTER_TIME""MONTHS_AFTER_TIME""QUARTERS_AFTER_TIME""YEARS_AFTER_TIME""END_OF_HOUR""END_OF_DAY"
If the expiration type is not specified_date then this field is the offset amount.
If the expiration type is specified_date then this field is the related date.
A regex to determine which SSIDs this registration pool will allows access to.
If the expiration setting is enabled for new MAC registration.
Default false
- RUCKUS One API host for North American region.https://api.ruckus.cloud/macRegistrationPools
- RUCKUS One API host for European region.https://api.eu.ruckus.cloud/macRegistrationPools
- RUCKUS One API host for Asian region.https://api.asia.ruckus.cloud/macRegistrationPools
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "autoCleanup": true, "expirationType": "SPECIFIED_DATE", "expirationOffset": 0, "expirationDate": "2019-08-24T14:15:22Z", "ssidRegex": "string", "expirationEnabled": false, "registrationCount": 0, "defaultAccess": "ACCEPT", "createdDate": "2019-08-24T14:15:22Z", "policySetId": "string", "isReferenced": true, "networkCount": 0, "identityGroupId": "string", "identityId": "string", "_links": { "property1": { … }, "property2": { … } } }
Registration pool created
- application/json
- application/vnd.ruckus.v1+json
A toggle determining whether MAC registrations that are 24 hours past the expiration time will be automatically removed from the pool.
Default true
Defines the rule for expiration date calculation.
Enum"SPECIFIED_DATE""MINUTES_AFTER_TIME""HOURS_AFTER_TIME""DAYS_AFTER_TIME""WEEKS_AFTER_TIME""MONTHS_AFTER_TIME""QUARTERS_AFTER_TIME""YEARS_AFTER_TIME""END_OF_HOUR""END_OF_DAY"
If the expiration type is not specified_date then this field is the offset amount.
If the expiration type is specified_date then this field is the related date.
A regex to determine which SSIDs this registration pool will allows access to.
If the expiration setting is enabled for new MAC registration.
Default false
Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "autoCleanup": true, "expirationType": "SPECIFIED_DATE", "expirationOffset": 0, "expirationDate": "2019-08-24T14:15:22Z", "ssidRegex": "string", "expirationEnabled": false, "registrationCount": 0, "defaultAccess": "ACCEPT", "createdDate": "2019-08-24T14:15:22Z", "policySetId": "string", "isReferenced": true, "networkCount": 0, "identityGroupId": "string", "identityId": "string", "_links": { "property1": { … }, "property2": { … } } }
- RUCKUS One API host for North American region.https://api.ruckus.cloud/macRegistrationPools/{id}
- RUCKUS One API host for European region.https://api.eu.ruckus.cloud/macRegistrationPools/{id}
- RUCKUS One API host for Asian region.https://api.asia.ruckus.cloud/macRegistrationPools/{id}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payloadResponse
null
Body
- application/json
- application/vnd.ruckus.v1+json
A toggle determining whether MAC registrations that are 24 hours past the expiration time will be automatically removed from the pool.
Default true
Defines the rule for expiration date calculation.
Enum"SPECIFIED_DATE""MINUTES_AFTER_TIME""HOURS_AFTER_TIME""DAYS_AFTER_TIME""WEEKS_AFTER_TIME""MONTHS_AFTER_TIME""QUARTERS_AFTER_TIME""YEARS_AFTER_TIME""END_OF_HOUR""END_OF_DAY"
If the expiration type is not specified_date then this field is the offset amount.
If the expiration type is specified_date then this field is the related date.
A regex to determine which SSIDs this registration pool will allows access to.
If the expiration setting is enabled for new MAC registration.
Default false
- RUCKUS One API host for North American region.https://api.ruckus.cloud/macRegistrationPools/{id}
- RUCKUS One API host for European region.https://api.eu.ruckus.cloud/macRegistrationPools/{id}
- RUCKUS One API host for Asian region.https://api.asia.ruckus.cloud/macRegistrationPools/{id}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "autoCleanup": true, "expirationType": "SPECIFIED_DATE", "expirationOffset": 0, "expirationDate": "2019-08-24T14:15:22Z", "ssidRegex": "string", "expirationEnabled": false, "registrationCount": 0, "defaultAccess": "ACCEPT", "createdDate": "2019-08-24T14:15:22Z", "policySetId": "string", "isReferenced": true, "networkCount": 0, "identityGroupId": "string", "identityId": "string", "_links": { "property1": { … }, "property2": { … } } }
Registration pool updated
- application/json
- application/vnd.ruckus.v1+json
A toggle determining whether MAC registrations that are 24 hours past the expiration time will be automatically removed from the pool.
Default true
Defines the rule for expiration date calculation.
Enum"SPECIFIED_DATE""MINUTES_AFTER_TIME""HOURS_AFTER_TIME""DAYS_AFTER_TIME""WEEKS_AFTER_TIME""MONTHS_AFTER_TIME""QUARTERS_AFTER_TIME""YEARS_AFTER_TIME""END_OF_HOUR""END_OF_DAY"
If the expiration type is not specified_date then this field is the offset amount.
If the expiration type is specified_date then this field is the related date.
A regex to determine which SSIDs this registration pool will allows access to.
If the expiration setting is enabled for new MAC registration.
Default false
Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "autoCleanup": true, "expirationType": "SPECIFIED_DATE", "expirationOffset": 0, "expirationDate": "2019-08-24T14:15:22Z", "ssidRegex": "string", "expirationEnabled": false, "registrationCount": 0, "defaultAccess": "ACCEPT", "createdDate": "2019-08-24T14:15:22Z", "policySetId": "string", "isReferenced": true, "networkCount": 0, "identityGroupId": "string", "identityId": "string", "_links": { "property1": { … }, "property2": { … } } }