Device Enrollment API documentation version v1
https://{safeconnect}/camel/enrollment/{version}
API documentation for the SafeConnect Device Enrollment system. Available since SafeConnect version 6.5.0
- safeconnect: required (string)
The URL or IP address of your SafeConnect manager, or the single SafeConnect appliance in a standalone configuration.
- version: required (v1)
/device
Retrieve a page of enrollment records
Save a new enrollment record
Delete all enrollments.
get /device
Retrieve a page of enrollment records
Query Parameters
- page: (integer - default: 0)
Which page to retrieve
- size: (integer - default: 20)
How many elements the page should contain
- sort: (string)
Controls the sorting of the returned elements. Can be provided more than once for multiple sort items.
HTTP status code 200
Body
Media type: application/hal+json
Type: object
Properties- _embedded: required (array of deviceEnrollmentResource)
Items: deviceEnrollmentResource
- macAddress: required (string)
- role: required (string)
- description: required (string)
- _links: required (object)
HAL Link for a resource to refer to itself
- self: required (object)
https://en.wikipedia.org/wiki/Hypertext_Application_Language
- name: (string)
- href: required (string)
- templated: (boolean)
- self: required (object)
- _links: required (object)
Hypermedia links for navigating pages
- self: required (object)
https://en.wikipedia.org/wiki/Hypertext_Application_Language
- name: (string)
- href: required (string)
- templated: (boolean)
- first: (object)
https://en.wikipedia.org/wiki/Hypertext_Application_Language
- name: (string)
- href: required (string)
- templated: (boolean)
- last: (object)
https://en.wikipedia.org/wiki/Hypertext_Application_Language
- name: (string)
- href: required (string)
- templated: (boolean)
- previous: (object)
https://en.wikipedia.org/wiki/Hypertext_Application_Language
- name: (string)
- href: required (string)
- templated: (boolean)
- next: (object)
https://en.wikipedia.org/wiki/Hypertext_Application_Language
- name: (string)
- href: required (string)
- templated: (boolean)
- self: required (object)
- page: required (object)
Information about the current page
- size: required (integer)
- totalElements: required (integer)
- totalPages: required (integer)
- number: required (integer)
Example:
{
"_embedded": {
"deviceEnrollments": [
{
"macAddress": "aabbccddeeff",
"role": "SC_Initial_Role",
"description": "<descriptive text>",
"_links": {
"self": {
"href": "http://127.0.0.1:8096/enrollment/v1/device/aabbccddeeff"
}
}
}
]
},
"_links": {
"self": {
"href": "http://127.0.0.1:8096/enrollment/v1/device"
}
},
"page": {
"size": 20,
"totalElements": 1,
"totalPages": 1,
"number": 0
}
}
post /device
Save a new enrollment record
Body
Media type: application/json
Type: object
Properties- macAddress: required (string)
- role: required (string)
- description: required (string)
Example:
{
"macAddress": "aabbccddeeff",
"role": "SC_Initial_Role",
"description": "<descriptive text>"
}
Upload a spreadsheet file (csv, xls, xlsx) with enrollment records
post /device/bulk
Upload a spreadsheet file (csv, xls, xlsx) with enrollment records
Body
Media type: multipart/form-data
Type: object
Properties- file: required (file)
The file to be uploaded
Example:
mac address,role,description aabbccddeeff,SC_Initial_Role,<descriptive text> 000000000001,SC_Quarantine_Role,<another enrollment>
Retrieve a specific enrollment record
Update an existing enrollment.
Delete an existing enrollment
get /device/{macAddress}
Retrieve a specific enrollment record
URI Parameters
- macAddress: required (string)
HTTP status code 200
Body
Media type: application/hal+json
Type: object
Properties- macAddress: required (string)
- role: required (string)
- description: required (string)
- _links: required (object)
HAL Link for a resource to refer to itself
- self: required (object)
https://en.wikipedia.org/wiki/Hypertext_Application_Language
- name: (string)
- href: required (string)
- templated: (boolean)
- self: required (object)
Example:
{
"macAddress": "aabbccddeeff",
"role": "SC_Initial_Role",
"description": "<descriptive text>",
"_links": {
"self": {
"href": "http://127.0.0.1:8096/enrollment/v1/device/aabbccddeeff"
}
}
}
HTTP status code 400
If the macAddress path parameter isn't a valid MAC address
HTTP status code 404
If the macAddress path parameter doesn't have an enrollment record
put /device/{macAddress}
Update an existing enrollment.
URI Parameters
- macAddress: required (string)
Body
Media type: application/json
Type: object
Properties- macAddress: required (string)
- role: required (string)
- description: required (string)
Example:
{
"macAddress": "aabbccddeeff",
"role": "SC_Initial_Role",
"description": "<descriptive text>"
}
HTTP status code 200
Update processed successfully. After the update, the device enrollment record
HTTP status code 400
The proposed update isn't valid
HTTP status code 404
The macAddress path parameter doesn't have an enrollment record
HTTP status code 409
The proposed update conflicts with another enrollment
HTTP status code 500
An unexpected server error occurred
delete /device/{macAddress}
Delete an existing enrollment
URI Parameters
- macAddress: required (string)