Skip to content
MAC Registration/
/
Update a MAC Registration

MAC Registration (UNKNOWN)

Overview

The MAC Registration REST APIs and Model, allow the creation, deletion, and modification of MAC registration list, and MAC registrations.

What This API Does

  • Create, modify, and delete MAC registration list and MAC registrations

Error Handling

The API uses standard HTTP status codes with detailed error messages in the response body.

Common Error Responses

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
Download PDF
Overview
License
RUCKUS Cloud Privacy Policy
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

MAC Registration

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.

Operations

Import MAC Registrations to PoolDeprecated

Request

This method will be removed no sooner than 08/31/2026 and application/json is currently tied to application/vnd.ruckus.v1+json which will be moved to application/vnd.ruckus.v1.1+json on 08/31/2026.

Path
poolIdstring(uuid)required

Registration pool id

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27
Bodymultipart/form-data
filestring(binary)required
multipart/form-data
{
  "file": "string"
}

Responses

Registration pools created

Body
Array [
idstring(uuid)

The unique identifier for this MAC registration.

expirationDatestring(date-time)

Indicates when this registration expires. Will derive from the pool setting if not specified.

revokedbooleanrequired

If this MAC registration is revoked or not.

macAddressstringnon-empty^([0-9A-F]{2}:){5}([0-9A-F]{2})$required

The mac address for this registration. Must be provided on post, and may not be changed.

usernamestring[ 0 .. 255 ] characters

A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.

emailstring[ 0 .. 255 ] characters^(?:[\w!#$%&’*+/=?`{|}~^-]+(?:\.[\w!#$%&’*+/=...

The email to associate with this device.

Example: "dev@commscope.com"
locationstring[ 0 .. 255 ] characters

The location of this device.

deviceNamestring[ 0 .. 255 ] characters

Device name

createdDatestring(date-time)

The created date of this device.

isReferencedboolean

This registration is referenced by an identity and cannot be deleted.

_linksobject(Links)
]
Response
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "expirationDate": "2019-08-24T14:15:22Z",
    "revoked": true,
    "macAddress": "string",
    "username": "string",
    "email": "dev@commscope.com",
    "location": "string",
    "deviceName": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "isReferenced": true,
    "_links": { … }
  }
]

Create MAC Registration in PoolDeprecated

Request

This method will be removed no sooner than 08/31/2026 and application/json is currently tied to application/vnd.ruckus.v1+json which will be moved to application/vnd.ruckus.v1.1+json on 08/31/2026.

Path
poolIdstring(uuid)required

Registration pool id

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27
Body
required
idstring(uuid)

The unique identifier for this MAC registration.

expirationDatestring(date-time)

Indicates when this registration expires. Will derive from the pool setting if not specified.

revokedbooleanrequired

If this MAC registration is revoked or not.

macAddressstringnon-empty^([0-9A-F]{2}:){5}([0-9A-F]{2})$required

The mac address for this registration. Must be provided on post, and may not be changed.

usernamestring[ 0 .. 255 ] characters

A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.

emailstring[ 0 .. 255 ] characters^(?:[\w!#$%&’*+/=?`{|}~^-]+(?:\.[\w!#$%&’*+/=...

The email to associate with this device.

Example: "dev@commscope.com"
locationstring[ 0 .. 255 ] characters

The location of this device.

deviceNamestring[ 0 .. 255 ] characters

Device name

createdDatestring(date-time)

The created date of this device.

isReferencedboolean

This registration is referenced by an identity and cannot be deleted.

_linksobject(Links)
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "expirationDate": "2019-08-24T14:15:22Z",
  "revoked": true,
  "macAddress": "string",
  "username": "string",
  "email": "dev@commscope.com",
  "location": "string",
  "deviceName": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "isReferenced": true,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Responses

Registration created

Body
idstring(uuid)

The unique identifier for this MAC registration.

expirationDatestring(date-time)

Indicates when this registration expires. Will derive from the pool setting if not specified.

revokedbooleanrequired

If this MAC registration is revoked or not.

macAddressstringnon-empty^([0-9A-F]{2}:){5}([0-9A-F]{2})$required

The mac address for this registration. Must be provided on post, and may not be changed.

usernamestring[ 0 .. 255 ] characters

A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.

emailstring[ 0 .. 255 ] characters^(?:[\w!#$%&’*+/=?`{|}~^-]+(?:\.[\w!#$%&’*+/=...

The email to associate with this device.

Example: "dev@commscope.com"
locationstring[ 0 .. 255 ] characters

The location of this device.

deviceNamestring[ 0 .. 255 ] characters

Device name

createdDatestring(date-time)

The created date of this device.

isReferencedboolean

This registration is referenced by an identity and cannot be deleted.

_linksobject(Links)
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "expirationDate": "2019-08-24T14:15:22Z",
  "revoked": true,
  "macAddress": "string",
  "username": "string",
  "email": "dev@commscope.com",
  "location": "string",
  "deviceName": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "isReferenced": true,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Delete the Specific MAC RegistrationsDeprecated

Request

This method will be removed no sooner than 08/31/2026 and application/json is currently tied to application/vnd.ruckus.v1+json which will be moved to application/vnd.ruckus.v1.1+json on 08/31/2026.

Path
poolIdstring(uuid)required

Registration pool id

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27
Body
requiredArray [
string(uuid)
]
[
  "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]

Responses

Registration deleted

Body
any(EmptyResponse)

Empty response body. Represents an empty JSON object with no properties.

Response
null

Delete the Specific MAC RegistrationDeprecated

Request

This method will be removed no sooner than 08/31/2026 and application/json is currently tied to application/vnd.ruckus.v1+json which will be moved to application/vnd.ruckus.v1.1+json on 08/31/2026.

Path
idstring(uuid)required

MAC registration id

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27
poolIdstring(uuid)required

Registration pool id

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27
No request payload

Responses

Registration deleted

Body
any(EmptyResponse)

Empty response body. Represents an empty JSON object with no properties.

Response
null

Update a MAC RegistrationDeprecated

Request

This method will be removed no sooner than 08/31/2026 and application/json is currently tied to application/vnd.ruckus.v1+json which will be moved to application/vnd.ruckus.v1.1+json on 08/31/2026.

Path
idstring(uuid)required

MAC registration id

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27
poolIdstring(uuid)required

Registration pool id

Example: f1ae11f2-1390-47c1-b05e-8377180c2b27
Body
required
idstring(uuid)

The unique identifier for this MAC registration.

expirationDatestring(date-time)

Indicates when this registration expires. Will derive from the pool setting if not specified.

revokedbooleanrequired

If this MAC registration is revoked or not.

macAddressstringnon-empty^([0-9A-F]{2}:){5}([0-9A-F]{2})$required

The mac address for this registration. Must be provided on post, and may not be changed.

usernamestring[ 0 .. 255 ] characters

A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.

emailstring[ 0 .. 255 ] characters^(?:[\w!#$%&’*+/=?`{|}~^-]+(?:\.[\w!#$%&’*+/=...

The email to associate with this device.

Example: "dev@commscope.com"
locationstring[ 0 .. 255 ] characters

The location of this device.

deviceNamestring[ 0 .. 255 ] characters

Device name

createdDatestring(date-time)

The created date of this device.

isReferencedboolean

This registration is referenced by an identity and cannot be deleted.

_linksobject(Links)
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "expirationDate": "2019-08-24T14:15:22Z",
  "revoked": true,
  "macAddress": "string",
  "username": "string",
  "email": "dev@commscope.com",
  "location": "string",
  "deviceName": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "isReferenced": true,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Responses

MAC registration updated

Body
idstring(uuid)

The unique identifier for this MAC registration.

expirationDatestring(date-time)

Indicates when this registration expires. Will derive from the pool setting if not specified.

revokedbooleanrequired

If this MAC registration is revoked or not.

macAddressstringnon-empty^([0-9A-F]{2}:){5}([0-9A-F]{2})$required

The mac address for this registration. Must be provided on post, and may not be changed.

usernamestring[ 0 .. 255 ] characters

A username for this device, it does not reflect an authenticated user that has gone through a real authentication process.

emailstring[ 0 .. 255 ] characters^(?:[\w!#$%&’*+/=?`{|}~^-]+(?:\.[\w!#$%&’*+/=...

The email to associate with this device.

Example: "dev@commscope.com"
locationstring[ 0 .. 255 ] characters

The location of this device.

deviceNamestring[ 0 .. 255 ] characters

Device name

createdDatestring(date-time)

The created date of this device.

isReferencedboolean

This registration is referenced by an identity and cannot be deleted.

_linksobject(Links)
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "expirationDate": "2019-08-24T14:15:22Z",
  "revoked": true,
  "macAddress": "string",
  "username": "string",
  "email": "dev@commscope.com",
  "location": "string",
  "deviceName": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "isReferenced": true,
  "_links": {
    "property1": { … },
    "property2": { … }
  }
}

Registration Pool

Operations for managing registration pools. Registration pools are containers that hold MAC address registrations and define access policies for devices.

Operations