Bind a specific device to a node - Cisco Nexus Hyperfabric API

{"type":"api","title":"Bind a specific device to a node","meta":{"id":"/apps/pubhub/media/tortuga-api-documentation/d051b07a38d4362ae89a672c6f998ecd945e9745/cbe9e4eb-3b67-3d77-bde8-9a8275c07620","info":{"contact":{"email":"hyperfabric-support@cisco.com","name":"Cisco Nexus Hyperfabric REST API","url":"https://hyperfabric.cisco.com"},"description":"Use this documentation to explore the API in detail.\n\nEach request will have a complete description of all the accepted parameters.\n\n## Authentication\n\nRequests are authenticated using Bearer Tokens. Tokens should be created from within the Hyperfabric service web UI and stored securely.\n\nSee the [bearer token](https://developer.cisco.com/docs/hyperfabric/authentication/#bearer-tokens) documentation page for more details.\n","license":{"name":"Cisco Licensing","url":"https://www.cisco.com/c/dam/en_us/about/doing_business/legal/Cisco_General_Terms.pdf"},"termsOfService":"https://www.cisco.com/c/dam/en_us/about/doing_business/legal/Cisco_General_Terms.pdf","title":"Cisco Nexus Hyperfabric REST API","version":"1.1.0-Rev.2025-10-29.838c8"},"security":[{"http":[]}],"tags":[{"description":"APIs for managing authorization, account, users, API keys and tokens.","name":"Auth"},{"description":"APIs for managing devices.","name":"Devices"},{"description":"APIs for managing fabrics, candidate configurations and fabric connections.","name":"Fabrics"},{"description":"APIs for network configuration.","name":"Networks"},{"description":"APIs for managing nodes, ports, port channels and other interfaces.","name":"Nodes"},{"description":"APIs for managing port channels on a fabric.","name":"Port Channels"},{"description":"APIs for managing VNIs","name":"Vnis"},{"description":"APIs for managing VRFs.","name":"Vrfs"}],"openapi":"3.0.3","servers":[{"description":"V1 Server","url":"https://hyperfabric.cisco.com/api/v1"}],"securitySchemes":{"http":{"bearerFormat":"JWT","description":"A bearer token issued by the service","scheme":"bearer","type":"http"}}},"spec":{"description":"Bind a specific device to a node in a fabric.","operationId":"devicesBindDevice","parameters":[{"description":"The fabric id or name.","in":"path","name":"fabricId","required":true,"schema":{"type":"string"}},{"description":"The node id or name of the node.","in":"path","name":"nodeId","required":true,"schema":{"type":"string"}},{"description":"The device id or name of the device to bind to the node.","in":"path","name":"deviceId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"description":"An example response to an API call.","summary":"Example response","value":{"nodeId":"node-leaf1","deviceId":"de-ad-00-00-05-84"},"$$ref":"#/components/examples/configBindDeviceResponse"}},"schema":{"description":"The response to a request to bind a specific device to a node in a fabric.","properties":{"deviceId":{"description":"The device id or name of the device to bind to the node.","type":"string"},"nodeId":{"description":"The node id or name of the node.","type":"string"}},"type":"object","$$ref":"#/components/schemas/configBindDeviceResponse"}}},"description":"OK","headers":{"Cache-Control":{"description":"Determines client caching behavior","example":"no-cache","schema":{"description":"Determines client caching behavior","type":"string"},"$$ref":"#/components/headers/cache-control"},"Content-Encoding":{"description":"The encoding the response data","example":"N/A","schema":{"description":"The encoding the response data","type":"string"},"$$ref":"#/components/headers/content-encoding"},"Content-Type":{"description":"The MIME type the response data","example":"application/json","schema":{"description":"The MIME type the response data","type":"string"},"$$ref":"#/components/headers/content-type"},"Date":{"description":"A timestamp when the response was processed","example":"Tue, 10 Sep 2024 17:02:52 GMT","schema":{"description":"A timestamp when the response was processed","pattern":"^(((Mon|Tue|Wed|Thu|Fri|Sat|Sun)),\\s[0-9]{1,2})\\s(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\\s([0-9]{4})\\s([0-9]{2}):([0-9]{2})(:([0-9]{2}))?\\sGMT$","type":"string"},"$$ref":"#/components/headers/date"},"TrackingID":{"description":"A unique value generated for the response for debugging purposes","example":"b4c08212-0a64-4edd-971a-d78562e1786f","schema":{"description":"A unique value generated for the response for debugging purposes","type":"string"},"$$ref":"#/components/headers/trackingid"}}},"400":{"content":{"application/json":{"examples":{"400":{"description":"Bad Request","summary":"Bad Request","value":{"message":"cannot parse value: not a valid value","field":"value","value":"123","status":400,"errCode":"ERR_CODE_INVALID_VALUE","trackingId":"TrackingId-a5767554-f150-47f5-8e94-425e802b25c9"},"$$ref":"#/components/examples/400"}},"schema":{"description":"A REST API Error is returned when the Hyperfabric service failed to execute the received REST API request to inform the user on the type of the error and other useful information for troubleshooting the request.","properties":{"causes":{"description":"A list of underlying causes.","items":{"type":"string"},"type":"array"},"critical":{"description":"The flag that indicates if the error is a critical error or not.","type":"boolean"},"errCode":{"default":"ERR_CODE_INTERNAL","description":"An error code provides additional information about a failed API request.","enum":["ERR_CODE_INTERNAL","ERR_CODE_INVALID_UUID","ERR_CODE_PERMISSION_DENIED","ERR_CODE_OUT_OF_RANGE","ERR_CODE_INVALID_TYPE","ERR_CODE_INVALID_VALUE","ERR_CODE_UNKNOWN_PARAMETER","ERR_CODE_SERVICE_UNAVAILABLE","ERR_CODE_NOT_FOUND","ERR_CODE_NOT_IMPLEMENTED","ERR_CODE_TOO_MANY_REQUESTS","ERR_CODE_NO_KNOWN_CODE","ERR_CODE_NO_REGISTERED_MARSHALERS","ERR_CODE_UNSUPPORTED_CONTENT_TYPE","ERR_CODE_DATA_CONFLICT","ERR_CODE_UNAUTHORIZED","ERR_CODE_READ_ONLY_FIELD","ERR_CODE_MISSING_REQUIRED_ARG","ERR_CODE_REQUEST_VALIDATION","ERR_CODE_INVALID_CLI_CMD","ERR_CODE_UNSUPPORTED_VALUE","ERR_CODE_JSON_UNMARSHAL_ERROR","ERR_CODE_JSON_MARSHAL_ERROR","ERR_CODE_JSON_NO_DATA","ERR_CODE_CSV_UNMARSHAL_ERROR","ERR_CODE_CSV_MARSHAL_ERROR","ERR_CODE_CSV_INVALID_DATA","ERR_CODE_CSV_UNKNOWN_HEADER","ERR_CODE_CSV_INVALID_VALUE","ERR_CODE_CSV_NO_DATA","ERR_CODE_YAML_NO_DATA","ERR_CODE_YAML_UNMARSHAL_ERROR","ERR_CODE_YAML_MARSHAL_ERROR","ERR_CODE_PEM_NO_DATA","ERR_CODE_PEM_UNMARSHAL_ERROR","ERR_CODE_PEM_MARSHAL_ERROR","ERR_CODE_PEM_INVALID_KEY_TYPE","ERR_CODE_PEM_INVALID_KEY_DATA","ERR_CODE_FORM_MARSHAL_ERROR","ERR_CODE_FORM_UNMARSHAL_ERROR","ERR_CODE_FORM_NO_DATA","ERR_CODE_NO_FABRICS_DEFINED","ERR_CODE_NO_FABRIC_CONNECTIONS_DEFINED","ERR_CODE_TOO_MANY_FABRICS_DEFINED","ERR_CODE_CHASSIS_ALREADY_ASSIGNED","ERR_CODE_NO_PORTS_FOR_CHASSIS","ERR_CODE_INVALID_CONFIRMATION_CODE","ERR_CODE_PROXY_UNKNOWN_ERROR","ERR_CODE_PROXY_TRANSPORT_ERROR","ERR_CODE_PROXY_UNKNOWN_ROUTE","ERR_CODE_PROXY_INVALID_WS_SVC","ERR_CODE_PROXY_INVALID_WS_PATH","ERR_CODE_PROXY_INVALID_WS_FABRIC_ID","ERR_CODE_PROXY_UNKNOWN_PATH_MAPPING","ERR_CODE_PROXY_AUTH_ERROR","ERR_CODE_PROXY_UNROUTABLE_APP","ERR_CODE_PROXY_NIL_ORG_SHARD_LOOKUP","ERR_CODE_PROXY_ORG_SHARD_LOOKUP_FAILED","ERR_CODE_PROXY_NO_ACTIVE_SHARD","ERR_CODE_PROXY_INVALID_ROUTING_POLICY","ERR_CODE_PROXY_LOAD_BALANCED_SVC_ROUTE_NOT_FOUND","ERR_CODE_PROXY_ASSIGNMENT_SVC_ROUTE_NOT_FOUND","ERR_CODE_PROXY_ASSIGNMENT_SVC_ROUTE_NOT_READY","ERR_CODE_PROXY_LOAD_BALANCED_HOST_PORT_INVALID","ERR_CODE_PROXY_ASSIGNMENT_HOST_PORT_INVALID","ERR_CODE_PROXY_CANNOT_ROUTE_NIL_ORG_ID","ERR_CODE_PROXY_CANNOT_ROUTE_NIL_FABRIC_ID","ERR_CODE_PROXY_CANNOT_ROUTE_BY_RESOURCE","ERR_CODE_PROXY_NO_SHARD_FOR_NEW_ORGS","ERR_CODE_PROXY_EMPTY_FABRIC_NAME","ERR_CODE_PROXY_UNKNOWN_FABRIC_NAME","ERR_CODE_PROXY_EMPTY_DEVICE_SERIAL","ERR_CODE_PROXY_UNKNOWN_DEVICE_SERIAL","ERR_CODE_PROXY_EMPTY_EMAIL","ERR_CODE_PROXY_UNKNOWN_EMAIL","ERR_CODE_PROXY_AUTH_ERROR_CLAIMS","ERR_CODE_PROXY_AUTH_ERROR_NO_ORG","ERR_CODE_PROXY_AUTH_ERROR_TYPE","ERR_CODE_PROXY_AUTH_ERROR_NO_FABRIC_FOR_DEVICE","ERR_CODE_PROXY_AUTH_ERROR_DEVICE_ID","ERR_CODE_PROXY_AUTH_ERROR_UNKNOWN_DEVICE","ERR_CODE_PROXY_AUTH_ERROR_FABRIC_MISMATCH","ERR_CODE_PROXY_RESOLVE_REDIRECT_LOCATION","ERR_CODE_PROXY_HEADER_FABRIC_ID_INVALID","ERR_CODE_PROXY_UNKNOWN_TENANT","ERR_CODE_PROXY_UNCLASSIFIED_ERROR"],"type":"string","$$ref":"#/components/schemas/commonErrCode"},"field":{"description":"The name of the relevant field.","type":"string"},"message":{"description":"The error message.","type":"string"},"notes":{"description":"Additional information about the error.","type":"string"},"status":{"description":"The HTTP status code associated with the error.","format":"int32","type":"integer"},"trackingId":{"description":"A unique identifier for each request, used for tracking purposes.","type":"string"},"value":{"description":"The value of the relevant field.","type":"string"}},"type":"object","$$ref":"#/components/schemas/commonRestError"}}},"description":"Bad Request","headers":{"Cache-Control":{"description":"Determines client caching behavior","example":"no-cache","schema":{"description":"Determines client caching behavior","type":"string"},"$$ref":"#/components/headers/cache-control"},"Content-Encoding":{"description":"The encoding the response data","example":"N/A","schema":{"description":"The encoding the response data","type":"string"},"$$ref":"#/components/headers/content-encoding"},"Content-Type":{"description":"The MIME type the response data","example":"application/json","schema":{"description":"The MIME type the response data","type":"string"},"$$ref":"#/components/headers/content-type"},"Date":{"description":"A timestamp when the response was processed","example":"Tue, 10 Sep 2024 17:02:52 GMT","schema":{"description":"A timestamp when the response was processed","pattern":"^(((Mon|Tue|Wed|Thu|Fri|Sat|Sun)),\\s[0-9]{1,2})\\s(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\\s([0-9]{4})\\s([0-9]{2}):([0-9]{2})(:([0-9]{2}))?\\sGMT$","type":"string"},"$$ref":"#/components/headers/date"},"TrackingID":{"description":"A unique value generated for the response for debugging purposes","example":"b4c08212-0a64-4edd-971a-d78562e1786f","schema":{"description":"A unique value generated for the response for debugging purposes","type":"string"},"$$ref":"#/components/headers/trackingid"}},"$$ref":"#/components/responses/400"},"401":{"content":{"application/json":{"examples":{"401":{"description":"Unauthorized","summary":"Unauthorized","value":{"message":"authorization failure","status":401,"errCode":"ERR_CODE_UNAUTHORIZED","trackingId":"TrackingId-32dee1eb-6447-4275-a441-b9a9bcd90bb7"},"$$ref":"#/components/examples/401"}},"schema":{"description":"A REST API Error is returned when the Hyperfabric service failed to execute the received REST API request to inform the user on the type of the error and other useful information for troubleshooting the request.","properties":{"causes":{"description":"A list of underlying causes.","items":{"type":"string"},"type":"array"},"critical":{"description":"The flag that indicates if the error is a critical error or not.","type":"boolean"},"errCode":{"default":"ERR_CODE_INTERNAL","description":"An error code provides additional information about a failed API request.","enum":["ERR_CODE_INTERNAL","ERR_CODE_INVALID_UUID","ERR_CODE_PERMISSION_DENIED","ERR_CODE_OUT_OF_RANGE","ERR_CODE_INVALID_TYPE","ERR_CODE_INVALID_VALUE","ERR_CODE_UNKNOWN_PARAMETER","ERR_CODE_SERVICE_UNAVAILABLE","ERR_CODE_NOT_FOUND","ERR_CODE_NOT_IMPLEMENTED","ERR_CODE_TOO_MANY_REQUESTS","ERR_CODE_NO_KNOWN_CODE","ERR_CODE_NO_REGISTERED_MARSHALERS","ERR_CODE_UNSUPPORTED_CONTENT_TYPE","ERR_CODE_DATA_CONFLICT","ERR_CODE_UNAUTHORIZED","ERR_CODE_READ_ONLY_FIELD","ERR_CODE_MISSING_REQUIRED_ARG","ERR_CODE_REQUEST_VALIDATION","ERR_CODE_INVALID_CLI_CMD","ERR_CODE_UNSUPPORTED_VALUE","ERR_CODE_JSON_UNMARSHAL_ERROR","ERR_CODE_JSON_MARSHAL_ERROR","ERR_CODE_JSON_NO_DATA","ERR_CODE_CSV_UNMARSHAL_ERROR","ERR_CODE_CSV_MARSHAL_ERROR","ERR_CODE_CSV_INVALID_DATA","ERR_CODE_CSV_UNKNOWN_HEADER","ERR_CODE_CSV_INVALID_VALUE","ERR_CODE_CSV_NO_DATA","ERR_CODE_YAML_NO_DATA","ERR_CODE_YAML_UNMARSHAL_ERROR","ERR_CODE_YAML_MARSHAL_ERROR","ERR_CODE_PEM_NO_DATA","ERR_CODE_PEM_UNMARSHAL_ERROR","ERR_CODE_PEM_MARSHAL_ERROR","ERR_CODE_PEM_INVALID_KEY_TYPE","ERR_CODE_PEM_INVALID_KEY_DATA","ERR_CODE_FORM_MARSHAL_ERROR","ERR_CODE_FORM_UNMARSHAL_ERROR","ERR_CODE_FORM_NO_DATA","ERR_CODE_NO_FABRICS_DEFINED","ERR_CODE_NO_FABRIC_CONNECTIONS_DEFINED","ERR_CODE_TOO_MANY_FABRICS_DEFINED","ERR_CODE_CHASSIS_ALREADY_ASSIGNED","ERR_CODE_NO_PORTS_FOR_CHASSIS","ERR_CODE_INVALID_CONFIRMATION_CODE","ERR_CODE_PROXY_UNKNOWN_ERROR","ERR_CODE_PROXY_TRANSPORT_ERROR","ERR_CODE_PROXY_UNKNOWN_ROUTE","ERR_CODE_PROXY_INVALID_WS_SVC","ERR_CODE_PROXY_INVALID_WS_PATH","ERR_CODE_PROXY_INVALID_WS_FABRIC_ID","ERR_CODE_PROXY_UNKNOWN_PATH_MAPPING","ERR_CODE_PROXY_AUTH_ERROR","ERR_CODE_PROXY_UNROUTABLE_APP","ERR_CODE_PROXY_NIL_ORG_SHARD_LOOKUP","ERR_CODE_PROXY_ORG_SHARD_LOOKUP_FAILED","ERR_CODE_PROXY_NO_ACTIVE_SHARD","ERR_CODE_PROXY_INVALID_ROUTING_POLICY","ERR_CODE_PROXY_LOAD_BALANCED_SVC_ROUTE_NOT_FOUND","ERR_CODE_PROXY_ASSIGNMENT_SVC_ROUTE_NOT_FOUND","ERR_CODE_PROXY_ASSIGNMENT_SVC_ROUTE_NOT_READY","ERR_CODE_PROXY_LOAD_BALANCED_HOST_PORT_INVALID","ERR_CODE_PROXY_ASSIGNMENT_HOST_PORT_INVALID","ERR_CODE_PROXY_CANNOT_ROUTE_NIL_ORG_ID","ERR_CODE_PROXY_CANNOT_ROUTE_NIL_FABRIC_ID","ERR_CODE_PROXY_CANNOT_ROUTE_BY_RESOURCE","ERR_CODE_PROXY_NO_SHARD_FOR_NEW_ORGS","ERR_CODE_PROXY_EMPTY_FABRIC_NAME","ERR_CODE_PROXY_UNKNOWN_FABRIC_NAME","ERR_CODE_PROXY_EMPTY_DEVICE_SERIAL","ERR_CODE_PROXY_UNKNOWN_DEVICE_SERIAL","ERR_CODE_PROXY_EMPTY_EMAIL","ERR_CODE_PROXY_UNKNOWN_EMAIL","ERR_CODE_PROXY_AUTH_ERROR_CLAIMS","ERR_CODE_PROXY_AUTH_ERROR_NO_ORG","ERR_CODE_PROXY_AUTH_ERROR_TYPE","ERR_CODE_PROXY_AUTH_ERROR_NO_FABRIC_FOR_DEVICE","ERR_CODE_PROXY_AUTH_ERROR_DEVICE_ID","ERR_CODE_PROXY_AUTH_ERROR_UNKNOWN_DEVICE","ERR_CODE_PROXY_AUTH_ERROR_FABRIC_MISMATCH","ERR_CODE_PROXY_RESOLVE_REDIRECT_LOCATION","ERR_CODE_PROXY_HEADER_FABRIC_ID_INVALID","ERR_CODE_PROXY_UNKNOWN_TENANT","ERR_CODE_PROXY_UNCLASSIFIED_ERROR"],"type":"string","$$ref":"#/components/schemas/commonErrCode"},"field":{"description":"The name of the relevant field.","type":"string"},"message":{"description":"The error message.","type":"string"},"notes":{"description":"Additional information about the error.","type":"string"},"status":{"description":"The HTTP status code associated with the error.","format":"int32","type":"integer"},"trackingId":{"description":"A unique identifier for each request, used for tracking purposes.","type":"string"},"value":{"description":"The value of the relevant field.","type":"string"}},"type":"object","$$ref":"#/components/schemas/commonRestError"}}},"description":"Unauthorized","headers":{"Cache-Control":{"description":"Determines client caching behavior","example":"no-cache","schema":{"description":"Determines client caching behavior","type":"string"},"$$ref":"#/components/headers/cache-control"},"Content-Encoding":{"description":"The encoding the response data","example":"N/A","schema":{"description":"The encoding the response data","type":"string"},"$$ref":"#/components/headers/content-encoding"},"Content-Type":{"description":"The MIME type the response data","example":"application/json","schema":{"description":"The MIME type the response data","type":"string"},"$$ref":"#/components/headers/content-type"},"Date":{"description":"A timestamp when the response was processed","example":"Tue, 10 Sep 2024 17:02:52 GMT","schema":{"description":"A timestamp when the response was processed","pattern":"^(((Mon|Tue|Wed|Thu|Fri|Sat|Sun)),\\s[0-9]{1,2})\\s(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\\s([0-9]{4})\\s([0-9]{2}):([0-9]{2})(:([0-9]{2}))?\\sGMT$","type":"string"},"$$ref":"#/components/headers/date"},"TrackingID":{"description":"A unique value generated for the response for debugging purposes","example":"b4c08212-0a64-4edd-971a-d78562e1786f","schema":{"description":"A unique value generated for the response for debugging purposes","type":"string"},"$$ref":"#/components/headers/trackingid"}},"$$ref":"#/components/responses/401"},"403":{"content":{"application/json":{"examples":{"403":{"description":"Forbidden","summary":"Forbidden","value":{"message":"insufficient privileges to access resource","status":403,"errCode":"ERR_CODE_PERMISSION_DENIED","trackingId":"TrackingId-c4b86cca-2d39-4269-9f94-1a0b7ff3dbb3"},"$$ref":"#/components/examples/403"}},"schema":{"description":"A REST API Error is returned when the Hyperfabric service failed to execute the received REST API request to inform the user on the type of the error and other useful information for troubleshooting the request.","properties":{"causes":{"description":"A list of underlying causes.","items":{"type":"string"},"type":"array"},"critical":{"description":"The flag that indicates if the error is a critical error or not.","type":"boolean"},"errCode":{"default":"ERR_CODE_INTERNAL","description":"An error code provides additional information about a failed API request.","enum":["ERR_CODE_INTERNAL","ERR_CODE_INVALID_UUID","ERR_CODE_PERMISSION_DENIED","ERR_CODE_OUT_OF_RANGE","ERR_CODE_INVALID_TYPE","ERR_CODE_INVALID_VALUE","ERR_CODE_UNKNOWN_PARAMETER","ERR_CODE_SERVICE_UNAVAILABLE","ERR_CODE_NOT_FOUND","ERR_CODE_NOT_IMPLEMENTED","ERR_CODE_TOO_MANY_REQUESTS","ERR_CODE_NO_KNOWN_CODE","ERR_CODE_NO_REGISTERED_MARSHALERS","ERR_CODE_UNSUPPORTED_CONTENT_TYPE","ERR_CODE_DATA_CONFLICT","ERR_CODE_UNAUTHORIZED","ERR_CODE_READ_ONLY_FIELD","ERR_CODE_MISSING_REQUIRED_ARG","ERR_CODE_REQUEST_VALIDATION","ERR_CODE_INVALID_CLI_CMD","ERR_CODE_UNSUPPORTED_VALUE","ERR_CODE_JSON_UNMARSHAL_ERROR","ERR_CODE_JSON_MARSHAL_ERROR","ERR_CODE_JSON_NO_DATA","ERR_CODE_CSV_UNMARSHAL_ERROR","ERR_CODE_CSV_MARSHAL_ERROR","ERR_CODE_CSV_INVALID_DATA","ERR_CODE_CSV_UNKNOWN_HEADER","ERR_CODE_CSV_INVALID_VALUE","ERR_CODE_CSV_NO_DATA","ERR_CODE_YAML_NO_DATA","ERR_CODE_YAML_UNMARSHAL_ERROR","ERR_CODE_YAML_MARSHAL_ERROR","ERR_CODE_PEM_NO_DATA","ERR_CODE_PEM_UNMARSHAL_ERROR","ERR_CODE_PEM_MARSHAL_ERROR","ERR_CODE_PEM_INVALID_KEY_TYPE","ERR_CODE_PEM_INVALID_KEY_DATA","ERR_CODE_FORM_MARSHAL_ERROR","ERR_CODE_FORM_UNMARSHAL_ERROR","ERR_CODE_FORM_NO_DATA","ERR_CODE_NO_FABRICS_DEFINED","ERR_CODE_NO_FABRIC_CONNECTIONS_DEFINED","ERR_CODE_TOO_MANY_FABRICS_DEFINED","ERR_CODE_CHASSIS_ALREADY_ASSIGNED","ERR_CODE_NO_PORTS_FOR_CHASSIS","ERR_CODE_INVALID_CONFIRMATION_CODE","ERR_CODE_PROXY_UNKNOWN_ERROR","ERR_CODE_PROXY_TRANSPORT_ERROR","ERR_CODE_PROXY_UNKNOWN_ROUTE","ERR_CODE_PROXY_INVALID_WS_SVC","ERR_CODE_PROXY_INVALID_WS_PATH","ERR_CODE_PROXY_INVALID_WS_FABRIC_ID","ERR_CODE_PROXY_UNKNOWN_PATH_MAPPING","ERR_CODE_PROXY_AUTH_ERROR","ERR_CODE_PROXY_UNROUTABLE_APP","ERR_CODE_PROXY_NIL_ORG_SHARD_LOOKUP","ERR_CODE_PROXY_ORG_SHARD_LOOKUP_FAILED","ERR_CODE_PROXY_NO_ACTIVE_SHARD","ERR_CODE_PROXY_INVALID_ROUTING_POLICY","ERR_CODE_PROXY_LOAD_BALANCED_SVC_ROUTE_NOT_FOUND","ERR_CODE_PROXY_ASSIGNMENT_SVC_ROUTE_NOT_FOUND","ERR_CODE_PROXY_ASSIGNMENT_SVC_ROUTE_NOT_READY","ERR_CODE_PROXY_LOAD_BALANCED_HOST_PORT_INVALID","ERR_CODE_PROXY_ASSIGNMENT_HOST_PORT_INVALID","ERR_CODE_PROXY_CANNOT_ROUTE_NIL_ORG_ID","ERR_CODE_PROXY_CANNOT_ROUTE_NIL_FABRIC_ID","ERR_CODE_PROXY_CANNOT_ROUTE_BY_RESOURCE","ERR_CODE_PROXY_NO_SHARD_FOR_NEW_ORGS","ERR_CODE_PROXY_EMPTY_FABRIC_NAME","ERR_CODE_PROXY_UNKNOWN_FABRIC_NAME","ERR_CODE_PROXY_EMPTY_DEVICE_SERIAL","ERR_CODE_PROXY_UNKNOWN_DEVICE_SERIAL","ERR_CODE_PROXY_EMPTY_EMAIL","ERR_CODE_PROXY_UNKNOWN_EMAIL","ERR_CODE_PROXY_AUTH_ERROR_CLAIMS","ERR_CODE_PROXY_AUTH_ERROR_NO_ORG","ERR_CODE_PROXY_AUTH_ERROR_TYPE","ERR_CODE_PROXY_AUTH_ERROR_NO_FABRIC_FOR_DEVICE","ERR_CODE_PROXY_AUTH_ERROR_DEVICE_ID","ERR_CODE_PROXY_AUTH_ERROR_UNKNOWN_DEVICE","ERR_CODE_PROXY_AUTH_ERROR_FABRIC_MISMATCH","ERR_CODE_PROXY_RESOLVE_REDIRECT_LOCATION","ERR_CODE_PROXY_HEADER_FABRIC_ID_INVALID","ERR_CODE_PROXY_UNKNOWN_TENANT","ERR_CODE_PROXY_UNCLASSIFIED_ERROR"],"type":"string","$$ref":"#/components/schemas/commonErrCode"},"field":{"description":"The name of the relevant field.","type":"string"},"message":{"description":"The error message.","type":"string"},"notes":{"description":"Additional information about the error.","type":"string"},"status":{"description":"The HTTP status code associated with the error.","format":"int32","type":"integer"},"trackingId":{"description":"A unique identifier for each request, used for tracking purposes.","type":"string"},"value":{"description":"The value of the relevant field.","type":"string"}},"type":"object","$$ref":"#/components/schemas/commonRestError"}}},"description":"Forbidden","headers":{"Cache-Control":{"description":"Determines client caching behavior","example":"no-cache","schema":{"description":"Determines client caching behavior","type":"string"},"$$ref":"#/components/headers/cache-control"},"Content-Encoding":{"description":"The encoding the response data","example":"N/A","schema":{"description":"The encoding the response data","type":"string"},"$$ref":"#/components/headers/content-encoding"},"Content-Type":{"description":"The MIME type the response data","example":"application/json","schema":{"description":"The MIME type the response data","type":"string"},"$$ref":"#/components/headers/content-type"},"Date":{"description":"A timestamp when the response was processed","example":"Tue, 10 Sep 2024 17:02:52 GMT","schema":{"description":"A timestamp when the response was processed","pattern":"^(((Mon|Tue|Wed|Thu|Fri|Sat|Sun)),\\s[0-9]{1,2})\\s(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\\s([0-9]{4})\\s([0-9]{2}):([0-9]{2})(:([0-9]{2}))?\\sGMT$","type":"string"},"$$ref":"#/components/headers/date"},"TrackingID":{"description":"A unique value generated for the response for debugging purposes","example":"b4c08212-0a64-4edd-971a-d78562e1786f","schema":{"description":"A unique value generated for the response for debugging purposes","type":"string"},"$$ref":"#/components/headers/trackingid"}},"$$ref":"#/components/responses/403"},"429":{"content":{"application/json":{"examples":{"429":{"description":"Too Many Requests","summary":"Too Many Requests","value":{"message":"too many requests","status":429,"errCode":"ERR_CODE_TOO_MANY_REQUESTS","trackingId":"TrackingId-2605e772-2369-4f94-bcee-a1386e05fd74"},"$$ref":"#/components/examples/429"}},"schema":{"description":"A REST API Error is returned when the Hyperfabric service failed to execute the received REST API request to inform the user on the type of the error and other useful information for troubleshooting the request.","properties":{"causes":{"description":"A list of underlying causes.","items":{"type":"string"},"type":"array"},"critical":{"description":"The flag that indicates if the error is a critical error or not.","type":"boolean"},"errCode":{"default":"ERR_CODE_INTERNAL","description":"An error code provides additional information about a failed API request.","enum":["ERR_CODE_INTERNAL","ERR_CODE_INVALID_UUID","ERR_CODE_PERMISSION_DENIED","ERR_CODE_OUT_OF_RANGE","ERR_CODE_INVALID_TYPE","ERR_CODE_INVALID_VALUE","ERR_CODE_UNKNOWN_PARAMETER","ERR_CODE_SERVICE_UNAVAILABLE","ERR_CODE_NOT_FOUND","ERR_CODE_NOT_IMPLEMENTED","ERR_CODE_TOO_MANY_REQUESTS","ERR_CODE_NO_KNOWN_CODE","ERR_CODE_NO_REGISTERED_MARSHALERS","ERR_CODE_UNSUPPORTED_CONTENT_TYPE","ERR_CODE_DATA_CONFLICT","ERR_CODE_UNAUTHORIZED","ERR_CODE_READ_ONLY_FIELD","ERR_CODE_MISSING_REQUIRED_ARG","ERR_CODE_REQUEST_VALIDATION","ERR_CODE_INVALID_CLI_CMD","ERR_CODE_UNSUPPORTED_VALUE","ERR_CODE_JSON_UNMARSHAL_ERROR","ERR_CODE_JSON_MARSHAL_ERROR","ERR_CODE_JSON_NO_DATA","ERR_CODE_CSV_UNMARSHAL_ERROR","ERR_CODE_CSV_MARSHAL_ERROR","ERR_CODE_CSV_INVALID_DATA","ERR_CODE_CSV_UNKNOWN_HEADER","ERR_CODE_CSV_INVALID_VALUE","ERR_CODE_CSV_NO_DATA","ERR_CODE_YAML_NO_DATA","ERR_CODE_YAML_UNMARSHAL_ERROR","ERR_CODE_YAML_MARSHAL_ERROR","ERR_CODE_PEM_NO_DATA","ERR_CODE_PEM_UNMARSHAL_ERROR","ERR_CODE_PEM_MARSHAL_ERROR","ERR_CODE_PEM_INVALID_KEY_TYPE","ERR_CODE_PEM_INVALID_KEY_DATA","ERR_CODE_FORM_MARSHAL_ERROR","ERR_CODE_FORM_UNMARSHAL_ERROR","ERR_CODE_FORM_NO_DATA","ERR_CODE_NO_FABRICS_DEFINED","ERR_CODE_NO_FABRIC_CONNECTIONS_DEFINED","ERR_CODE_TOO_MANY_FABRICS_DEFINED","ERR_CODE_CHASSIS_ALREADY_ASSIGNED","ERR_CODE_NO_PORTS_FOR_CHASSIS","ERR_CODE_INVALID_CONFIRMATION_CODE","ERR_CODE_PROXY_UNKNOWN_ERROR","ERR_CODE_PROXY_TRANSPORT_ERROR","ERR_CODE_PROXY_UNKNOWN_ROUTE","ERR_CODE_PROXY_INVALID_WS_SVC","ERR_CODE_PROXY_INVALID_WS_PATH","ERR_CODE_PROXY_INVALID_WS_FABRIC_ID","ERR_CODE_PROXY_UNKNOWN_PATH_MAPPING","ERR_CODE_PROXY_AUTH_ERROR","ERR_CODE_PROXY_UNROUTABLE_APP","ERR_CODE_PROXY_NIL_ORG_SHARD_LOOKUP","ERR_CODE_PROXY_ORG_SHARD_LOOKUP_FAILED","ERR_CODE_PROXY_NO_ACTIVE_SHARD","ERR_CODE_PROXY_INVALID_ROUTING_POLICY","ERR_CODE_PROXY_LOAD_BALANCED_SVC_ROUTE_NOT_FOUND","ERR_CODE_PROXY_ASSIGNMENT_SVC_ROUTE_NOT_FOUND","ERR_CODE_PROXY_ASSIGNMENT_SVC_ROUTE_NOT_READY","ERR_CODE_PROXY_LOAD_BALANCED_HOST_PORT_INVALID","ERR_CODE_PROXY_ASSIGNMENT_HOST_PORT_INVALID","ERR_CODE_PROXY_CANNOT_ROUTE_NIL_ORG_ID","ERR_CODE_PROXY_CANNOT_ROUTE_NIL_FABRIC_ID","ERR_CODE_PROXY_CANNOT_ROUTE_BY_RESOURCE","ERR_CODE_PROXY_NO_SHARD_FOR_NEW_ORGS","ERR_CODE_PROXY_EMPTY_FABRIC_NAME","ERR_CODE_PROXY_UNKNOWN_FABRIC_NAME","ERR_CODE_PROXY_EMPTY_DEVICE_SERIAL","ERR_CODE_PROXY_UNKNOWN_DEVICE_SERIAL","ERR_CODE_PROXY_EMPTY_EMAIL","ERR_CODE_PROXY_UNKNOWN_EMAIL","ERR_CODE_PROXY_AUTH_ERROR_CLAIMS","ERR_CODE_PROXY_AUTH_ERROR_NO_ORG","ERR_CODE_PROXY_AUTH_ERROR_TYPE","ERR_CODE_PROXY_AUTH_ERROR_NO_FABRIC_FOR_DEVICE","ERR_CODE_PROXY_AUTH_ERROR_DEVICE_ID","ERR_CODE_PROXY_AUTH_ERROR_UNKNOWN_DEVICE","ERR_CODE_PROXY_AUTH_ERROR_FABRIC_MISMATCH","ERR_CODE_PROXY_RESOLVE_REDIRECT_LOCATION","ERR_CODE_PROXY_HEADER_FABRIC_ID_INVALID","ERR_CODE_PROXY_UNKNOWN_TENANT","ERR_CODE_PROXY_UNCLASSIFIED_ERROR"],"type":"string","$$ref":"#/components/schemas/commonErrCode"},"field":{"description":"The name of the relevant field.","type":"string"},"message":{"description":"The error message.","type":"string"},"notes":{"description":"Additional information about the error.","type":"string"},"status":{"description":"The HTTP status code associated with the error.","format":"int32","type":"integer"},"trackingId":{"description":"A unique identifier for each request, used for tracking purposes.","type":"string"},"value":{"description":"The value of the relevant field.","type":"string"}},"type":"object","$$ref":"#/components/schemas/commonRestError"}}},"description":"Too Many Requests","headers":{"Cache-Control":{"description":"Determines client caching behavior","example":"no-cache","schema":{"description":"Determines client caching behavior","type":"string"},"$$ref":"#/components/headers/cache-control"},"Content-Encoding":{"description":"The encoding the response data","example":"N/A","schema":{"description":"The encoding the response data","type":"string"},"$$ref":"#/components/headers/content-encoding"},"Content-Type":{"description":"The MIME type the response data","example":"application/json","schema":{"description":"The MIME type the response data","type":"string"},"$$ref":"#/components/headers/content-type"},"Date":{"description":"A timestamp when the response was processed","example":"Tue, 10 Sep 2024 17:02:52 GMT","schema":{"description":"A timestamp when the response was processed","pattern":"^(((Mon|Tue|Wed|Thu|Fri|Sat|Sun)),\\s[0-9]{1,2})\\s(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\\s([0-9]{4})\\s([0-9]{2}):([0-9]{2})(:([0-9]{2}))?\\sGMT$","type":"string"},"$$ref":"#/components/headers/date"},"TrackingID":{"description":"A unique value generated for the response for debugging purposes","example":"b4c08212-0a64-4edd-971a-d78562e1786f","schema":{"description":"A unique value generated for the response for debugging purposes","type":"string"},"$$ref":"#/components/headers/trackingid"}},"$$ref":"#/components/responses/429"},"500":{"content":{"application/json":{"examples":{"500":{"description":"Internal Server Error","summary":"Internal Server Error","value":{"message":"an internal error has occurred","status":500,"errCode":"ERR_CODE_INTERNAL","trackingId":"TrackingId-a619a6f4-36a5-4296-a636-7dd98f5c5657"},"$$ref":"#/components/examples/500"}},"schema":{"description":"A REST API Error is returned when the Hyperfabric service failed to execute the received REST API request to inform the user on the type of the error and other useful information for troubleshooting the request.","properties":{"causes":{"description":"A list of underlying causes.","items":{"type":"string"},"type":"array"},"critical":{"description":"The flag that indicates if the error is a critical error or not.","type":"boolean"},"errCode":{"default":"ERR_CODE_INTERNAL","description":"An error code provides additional information about a failed API request.","enum":["ERR_CODE_INTERNAL","ERR_CODE_INVALID_UUID","ERR_CODE_PERMISSION_DENIED","ERR_CODE_OUT_OF_RANGE","ERR_CODE_INVALID_TYPE","ERR_CODE_INVALID_VALUE","ERR_CODE_UNKNOWN_PARAMETER","ERR_CODE_SERVICE_UNAVAILABLE","ERR_CODE_NOT_FOUND","ERR_CODE_NOT_IMPLEMENTED","ERR_CODE_TOO_MANY_REQUESTS","ERR_CODE_NO_KNOWN_CODE","ERR_CODE_NO_REGISTERED_MARSHALERS","ERR_CODE_UNSUPPORTED_CONTENT_TYPE","ERR_CODE_DATA_CONFLICT","ERR_CODE_UNAUTHORIZED","ERR_CODE_READ_ONLY_FIELD","ERR_CODE_MISSING_REQUIRED_ARG","ERR_CODE_REQUEST_VALIDATION","ERR_CODE_INVALID_CLI_CMD","ERR_CODE_UNSUPPORTED_VALUE","ERR_CODE_JSON_UNMARSHAL_ERROR","ERR_CODE_JSON_MARSHAL_ERROR","ERR_CODE_JSON_NO_DATA","ERR_CODE_CSV_UNMARSHAL_ERROR","ERR_CODE_CSV_MARSHAL_ERROR","ERR_CODE_CSV_INVALID_DATA","ERR_CODE_CSV_UNKNOWN_HEADER","ERR_CODE_CSV_INVALID_VALUE","ERR_CODE_CSV_NO_DATA","ERR_CODE_YAML_NO_DATA","ERR_CODE_YAML_UNMARSHAL_ERROR","ERR_CODE_YAML_MARSHAL_ERROR","ERR_CODE_PEM_NO_DATA","ERR_CODE_PEM_UNMARSHAL_ERROR","ERR_CODE_PEM_MARSHAL_ERROR","ERR_CODE_PEM_INVALID_KEY_TYPE","ERR_CODE_PEM_INVALID_KEY_DATA","ERR_CODE_FORM_MARSHAL_ERROR","ERR_CODE_FORM_UNMARSHAL_ERROR","ERR_CODE_FORM_NO_DATA","ERR_CODE_NO_FABRICS_DEFINED","ERR_CODE_NO_FABRIC_CONNECTIONS_DEFINED","ERR_CODE_TOO_MANY_FABRICS_DEFINED","ERR_CODE_CHASSIS_ALREADY_ASSIGNED","ERR_CODE_NO_PORTS_FOR_CHASSIS","ERR_CODE_INVALID_CONFIRMATION_CODE","ERR_CODE_PROXY_UNKNOWN_ERROR","ERR_CODE_PROXY_TRANSPORT_ERROR","ERR_CODE_PROXY_UNKNOWN_ROUTE","ERR_CODE_PROXY_INVALID_WS_SVC","ERR_CODE_PROXY_INVALID_WS_PATH","ERR_CODE_PROXY_INVALID_WS_FABRIC_ID","ERR_CODE_PROXY_UNKNOWN_PATH_MAPPING","ERR_CODE_PROXY_AUTH_ERROR","ERR_CODE_PROXY_UNROUTABLE_APP","ERR_CODE_PROXY_NIL_ORG_SHARD_LOOKUP","ERR_CODE_PROXY_ORG_SHARD_LOOKUP_FAILED","ERR_CODE_PROXY_NO_ACTIVE_SHARD","ERR_CODE_PROXY_INVALID_ROUTING_POLICY","ERR_CODE_PROXY_LOAD_BALANCED_SVC_ROUTE_NOT_FOUND","ERR_CODE_PROXY_ASSIGNMENT_SVC_ROUTE_NOT_FOUND","ERR_CODE_PROXY_ASSIGNMENT_SVC_ROUTE_NOT_READY","ERR_CODE_PROXY_LOAD_BALANCED_HOST_PORT_INVALID","ERR_CODE_PROXY_ASSIGNMENT_HOST_PORT_INVALID","ERR_CODE_PROXY_CANNOT_ROUTE_NIL_ORG_ID","ERR_CODE_PROXY_CANNOT_ROUTE_NIL_FABRIC_ID","ERR_CODE_PROXY_CANNOT_ROUTE_BY_RESOURCE","ERR_CODE_PROXY_NO_SHARD_FOR_NEW_ORGS","ERR_CODE_PROXY_EMPTY_FABRIC_NAME","ERR_CODE_PROXY_UNKNOWN_FABRIC_NAME","ERR_CODE_PROXY_EMPTY_DEVICE_SERIAL","ERR_CODE_PROXY_UNKNOWN_DEVICE_SERIAL","ERR_CODE_PROXY_EMPTY_EMAIL","ERR_CODE_PROXY_UNKNOWN_EMAIL","ERR_CODE_PROXY_AUTH_ERROR_CLAIMS","ERR_CODE_PROXY_AUTH_ERROR_NO_ORG","ERR_CODE_PROXY_AUTH_ERROR_TYPE","ERR_CODE_PROXY_AUTH_ERROR_NO_FABRIC_FOR_DEVICE","ERR_CODE_PROXY_AUTH_ERROR_DEVICE_ID","ERR_CODE_PROXY_AUTH_ERROR_UNKNOWN_DEVICE","ERR_CODE_PROXY_AUTH_ERROR_FABRIC_MISMATCH","ERR_CODE_PROXY_RESOLVE_REDIRECT_LOCATION","ERR_CODE_PROXY_HEADER_FABRIC_ID_INVALID","ERR_CODE_PROXY_UNKNOWN_TENANT","ERR_CODE_PROXY_UNCLASSIFIED_ERROR"],"type":"string","$$ref":"#/components/schemas/commonErrCode"},"field":{"description":"The name of the relevant field.","type":"string"},"message":{"description":"The error message.","type":"string"},"notes":{"description":"Additional information about the error.","type":"string"},"status":{"description":"The HTTP status code associated with the error.","format":"int32","type":"integer"},"trackingId":{"description":"A unique identifier for each request, used for tracking purposes.","type":"string"},"value":{"description":"The value of the relevant field.","type":"string"}},"type":"object","$$ref":"#/components/schemas/commonRestError"}}},"description":"Internal Server Error","headers":{"Cache-Control":{"description":"Determines client caching behavior","example":"no-cache","schema":{"description":"Determines client caching behavior","type":"string"},"$$ref":"#/components/headers/cache-control"},"Content-Encoding":{"description":"The encoding the response data","example":"N/A","schema":{"description":"The encoding the response data","type":"string"},"$$ref":"#/components/headers/content-encoding"},"Content-Type":{"description":"The MIME type the response data","example":"application/json","schema":{"description":"The MIME type the response data","type":"string"},"$$ref":"#/components/headers/content-type"},"Date":{"description":"A timestamp when the response was processed","example":"Tue, 10 Sep 2024 17:02:52 GMT","schema":{"description":"A timestamp when the response was processed","pattern":"^(((Mon|Tue|Wed|Thu|Fri|Sat|Sun)),\\s[0-9]{1,2})\\s(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\\s([0-9]{4})\\s([0-9]{2}):([0-9]{2})(:([0-9]{2}))?\\sGMT$","type":"string"},"$$ref":"#/components/headers/date"},"TrackingID":{"description":"A unique value generated for the response for debugging purposes","example":"b4c08212-0a64-4edd-971a-d78562e1786f","schema":{"description":"A unique value generated for the response for debugging purposes","type":"string"},"$$ref":"#/components/headers/trackingid"}},"$$ref":"#/components/responses/500"}},"security":[{"http":[]}],"summary":"Bind a specific device to a node.","tags":["Devices"],"__originalOperationId":"devicesBindDevice","method":"put","path":"/fabrics/{fabricId}/nodes/{nodeId}/devices/{deviceId}"}}