Conch::Route::Rack

SOURCE

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

METHODS

routes

Sets up the routes for /rack.

one_rack_routes

Sets up the routes for working with just one rack, mounted under a provided route prefix.

ROUTE ENDPOINTS

All routes require authentication.

Take note: All routes that reference a specific rack (prefix /rack/:rack_id) are also available under /rack/:rack_id_or_long_name as well as /room/datacenter_room_id_or_alias/rack/:rack_id_or_name.

POST /rack

• Requires system admin authorization
• Controller/Action: “create” in Conch::Controller::Rack
• Request: request.json#/$defs/RackCreate
• Response: 201 Created, plus Location header

GET /rack/:rack_id_or_name

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

POST /rack/:rack_id_or_name

• User requires the read/write role on the rack
• Controller/Action: “update” in Conch::Controller::Rack
• Request: request.json#/$defs/RackUpdate
• Response: 204 No Content, plus Location header

DELETE /rack/:rack_id_or_name

• Requires system admin authorization
• Controller/Action: “delete” in Conch::Controller::Rack
• Response: 204 No Content

GET /rack/:rack_id_or_name/layout

• User requires the read-only role on the rack
• Controller/Action: “get_layouts” in Conch::Controller::Rack
• Response: response.json#/$defs/RackLayouts

POST /rack/:rack_id_or_name/layout

• User requires the read/write role on the rack
• Controller/Action: “overwrite_layouts” in Conch::Controller::Rack
• Request: request.json#/$defs/RackLayouts
• Response: 204 No Content, plus Location header

GET /rack/:rack_id_or_name/assignment

• User requires the read-only role on the rack
• Controller/Action: “get_assignment” in Conch::Controller::Rack
• Response: response.json#/$defs/RackAssignments

POST /rack/:rack_id_or_name/assignment

• User requires the read/write role on the rack
• Controller/Action: “set_assignment” in Conch::Controller::Rack
• Request: request.json#/$defs/RackAssignmentUpdates
• Response: 204 No Content, plus Location header

DELETE /rack/:rack_id_or_name/assignment

This method requires a request body.

• User requires the read/write role on the rack
• Controller/Action: “delete_assignment” in Conch::Controller::Rack
• Request: request.json#/$defs/RackAssignmentDeletes
• Response: 204 No Content

POST /rack/:rack_id_or_name/phase?rack_only=<0|1>

The query parameter rack_only (defaults to 0) specifies whether to update only the rack’s phase, or all the rack’s devices’ phases as well.

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

POST /rack/:rack_id_or_name/links

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

DELETE /rack/:rack_id_or_name/links

• User requires the read/write role on the rack
• Controller/Action: “remove_links” in Conch::Controller::Rack
• Request: request.json#/$defs/RackLinksOrNull
• Response: 204 No Content, plus Location header

GET /rack/:rack_id_or_name/layout/:layout_id_or_rack_unit_start

See “GET /layout/:layout_id” in Conch::Route::RackLayout.

POST /rack/:rack_id_or_name/layout/:layout_id_or_rack_unit_start

See “POST /layout/:layout_id” in Conch::Route::RackLayout.

DELETE /rack/:rack_id_or_name/layout/:layout_id_or_rack_unit_start

See “DELETE /layout/:layout_id” in Conch::Route::RackLayout.

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/.