Conch::Route::Device

SOURCE

https://github.com/joyent/conch-api/blob/master/lib/Conch/Route/Device.pm

METHODS

routes

Sets up the routes for /device.

ROUTE ENDPOINTS

All routes require authentication.

The user’s role (required for most endpoints) is determined by the build the device is contained in (where users are assigned a role in that build), and the rack location of the device and the build the rack is contained in (where users are assigned a role in that build).

Full (admin-level) access is also granted to a device if a report was sent for that device using a relay that registered with that user’s credentials.

GET /device?:key=:value

Supports the following query parameters:

• hostname=:hostname
• mac=:macaddr
• ipaddr=:ipaddr
• :setting_key=:setting_value

The value of :setting_key and :setting_value are a device setting key and value. For information on how to create a setting key or set its value see below.

• Controller/Action: “lookup_by_other_attribute” in Conch::Controller::Device
• Response: response.json#/$defs/Devices

GET /device/:device_id_or_serial_number

• User requires the read-only role
• Controller/Action: “get” in Conch::Controller::Device
• Response: response.json#/$defs/DetailedDevice

GET /device/:device_id_or_serial_number/pxe

• User requires the read-only role
• Controller/Action: “get_pxe” in Conch::Controller::Device
• Response: response.json#/$defs/DevicePXE

GET /device/:device_id_or_serial_number/phase

• User requires the read-only role
• Controller/Action: “get_phase” in Conch::Controller::Device
• Response: response.json#/$defs/DevicePhase

GET /device/:device_id_or_serial_number/sku

• User requires the read-only role
• Controller/Action: “get_sku” in Conch::Controller::Device
• Response: response.json#/$defs/DeviceSku

POST /device/:device_id_or_serial_number/asset_tag

• User requires the read/write role
• Controller/Action: “set_asset_tag” in Conch::Controller::Device
• Request: request.json#/$defs/DeviceAssetTag
• Response: 204 No Content, plus Location header

POST /device/:device_id_or_serial_number/validated

• User requires the read/write role
• Controller/Action: “set_validated” in Conch::Controller::Device
• Request: request.json#/$defs/Null
• Response: 204 No Content, plus Location header

POST /device/:device_id_or_serial_number/phase

• User requires the read/write role
• Controller/Action: “set_phase” in Conch::Controller::Device
• Request: request.json#/$defs/DevicePhase
• Response: 204 No Content, plus Location header

POST /device/:device_id_or_serial_number/links

• User requires the read/write role
• Controller/Action: “add_links” in Conch::Controller::Device
• Request: request.json#/$defs/DeviceLinks
• Response: 204 No Content, plus Location header

DELETE /device/:device_id_or_serial_number/links

• User requires the read/write role
• Controller/Action: “remove_links” in Conch::Controller::Device
• Request: request.json#/$defs/DeviceLinksOrNull
• Response: 204 No Content

POST /device/:device_id_or_serial_number/build

• User requires the read/write role for the device, as well as the old and new builds
• Controller/Action: “set_build” in Conch::Controller::Device
• Request: request.json#/$defs/DeviceBuild
• Response: 204 No Content, plus Location header

POST /device/:device_id_or_serial_number/hardware_product

POST /device/:device_id_or_serial_number/sku

• User requires the admin role for the device
• Controller/Action: “set_hardware_product” in Conch::Controller::Device
• Request: request.json#/$defs/DeviceHardware
• Response: 204 No Content, plus Location header

GET /device/:device_id_or_serial_number/location

• User requires the read-only role
• Controller/Action: “get” in Conch::Controller::DeviceLocation
• Response: response.json#/$defs/DeviceLocation

POST /device/:device_id_or_serial_number/location

• User requires the read/write role
• Controller/Action: “set” in Conch::Controller::DeviceLocation
• Request: request.json#/$defs/DeviceLocationUpdate
• Response: 204 No Content, plus Location header

DELETE /device/:device_id_or_serial_number/location

• User requires the read/write role
• Controller/Action: “delete” in Conch::Controller::DeviceLocation
• Response: 204 No Content

GET /device/:device_id_or_serial_number/settings

• User requires the read-only role
• Controller/Action: “get_all” in Conch::Controller::DeviceSettings
• Response: response.json#/$defs/DeviceSettings

POST /device/:device_id_or_serial_number/settings

• User requires the read/write role, or admin when overwriting existing settings that do not start with tag..
• Controller/Action: “set_all” in Conch::Controller::DeviceSettings
• Request: request.json#/$defs/DeviceSettings
• Response: 204 No Content

GET /device/:device_id_or_serial_number/settings/:key

• User requires the read-only role
• Controller/Action: “get_single” in Conch::Controller::DeviceSettings
• Response: response.json#/$defs/DeviceSetting

POST /device/:device_id_or_serial_number/settings/:key

• User requires the read/write role, or admin when overwriting existing settings that do not start with tag..
• Controller/Action: “set_single” in Conch::Controller::DeviceSettings
• Request: request.json#/$defs/DeviceSettings
• Response: 204 No Content

DELETE /device/:device_id_or_serial_number/settings/:key

• User requires the read/write role for settings that start with tag., and admin otherwise.
• Controller/Action: “delete_single” in Conch::Controller::DeviceSettings
• Response: 204 No Content

POST /device/:device_id_or_serial_number/validation/:validation_id

Does not store validation results.

This endpoint is deprecated and will be removed in Conch API v4.0.

• User requires the read-only role
• Controller/Action: “validate” in Conch::Controller::DeviceValidation
• Request: request.json#/$defs/DeviceReport
• Response: response.json#/$defs/LegacyValidationResults

POST /device/:device_id_or_serial_number/validation_plan/:validation_plan_id

Does not store validation results.

This endpoint is deprecated and will be removed in Conch API v4.0.

• User requires the read-only role
• Controller/Action: “run_validation_plan” in Conch::Controller::DeviceValidation
• Request: request.json#/$defs/DeviceReport
• Response: response.json#/$defs/LegacyValidationResults

GET /device/:device_id_or_serial_number/validation_state?status=<pass|fail|error>&status=...

Accepts the query parameter status, indicating the desired status(es) to search for (one of pass, fail, error). Can be used more than once.

• User requires the read-only role
• Controller/Action: “get_validation_state” in Conch::Controller::DeviceValidation
• Response: response.json#/$defs/ValidationStateWithResults

GET /device/:device_id_or_serial_number/interface

• User requires the read-only role
• Controller/Action: “get_all” in Conch::Controller::DeviceInterface
• Response: response.json#/$defs/DeviceNics

GET /device/:device_id_or_serial_number/interface/:interface_name

• User requires the read-only role
• Controller/Action: “get_one” in Conch::Controller::DeviceInterface
• Response: response.json#/$defs/DeviceNic

GET /device/:device_id_or_serial_number/interface/:interface_name/:field

• User requires the read-only role
• Controller/Action: “get_one_field” in Conch::Controller::DeviceInterface
• Response: response.json#/$defs/DeviceNicField

LICENSING

Copyright Joyent, Inc.

This Source Code Form is subject to the terms of the Mozilla Public License, v.2.0. If a copy of the MPL was not distributed with this file, You can obtain one at https://www.mozilla.org/en-US/MPL/2.0/.