on-http-y1

info: title: rackhd api version: "4.0.0" basePath: /api/2.0 consumes: - application/json definitions: Error: properties: code: format: int32 type: integer fields: type: string message: type: string ErrorResponse: properties: message: type: string errors: items: type: string type: array required: - message Lookups.2.0_LookupBase: description: A lookup record properties: ipAddress: format: ipv4 type: string macAddress: pattern: ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ type: string node: type: string type: object VersionsResponse: properties: message: type: string required: - message action: description: Action object properties: command: description: Command to execute enum: - cancel type: string options: description: Command options object type: object required: - command generic_obj: type: object get_user_obj: properties: role: type: string username: type: string patch_user_obj: properties: role: type: string password: type: string hooks.2.0_HookBase: description: Hook base schema type: object properties: url: type: string format: uri name: type: string filters: type: array items: type: object hooks.2.0_HookPost: description: Hook post schema type: object properties: url: type: string format: uri name: type: string filters: type: array items: type: object required: - url ipmi-obm-service_Obm: description: OBM settings properties: config: properties: host: description: BMC address type: string password: description: IPMI password type: string user: description: IPMI username type: string type: object nodeId: type: string service: type: string required: - nodeId - service - config type: object node.2.0_GetNode: description: Get a node from RackHD properties: identifier: type: string autoDiscover: type: boolean bootSettings: type: object identifiers: items: type: string uniqueItems: true type: array name: description: Name of the node type: string obms: description: The list of obm settings type: array items: $ref: "#/definitions/nodes_post_obm_by_id" relations: type: array items: $ref: "#/definitions/relations_obj" tags: type: string type: description: Type of node enum: - compute - compute-container - switch - dae - pdu - mgmt - enclosure - rack type: string type: object node.2.0_PartialNode: description: Post a node into RackHD properties: autoDiscover: type: boolean bootSettings: type: object identifiers: items: type: string uniqueItems: true type: array name: description: Name of the node type: string obms: description: The list of obm settings type: array items: $ref: "#/definitions/nodes_post_obm_by_id" relations: type: array items: $ref: "#/definitions/relations_obj" tags: items: type: string uniqueItems: true type: array type: description: Type of node enum: - compute - compute-container - switch - dae - pdu - mgmt - enclosure - rack type: string type: object nodes_post_obm_by_id: description: OBM settings properties: config: type: object service: type: string required: - service - config type: object obm_led: properties: nodeId: type: string value: type: boolean obm: type: object properties: id: type: string node: type: string config: type: object service: type: string poller.2.0_PartialPoller: description: A poller for periodic collection of telemetry data properties: config: description: Poller configuration object type: object paused: description: Asserted if poller is paused type: boolean pollInterval: description: Interval at which poller will run type: number type: description: Type of poller enum: - ipmi - snmp - redfish - wsman type: string type: object post_node_workflow: properties: name: type: string options: properties: defaults: type: object type: object type: object post_tags: properties: name: minLength: 1 type: string rules: items: $ref: '#/definitions/tag_rule' type: array type: object post_tasks: properties: identifier: type: string tasks: items: $ref: '#/definitions/workflow_task' type: array type: object post_workflow: properties: name: type: string options: properties: defaults: properties: graphOptions: type: object nodeId: type: string type: object type: object type: object relations_obj: description: A key value set of node relations. properties: relationType: description: Relation Type with the node. type: string info: type: string targets: description: Array of targets. items: type: string type: array type: object role_obj: properties: privileges: items: type: string type: array role: type: string skus.2.0_SkusUpsert: description: A sku for RackHD properties: discoveryGraphName: minLength: 1 type: string discoveryGraphOptions: type: object name: minLength: 1 type: string rules: description: Possible Rules a Sku can use items: $ref: '#/definitions/tag_rule' type: array type: object ssh-ibm-service_Ibm: description: SSH settings properties: config: properties: host: description: IP address type: string password: description: Password type: string user: description: Username type: string type: object service: type: string nodeId: type: string required: - service - config type: object tag_rule: properties: contains: type: string equals: type: string greaterThan: type: number in: items: type: string type: array lessThan: type: number max: type: number min: type: number notContains: type: string notIn: items: type: string type: array notRegex: type: string path: type: string regex: type: string required: - path type: object user_obj: properties: password: type: string role: type: string username: type: string pattern: ^[A-Za-z][0-9A-Za-z._-]+$ workflow_graph: properties: friendlyName: type: string injectableName: type: string options: type: object tasks: items: $ref: '#/definitions/workflow_graph_task' type: array type: object workflow_graph_task: properties: ignoreFailure: type: boolean label: type: string taskName: type: string waitOn: type: object type: object workflow_task: properties: friendlyName: type: string implementsTask: type: string injectableName: type: string options: type: object properties: type: object type: object paths: /catalogs: get: description: Get an array of catalog data describing all hardware in the system. operationId: catalogsGet parameters: - description: A query string containing catalog properties to search in: query name: query required: false type: string - name: sort in: query description: Query string specifying properties to sort with required: false type: string pattern: '[- +]{0,1}(name|id)' responses: 200: description: Successfully retrieved a list of catalogs schema: $ref: '#/definitions/VersionsResponse' default: description: Error schema: $ref: '#/definitions/ErrorResponse' summary: Get all catalogs tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Read - catalogsRead x-view: catalogs.2.0.json x-swagger-router-controller: catalogs /catalogs/{identifier}: get: description: Get a catalog based on its catalog identifier. operationId: catalogsIdGet parameters: - description: The catalog identifier in: path name: identifier required: true type: string responses: 200: description: Successfully retrieved the catalog schema: $ref: '#/definitions/VersionsResponse' default: description: Error schema: $ref: '#/definitions/ErrorResponse' summary: Get a catalog tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Read - catalogsRead x-view: catalogs.2.0.json x-swagger-router-controller: catalogs /catalogs/{identifier}/firmware: get: description: Get a catalog based on its node identifier. operationId: firmwareCatalogsIdGet parameters: - description: node identifier in: path name: identifier required: true type: string responses: 200: description: Successfully retrieved the catalog schema: type: object default: description: Error schema: $ref: '#/definitions/ErrorResponse' summary: Get a firmware catalog tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Read - catalogsRead x-swagger-router-controller: catalogs /config: get: description: Get the RackHD server configuration properties. operationId: configGet responses: 200: description: Successfully retrieved the configuration schema: type: object default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Get server configuration tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Read - configRead patch: consumes: - application/json description: Modify the RackHD server configuration. operationId: configPatch parameters: - description: The configuration properties to be modified in: body name: config required: true schema: $ref: '#/definitions/generic_obj' responses: 200: description: Successfully modified the configuration schema: type: object default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Patch server configuration tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Write - configModify put: consumes: - application/json description: Modify the RackHD server configuration. operationId: configPut parameters: - description: The configuration properties to be modified in: body name: config required: true schema: $ref: '#/definitions/generic_obj' responses: 200: description: Successfully modified the configuration schema: type: object default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Patch server configuration tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Write - configModify x-swagger-router-controller: config /files: get: description: Get a list of all files currently stored. operationId: filesGetAll responses: 200: description: Successfully retrieved the files schema: type: object 500: description: Failed to serve file request schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Get all files tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Read - filesRead x-swagger-router-controller: files /files/{fileidentifier}: delete: description: Delete a file based on uuid. operationId: filesDelete parameters: - description: UUID of the file you wish to delete in: path name: fileidentifier required: true type: string responses: 204: description: File successfully deleted 404: description: File not found. schema: $ref: '#/definitions/Error' 500: description: Error deleting file from the database schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Delete a file tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Write - FilesRemove get: description: Get file based on uuid or file name. operationId: filesGet parameters: - description: The uuid or file name of a file as provided when you originally stored it in: path name: fileidentifier required: true type: string responses: 200: description: Successfully retrieved specified file schema: type: file 404: description: File not found schema: $ref: '#/definitions/Error' 500: description: Failed to serve file request schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Get a file tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Read - filesRead put: consumes: - application/octet-stream - application/x-www-form-urlencoded description: Put file based on its filename. Returns the uuid of the stored file. operationId: filesPut parameters: - description: The filename of the file you want to store in: path name: fileidentifier required: true type: string responses: 201: description: Successfully stored file schema: type: string 500: description: Failure serving file request schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Put a file tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Write - filesWrite x-view: file.2.0.json x-swagger-router-controller: files /files/{filename}/md5: get: description: Get md5sum based on file name. operationId: filesMd5Get parameters: - description: File name of a file as provided when you originally stored it in: path name: filename required: true type: string responses: 200: description: Successfully retrieved the md5sum of the specified file schema: type: object 404: description: File not found schema: $ref: '#/definitions/Error' 500: description: Failed to serve file request schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Get md5sum of file tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Read - filesRead x-view: files.md5.2.0.json x-swagger-router-controller: files /files/{filename}/metadata: get: description: Get file metadata by file name. operationId: filesMetadataGet parameters: - description: The name of a file as provided when you originally stored it in: path name: filename required: true type: string responses: 200: description: Successfully retrieved metadata of the specified file schema: type: object 404: description: File not found schema: $ref: '#/definitions/Error' 500: description: Failed to serve file metadata request schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Get file metadata tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Read - filesRead x-view: file.2.0.json x-swagger-router-controller: files /files/static/list: x-swagger-router-controller: files get: operationId: filesGetAllStatic x-privileges: [ 'Read' ] x-authentication-type: [ 'jwt' ] summary: | List all static files description: | List all static files tags: [ "/api/2.0" ] responses: 200: description: array of all schema: type: array items: type: object default: description: Unexpected error schema: $ref: '#/definitions/Error' /ibms: get: description: Get a list of all In Band Management settings that have been associated with nodes. operationId: ibmsGet responses: 200: description: Successfully retrieved the list of IBMS service instances schema: type: object default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Get list of all IBM service instances tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Read - ibmsRead x-view: ibms.2.0.json put: description: Create or update a single IBM service, and associate it with a node. operationId: ibmsPut parameters: - description: The IBM settings information to create in: body name: body required: true schema: $ref: '#/definitions/ssh-ibm-service_Ibm' responses: 201: description: Successfully put the IBM service schema: type: object 500: description: IBM service creation failed schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Put an IBM service tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Write - ibmsWrite x-swagger-schema: ibm x-view: ibms.2.0.json x-swagger-router-controller: ibms /ibms/definitions: get: description: Get a list of IBMS schemas, which define the properties required to create IBMS settings. operationId: ibmsDefinitionsGetAll responses: 200: description: Successfully retrieved a list of IBMS schemas schema: type: object default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Get list of IBMS services tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Read - ibmsRead x-swagger-router-controller: ibms /ibms/definitions/{name}: get: description: Get the contents of the specified IBMS service schema. operationId: ibmsDefinitionsGetByName parameters: - description: The IBMS service name in: path name: name required: true type: string responses: 200: description: Successfully retrieved the specified IBMS shcema schema: type: object default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Get an IBMS service definition tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Read - ibmsRead x-swagger-router-controller: ibms /ibms/{identifier}: delete: description: Delete the IBMS settings with the specified identifier. operationId: ibmsDeleteById parameters: - description: The IBMS service identifier in: path name: identifier required: true type: string responses: 204: description: Successfully deleted the specified IBMS settings schema: type: object 404: description: The IBMS service with the specified identifier was not found schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Delete IBMS settings tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Write - ibmsRemove get: description: Get the IBMS settings associated with the specified identifier operationId: ibmsGetById parameters: - description: The IBMS service identifier in: path name: identifier required: true type: string responses: 200: description: Successfully retrieved the specified IBMS service schema: type: object default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Get an IBMS service tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Read - ibmsRead x-view: ibms.2.0.json patch: description: Update the properties of the IBMS settings with the specified identifier. operationId: ibmsPatchById parameters: - description: The IBMS service identifier in: path name: identifier required: true type: string - description: The IBMS properties to patch in: body name: body required: true schema: $ref: '#/definitions/ssh-ibm-service_Ibm' responses: 200: description: Successfully patched the specified IBMS settings schema: type: object 500: description: IBMS patch failed schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Patch IBMS settings tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Write - ibmsModify x-swagger-schema: ibm x-swagger-router-controller: ibms /hooks: get: description: Get all hooks operationId: hooksGetAll responses: 200: description: Successfully retrieved the hook configuration schema: type: array items: $ref: "#/definitions/hooks.2.0_HookBase" default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Get all hooks tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Read - hooksRead x-view: hook.2.0.json post: consumes: - application/json description: Create a new hook. operationId: hooksPost parameters: - description: configuration hook to be created in: body name: body required: true schema: $ref: '#/definitions/hooks.2.0_HookPost' responses: 201: description: Successfully created new hook schema: type: object 409: description: Duplicated hook. schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Post a hook tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Write - hooksWrite x-swagger-schema: hooks.2.0.json#/definitions/HookPost x-view: hook.2.0.json x-swagger-router-controller: hooks /hooks/{identifier}: get: description: Get hook by id operationId: hooksGetById parameters: - description: id of the hook you wish to delete in: path name: identifier required: true type: string responses: 200: description: Successfully retrieved the specified hook schema: type: object default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Get a hook tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Read - hooksRead x-view: hook.2.0.json delete: description: Delete a hook based on hook id. operationId: hooksDelById parameters: - description: id of the hook you wish to delete in: path name: identifier required: true type: string responses: 204: description: Hook successfully deleted 404: description: Hook not found. schema: $ref: '#/definitions/Error' 500: description: Error deleting hook from the database schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Delete a hook tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Remove - hooksRemove patch: description: Modify the properties of a hook. operationId: hooksPatchById parameters: - description: The id of the hook to patch in: path name: identifier required: true type: string - description: The hook properties to be modified in: body name: body required: true schema: $ref: '#/definitions/hooks.2.0_HookBase' responses: 200: description: Successfully modified the hook schema: type: object 404: description: The specified hook was not found schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Patch a hook tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Write - hooksModify x-swagger-schema: hooks.2.0.json#/definitions/HookBase x-view: hook.2.0.json x-swagger-router-controller: hooks /lookups: get: description: Get a list of all lookups currently stored. Lookups relate mac addresses to ip addresses. operationId: lookupsGet parameters: - description: Query string specifying properties to search for in: query name: q required: false type: string responses: 200: description: Successfully retrieved the list of lookups schema: items: $ref: '#/definitions/Lookups.2.0_LookupBase' type: array default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Get a list of lookups tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Read - lookupsRead post: description: Create and store a new lookup. operationId: lookupsPost parameters: - description: The properties of the lookup in: body name: body required: true schema: $ref: '#/definitions/Lookups.2.0_LookupBase' responses: 201: description: Successfully created new lookup schema: $ref: '#/definitions/Lookups.2.0_LookupBase' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Post a lookup tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Write - lookupsWrite x-swagger-schema: lookups.2.0.json#/definitions/LookupPost x-swagger-router-controller: lookups /lookups/{id}: delete: description: Delete the specified lookup. operationId: lookupsDelById parameters: - description: The identifier of the lookup to delete in: path name: id required: true type: string responses: 204: description: Successfully deleted lookup 404: description: The specified lookup was not found schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Delete a lookup tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Write - lookupsRemove get: description: Get a lookup by specifying its identifier. operationId: lookupsGetById parameters: - description: The lookup identifier in: path name: id required: true type: string responses: 200: description: Successfully retrieved the lookup schema: items: $ref: '#/definitions/Lookups.2.0_LookupBase' type: array default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Get a lookup tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Read - lookupsRead patch: description: Modify the properties of a lookup. operationId: lookupsPatchById parameters: - description: The id of the lookup to patch in: path name: id required: true type: string - description: The lookup properties to be modified in: body name: body required: true schema: $ref: '#/definitions/Lookups.2.0_LookupBase' responses: 200: description: Successfully modified the lookup schema: $ref: '#/definitions/Lookups.2.0_LookupBase' 404: description: The specified lookup was not found schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Patch a lookup tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Write - lookupsModify x-swagger-schema: lookups.2.0.json#/definitions/LookupBase x-swagger-router-controller: lookups /nodes: get: description: Get a list of all currently stored nodes. operationId: nodesGetAll parameters: - description: Query string specifying properties to search for in: query name: $skip required: false type: integer - description: Query string specifying properties to search for in: query name: $top required: false type: integer - name: sort in: query description: Query string specifying properties to sort with required: false type: string pattern: '[- +]{0,1}(name|id)' responses: 200: description: Successfully retrieved the list of nodes schema: items: $ref: '#/definitions/node.2.0_GetNode' type: array 400: description: Bad Request schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Get a list of nodes tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Read - nodesRead x-view: node.2.0.json post: description: Create and store a new node manually. operationId: nodesPost parameters: - description: The properties of the new node in: body name: identifiers required: true schema: $ref: '#/definitions/node.2.0_PartialNode' responses: 201: description: Successfully created node schema: type: object default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Post a node tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Write - nodesWrite x-swagger-schema: node.2.0.json#/definitions/Node x-swagger-router-controller: nodes /nodes/tags/{tagName}: delete: description: Delete specified tag from all nodes. operationId: nodesMasterDelTagById parameters: - description: The tag identifier in: path name: tagName required: true type: string responses: 204: description: Successfully deleted tags 404: description: The tag name identifier was not found summary: Delete nodes tag tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Write - nodesRemove x-swagger-router-controller: nodes /nodes/{identifier}: delete: description: Delete the specified node. operationId: nodesDelById parameters: - description: The node identifier in: path name: identifier required: true type: string responses: 204: description: Successfully deleted the node 404: description: The specified node was not found schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Delete a node tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Write - nodesRemove get: description: Get all information on the specified node. operationId: nodesGetById parameters: - description: The node identifier in: path name: identifier required: true type: string responses: 200: description: Successfully retrieved the specified node schema: items: $ref: '#/definitions/node.2.0_GetNode' type: array 404: description: The specified node was not found schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Get a node tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Read - nodesRead x-view: node.2.0.json patch: description: Modify the properties of the specified node. operationId: nodesPatchById parameters: - description: The node identifier in: path name: identifier required: true type: string - description: The node properties to modify in: body name: body required: true schema: $ref: '#/definitions/node.2.0_PartialNode' responses: 200: description: Successfully modified the specified node schema: $ref: '#/definitions/node.2.0_PartialNode' 404: description: The specified node was not found schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Patch a node tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Write - nodesModify x-swagger-router-controller: nodes /nodes/{identifier}/catalogs: get: description: Get a list of all of the catalogs for the specified node. operationId: nodesGetCatalogById parameters: - description: The node identifier in: path name: identifier required: true type: string responses: 200: description: Successfully retrieved catalogs of specified node schema: type: object 404: description: The specified node was not found schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Get the catalogs for a node tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Read - catalogsRead x-view: catalogs.2.0.json x-swagger-router-controller: nodes /nodes/{identifier}/catalogs/{source}: get: description: Get a list of all of the catalogs for the specified node, containing the specified value of the source catalog property. operationId: nodesGetCatalogSourceById parameters: - description: The node identifier in: path name: identifier required: true type: string - description: The source catalog name to fetch in: path name: source required: true type: string responses: 200: description: Successfully retrieved specific source catalog of specified node schema: type: object 404: description: The specified node was not found schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Get the catalogs for a node by source tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Read - catalogsRead x-swagger-router-controller: nodes /nodes/{identifier}/obm: get: description: Get all the OBM settings for the specified node. operationId: nodesGetObmsByNodeId parameters: - description: The Node identifier in: path name: identifier required: true type: string responses: 200: description: Successfully retrieved the specified OBM service schema: type: array items: $ref: '#/definitions/obm' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Get all OBM services tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Read - obmsRead x-view: obm.2.0.json put: description: Create or update the specified OBM service with the associated Node ID operationId: nodesPutObmsByNodeId parameters: - description: The Node identifier in: path name: identifier required: true type: string - description: The OBM settings information to create in: body name: body required: true schema: $ref: '#/definitions/nodes_post_obm_by_id' responses: 201: description: Successfully put the OBM service schema: type: object 500: description: OBM service creation failed schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Put an OBM service tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Write - obmsWrite x-swagger-schema: obm x-view: obm.2.0.json x-swagger-router-controller: nodes /nodes/{identifier}/pollers: get: description: Get a list of all of the pollers for the specified node. operationId: nodesGetPollersById parameters: - description: The node identifier in: path name: identifier required: true type: string responses: 200: description: Successfully retrieved the pollers of specified node schema: type: array items: type: object 404: description: The specified node was not found schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Get the pollers for a node tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Read - pollersRead x-swagger-router-controller: nodes /nodes/{identifier}/relations: delete: description: Edit the relations fields of nodes to remove specific relationships operationId: nodesDelRelations parameters: - description: The node identifier in: path name: identifier required: true type: string - description: > A json object with relation types as keys and arrays of node ids as values. The nodes given relation types will be updated to remove the nodes given by id in: body name: content required: true schema: $ref: '#/definitions/generic_obj' responses: 204: description: Successfully removed the relations 404: description: The specified node was not found. schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Remove relations from a node tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Write - nodesRemove x-swagger-schema: relations.2.0.json#/definitions/Relation get: description: Get the relations field of the specified node operationId: nodesGetRelations parameters: - description: The node identifier in: path name: identifier required: true type: string responses: 200: description: Successfully retrieved the nodes relations schema: items: $ref: '#/definitions/relations_obj' type: array 404: description: The specified node was not found. schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Get a nodes relations tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Read - nodesRead put: description: Edit the relations fields of a specifc node to add one more relationships. operationId: nodesAddRelations parameters: - description: The identifier for the node in: path name: identifier required: true type: string - description: > A json object with relation types as keys and arrays of node ids as values. The nodes given relation types will be updated with the nodes given by id in: body name: content required: true schema: $ref: '#/definitions/generic_obj' responses: 200: description: Node relations update succeeded. schema: type: object 404: description: The specified node was not found. schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Add relationships between nodes tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Write - nodesModify x-swagger-schema: relations.2.0.json#/definitions/Relation x-swagger-router-controller: nodes /nodes/{identifier}/ssh: get: description: Get all of the ssh settings associated with the specified node. operationId: nodesGetSshById parameters: - description: The node identifier in: path name: identifier required: true type: string responses: 200: description: Successfully retrieved the ssh settings schema: type: object 404: description: The node with the identifier was not found or has no ssh settings. schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Get the ssh settings for a node tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Read - nodesRead post: description: Create the ssh settings associated with the specified node. operationId: nodesPostSshById parameters: - description: The node identifier in: path name: identifier required: true type: string - description: The ssh properties to create in: body name: body required: true schema: $ref: '#/definitions/ssh-ibm-service_Ibm' responses: 201: description: Successfull created ssh settings 404: description: The specified node was not found or has no ssh settings. schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Post ssh settings tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Write - nodesWrite x-swagger-schema: ibm x-swagger-router-controller: nodes /nodes/{identifier}/tags: get: description: Get a list of all tags associated with the specified node. operationId: nodesGetTagsById parameters: - description: The node identifier in: path name: identifier required: true type: string responses: 200: description: Successfully retrieved node tags schema: items: type: object type: array 404: description: The specified node was not found. schema: $ref: '#/definitions/Error' default: description: Unexpected error schema: $ref: '#/definitions/Error' summary: Get node tags tags: - /api/2.0 x-authentication-type: - jwt x-privileges: - Read - nodesRead patch: description: Modify the tag(s) associated with the specified node. operationId: nodes