{"type":"api","title":"Update the list of ports","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":"Update the list of ports for a specific node in a fabric. This is a complete replacement of the ports for a node in a fabric.","operationId":"nodesSetPorts","parameters":[{"description":"The fabric id or name.","in":"path","name":"fabricId","required":true,"schema":{"type":"string"}},{"description":"The node id or name.","in":"path","name":"nodeId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"examples":{"request":{"description":"An example request payload for an API call.","summary":"Example request","value":{"ports":[{"name":"Ethernet1_1","enabled":true,"roles":["FABRIC_PORT"]},{"name":"Ethernet1_2","enabled":true,"roles":["FABRIC_PORT"]},{"name":"Ethernet1_3","enabled":true,"roles":["FABRIC_PORT"]},{"name":"Ethernet1_4","enabled":true,"roles":["FABRIC_PORT"]}]},"$$ref":"#/components/examples/configSetPortsRequest"}},"schema":{"description":"The request to update the list of ports of a specific node in a fabric.","properties":{"ports":{"description":"The list of ports of the node.","items":{"description":"A Port encapsulates the configuration and properties of a front panel network interface of a node used as fabric port to interconnect with other nodes, as routed port to peer at Layer 3 with external devices, as Link Aggregation Group member or as a host port to connect to other endpoints via Layer 2 (VLAN).","nullable":true,"properties":{"annotations":{"description":"A list of name-value annotations to store user-defined data including complex data such as JSON associated with the port.","items":{"description":"Annotation defines a typed name/value pair to store user-defined data including complex data such as JSON.","nullable":true,"properties":{"dataType":{"default":"STRING","description":"DataType defines an enumeration of data types.","enum":["STRING","INT32","UINT32","INT64","UINT64","BOOL","TIME","UUID","DURATION","JSON"],"type":"string","$$ref":"#/components/schemas/modelsDataType"},"name":{"description":"The user-defined name used to uniquely identify the annotation.","type":"string"},"value":{"description":"The value of the annotation expressed as a string.","type":"string"}},"type":"object","$$ref":"#/components/schemas/modelsAnnotation"},"type":"array"},"breakout":{"description":"This is a read-only field. The flag that indicates if the port is in breakout mode or not.","readOnly":true,"type":"boolean"},"breakoutIndex":{"description":"This is a read-only field. The index number of the breakout in the parent port. The breakout index is not set when the port is not in breakout mode.","maximum":4294967295,"minimum":0,"readOnly":true,"type":"integer"},"description":{"description":"The description is a user-defined field to store notes about the port.","type":"string"},"enabled":{"description":"The enabled state of the port which indicates if the port is enabled or disabled.","type":"boolean"},"fec":{"description":"The Forward Error Correction (FEC) mode of the port. Supported modes are \"rs\" and \"none\". The FEC must be set to \"none\" for 100G DR/FR/LR pluggable optics.","type":"string"},"forceCounter":{"description":"The Force Counter can be incremented to force the port configuration to be forcefully reapplied when there are no other configuration changes such as to recover (un-shut) a port blocked by STP.","maximum":4294967295,"minimum":0,"type":"integer"},"id":{"description":"This is a read-only field. The unique identifier of the port.","readOnly":true,"type":"string"},"index":{"description":"This is a read-only field. The index number of the port on the linecard.","maximum":4294967295,"minimum":0,"readOnly":true,"type":"integer"},"ipv4Addresses":{"description":"A list of up to two IPv4 host addresses with subnet mask to be configured on the port. Requires the `ROUTED_PORT` role to be configured in roles and the port to be associated with a VRF.","items":{"type":"string"},"type":"array"},"ipv6Addresses":{"description":"A list of up to two IPv6 host addresses with subnet mask to be configured on the port. Requires the `ROUTED_PORT` role to be configured in roles and the port to be associated with a VRF.","items":{"type":"string"},"type":"array"},"labels":{"description":"A list of user-defined labels that can be used for grouping and filtering ports.","items":{"type":"string"},"type":"array"},"linecard":{"description":"This is a read-only field. The index number of the linecard to which this port belongs to.","maximum":4294967295,"minimum":0,"readOnly":true,"type":"integer"},"linkDown":{"description":"Prevent traffic from being forwarded by the port. Requires `enabled` to be set to `true` (equivalent to `Admin State` set to `Up`) and role to be one of `UNUSED_PORT`, `ROUTED_PORT` or `HOST_PORT`.","type":"boolean"},"maxSpeed":{"description":"This is a read-only field. The maximum speed of the port as reported by the system (E.g. 10G).","readOnly":true,"type":"string"},"metadata":{"description":"Metadata defines a map of attributes related to the lifecycle of the object.","nullable":true,"properties":{"createdAt":{"description":"This is a read-only field. The timestamp when this object was created in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8) format (e.g. `YYYY-MM-DDTHH:MM:SSZ`).","format":"date-time","readOnly":true,"type":"string"},"createdBy":{"description":"This is a read-only field. The identity provider and email of the user that created this object.","readOnly":true,"type":"string"},"modifiedAt":{"description":"This is a read-only field. The timestamp when this object was last modified in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8) format (e.g. `YYYY-MM-DDTHH:MM:SSZ`).","format":"date-time","readOnly":true,"type":"string"},"modifiedBy":{"description":"This is a read-only field. The identity provider and email of the user that modified this object last.","readOnly":true,"type":"string"},"revisionId":{"description":"This is a read-only field. An integer that represent the current revision of the object.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object","$$ref":"#/components/schemas/modelsMetadata"},"mtu":{"description":"The Maximum Transmission Unit (MTU) of the port of the node. Default value is 9216 for \"FABRIC_PORT\" and 9100 for all other roles. The MTU value must be 9216 for \"FABRIC_PORT\" and between 1500 and 9100 for all other roles.","maximum":4294967295,"minimum":0,"type":"integer"},"name":{"description":"The name of the port of the node. The name must have a prefix of Ethernet (E.g. Ethernet1_1) and cannot be modified.","type":"string"},"nodeId":{"description":"This is a read-only field. The unique identifier of the node to which this port belongs to.","readOnly":true,"type":"string"},"pluggable":{"description":"The name of the model (PID) of the pluggable cable or optic expected to be used in the port.","type":"string"},"portAlias":{"description":"The name alias of the port.","type":"string"},"roles":{"description":"A list of roles of the port. The port roles list is mandatory, and must contain exactly one role.","items":{"default":"UNUSED_PORT","description":"PortRole defines an enumeration of roles of ports or port channels.","enum":["UNUSED_PORT","FABRIC_PORT","HOST_PORT","ROUTED_PORT","LAG_PORT"],"type":"string","$$ref":"#/components/schemas/modelsPortRole"},"type":"array"},"speed":{"description":"The configurable speed mode of the port (E.g. 10G). The port speed cannot be set for a port in breakout mode.","type":"string"},"stp":{"description":"The Spanning Tree Protocol (STP) interface configuration for the port. The configuration is only used when a VLAN is deployed on the port.","nullable":true,"properties":{"bpduGuard":{"description":"BPDU guard enforces that the connected device does not send STP BPDUs on the port. If STP BPDUs are received on the port where BPDU guard is enabled the port will be automatically shutdown. User can re-enable the port administratively after ensuring the BPDUs have stopped coming on the port.","type":"boolean"},"enabled":{"description":"The enabled state of the Spanning Tree Protocol (STP) which indicates if STP is enabled or disabled on the port. Requires at least one of the other properties to also be enabled.","type":"boolean"},"portFast":{"description":"PortFast allows ports to move to forwarding state quickly when the connected device that is not participating in spanning tree. PortFast is enabled by default on all ports.","type":"boolean"},"rootGuard":{"description":"Root guard enforces the root bridge placement in the network and allows STP to interoperate with user network bridges while still maintaining the bridged network topology that the administrator requires. When BPDUs are received on a root guard enabled port, the STP state will be moved to \"Root inconsistent\" state to indicate this condition. Once the port stops receiving superior BPDUs, root guard will automatically set the port back to a FORWARDING state after the timeout period has expired.","type":"boolean"},"uplinkFast":{"description":"UplinkFast feature enhances STP performance for switches with redundant uplinks. Using the default value for the standard STP forward delay, convergence following a transition from an active link to a redundant link can take up to 30 seconds; 15 seconds for listening and an additional 15 seconds for learning. UplinkFast maintains a list of backup path to the root bridge and immediately move one of the backup paths to forwarding state to speed up the network recovery.","type":"boolean"}},"type":"object","$$ref":"#/components/schemas/modelsInterfaceStp"},"subInfCount":{"description":"This is a read-only field. The number of sub-interfaces configured on the port.","maximum":4294967295,"minimum":0,"readOnly":true,"type":"integer"},"vlanIds":{"description":"This is a read-only field. A list of VLAN IDs deployed on the port of the node.","items":{"maximum":4294967295,"minimum":0,"type":"integer"},"readOnly":true,"type":"array"},"vnis":{"description":"This is a read-only field. A list of VNIs attached to the port of the node.","items":{"maximum":4294967295,"minimum":0,"type":"integer"},"readOnly":true,"type":"array"},"vrfId":{"description":"The unique identifier of the VRF associated with the port. The VRF identifier is required for a port with the `ROUTED_PORT` role.","type":"string"}},"type":"object","$$ref":"#/components/schemas/modelsNetworkPort"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/configSetPortsRequest"}}},"description":"The request to update the list of ports of a specific node in a fabric.","required":true,"$$ref":"#/components/requestBodies/configSetPortsRequest"},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"description":"An example response to an API call.","summary":"Example response","value":{"nodeId":"eb48300a-ccc0-42f3-91a0-068dbbc2be2f","ports":[{"name":"Ethernet1_1","nodeId":"eb48300a-ccc0-42f3-91a0-068dbbc2be2f","enabled":true,"roles":["FABRIC_PORT"],"mtu":9216},{"name":"Ethernet1_2","nodeId":"eb48300a-ccc0-42f3-91a0-068dbbc2be2f","enabled":true,"roles":["FABRIC_PORT"],"mtu":9216},{"name":"Ethernet1_3","nodeId":"eb48300a-ccc0-42f3-91a0-068dbbc2be2f","enabled":true,"roles":["FABRIC_PORT"],"mtu":9216},{"name":"Ethernet1_4","nodeId":"eb48300a-ccc0-42f3-91a0-068dbbc2be2f","enabled":true,"roles":["FABRIC_PORT"],"mtu":9216}]},"$$ref":"#/components/examples/configSetPortsResponse"}},"schema":{"description":"The response returned to a request for the list of ports of a specific node in a fabric.","properties":{"ports":{"description":"The list of ports of the node.","items":{"description":"A Port encapsulates the configuration and properties of a front panel network interface of a node used as fabric port to interconnect with other nodes, as routed port to peer at Layer 3 with external devices, as Link Aggregation Group member or as a host port to connect to other endpoints via Layer 2 (VLAN).","nullable":true,"properties":{"annotations":{"description":"A list of name-value annotations to store user-defined data including complex data such as JSON associated with the port.","items":{"description":"Annotation defines a typed name/value pair to store user-defined data including complex data such as JSON.","nullable":true,"properties":{"dataType":{"default":"STRING","description":"DataType defines an enumeration of data types.","enum":["STRING","INT32","UINT32","INT64","UINT64","BOOL","TIME","UUID","DURATION","JSON"],"type":"string","$$ref":"#/components/schemas/modelsDataType"},"name":{"description":"The user-defined name used to uniquely identify the annotation.","type":"string"},"value":{"description":"The value of the annotation expressed as a string.","type":"string"}},"type":"object","$$ref":"#/components/schemas/modelsAnnotation"},"type":"array"},"breakout":{"description":"This is a read-only field. The flag that indicates if the port is in breakout mode or not.","readOnly":true,"type":"boolean"},"breakoutIndex":{"description":"This is a read-only field. The index number of the breakout in the parent port. The breakout index is not set when the port is not in breakout mode.","maximum":4294967295,"minimum":0,"readOnly":true,"type":"integer"},"description":{"description":"The description is a user-defined field to store notes about the port.","type":"string"},"enabled":{"description":"The enabled state of the port which indicates if the port is enabled or disabled.","type":"boolean"},"fec":{"description":"The Forward Error Correction (FEC) mode of the port. Supported modes are \"rs\" and \"none\". The FEC must be set to \"none\" for 100G DR/FR/LR pluggable optics.","type":"string"},"forceCounter":{"description":"The Force Counter can be incremented to force the port configuration to be forcefully reapplied when there are no other configuration changes such as to recover (un-shut) a port blocked by STP.","maximum":4294967295,"minimum":0,"type":"integer"},"id":{"description":"This is a read-only field. The unique identifier of the port.","readOnly":true,"type":"string"},"index":{"description":"This is a read-only field. The index number of the port on the linecard.","maximum":4294967295,"minimum":0,"readOnly":true,"type":"integer"},"ipv4Addresses":{"description":"A list of up to two IPv4 host addresses with subnet mask to be configured on the port. Requires the `ROUTED_PORT` role to be configured in roles and the port to be associated with a VRF.","items":{"type":"string"},"type":"array"},"ipv6Addresses":{"description":"A list of up to two IPv6 host addresses with subnet mask to be configured on the port. Requires the `ROUTED_PORT` role to be configured in roles and the port to be associated with a VRF.","items":{"type":"string"},"type":"array"},"labels":{"description":"A list of user-defined labels that can be used for grouping and filtering ports.","items":{"type":"string"},"type":"array"},"linecard":{"description":"This is a read-only field. The index number of the linecard to which this port belongs to.","maximum":4294967295,"minimum":0,"readOnly":true,"type":"integer"},"linkDown":{"description":"Prevent traffic from being forwarded by the port. Requires `enabled` to be set to `true` (equivalent to `Admin State` set to `Up`) and role to be one of `UNUSED_PORT`, `ROUTED_PORT` or `HOST_PORT`.","type":"boolean"},"maxSpeed":{"description":"This is a read-only field. The maximum speed of the port as reported by the system (E.g. 10G).","readOnly":true,"type":"string"},"metadata":{"description":"Metadata defines a map of attributes related to the lifecycle of the object.","nullable":true,"properties":{"createdAt":{"description":"This is a read-only field. The timestamp when this object was created in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8) format (e.g. `YYYY-MM-DDTHH:MM:SSZ`).","format":"date-time","readOnly":true,"type":"string"},"createdBy":{"description":"This is a read-only field. The identity provider and email of the user that created this object.","readOnly":true,"type":"string"},"modifiedAt":{"description":"This is a read-only field. The timestamp when this object was last modified in [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.8) format (e.g. `YYYY-MM-DDTHH:MM:SSZ`).","format":"date-time","readOnly":true,"type":"string"},"modifiedBy":{"description":"This is a read-only field. The identity provider and email of the user that modified this object last.","readOnly":true,"type":"string"},"revisionId":{"description":"This is a read-only field. An integer that represent the current revision of the object.","readOnly":true,"type":"string"}},"readOnly":true,"type":"object","$$ref":"#/components/schemas/modelsMetadata"},"mtu":{"description":"The Maximum Transmission Unit (MTU) of the port of the node. Default value is 9216 for \"FABRIC_PORT\" and 9100 for all other roles. The MTU value must be 9216 for \"FABRIC_PORT\" and between 1500 and 9100 for all other roles.","maximum":4294967295,"minimum":0,"type":"integer"},"name":{"description":"The name of the port of the node. The name must have a prefix of Ethernet (E.g. Ethernet1_1) and cannot be modified.","type":"string"},"nodeId":{"description":"This is a read-only field. The unique identifier of the node to which this port belongs to.","readOnly":true,"type":"string"},"pluggable":{"description":"The name of the model (PID) of the pluggable cable or optic expected to be used in the port.","type":"string"},"portAlias":{"description":"The name alias of the port.","type":"string"},"roles":{"description":"A list of roles of the port. The port roles list is mandatory, and must contain exactly one role.","items":{"default":"UNUSED_PORT","description":"PortRole defines an enumeration of roles of ports or port channels.","enum":["UNUSED_PORT","FABRIC_PORT","HOST_PORT","ROUTED_PORT","LAG_PORT"],"type":"string","$$ref":"#/components/schemas/modelsPortRole"},"type":"array"},"speed":{"description":"The configurable speed mode of the port (E.g. 10G). The port speed cannot be set for a port in breakout mode.","type":"string"},"stp":{"description":"The Spanning Tree Protocol (STP) interface configuration for the port. The configuration is only used when a VLAN is deployed on the port.","nullable":true,"properties":{"bpduGuard":{"description":"BPDU guard enforces that the connected device does not send STP BPDUs on the port. If STP BPDUs are received on the port where BPDU guard is enabled the port will be automatically shutdown. User can re-enable the port administratively after ensuring the BPDUs have stopped coming on the port.","type":"boolean"},"enabled":{"description":"The enabled state of the Spanning Tree Protocol (STP) which indicates if STP is enabled or disabled on the port. Requires at least one of the other properties to also be enabled.","type":"boolean"},"portFast":{"description":"PortFast allows ports to move to forwarding state quickly when the connected device that is not participating in spanning tree. PortFast is enabled by default on all ports.","type":"boolean"},"rootGuard":{"description":"Root guard enforces the root bridge placement in the network and allows STP to interoperate with user network bridges while still maintaining the bridged network topology that the administrator requires. When BPDUs are received on a root guard enabled port, the STP state will be moved to \"Root inconsistent\" state to indicate this condition. Once the port stops receiving superior BPDUs, root guard will automatically set the port back to a FORWARDING state after the timeout period has expired.","type":"boolean"},"uplinkFast":{"description":"UplinkFast feature enhances STP performance for switches with redundant uplinks. Using the default value for the standard STP forward delay, convergence following a transition from an active link to a redundant link can take up to 30 seconds; 15 seconds for listening and an additional 15 seconds for learning. UplinkFast maintains a list of backup path to the root bridge and immediately move one of the backup paths to forwarding state to speed up the network recovery.","type":"boolean"}},"type":"object","$$ref":"#/components/schemas/modelsInterfaceStp"},"subInfCount":{"description":"This is a read-only field. The number of sub-interfaces configured on the port.","maximum":4294967295,"minimum":0,"readOnly":true,"type":"integer"},"vlanIds":{"description":"This is a read-only field. A list of VLAN IDs deployed on the port of the node.","items":{"maximum":4294967295,"minimum":0,"type":"integer"},"readOnly":true,"type":"array"},"vnis":{"description":"This is a read-only field. A list of VNIs attached to the port of the node.","items":{"maximum":4294967295,"minimum":0,"type":"integer"},"readOnly":true,"type":"array"},"vrfId":{"description":"The unique identifier of the VRF associated with the port. The VRF identifier is required for a port with the `ROUTED_PORT` role.","type":"string"}},"type":"object","$$ref":"#/components/schemas/modelsNetworkPort"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/configPortsResponse"}}},"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":"Update the list of ports.","tags":["Nodes"],"__originalOperationId":"nodesSetPorts","method":"put","path":"/fabrics/{fabricId}/nodes/{nodeId}/ports"}}