Get a specific VRF - Cisco Nexus Hyperfabric API

{"type":"api","title":"Get a specific VRF","meta":{"id":"/apps/pubhub/media/tortuga-api-documentation/3cc3d8999db06d62b96cfb1550f6aea184cf267d/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.2.0-Rev.2026-02-17.c08d0"},"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 monitoring fabrics.","name":"Monitor"},{"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":"Get a specific VRF in a fabric.","operationId":"vrfsGetFabricVrf","parameters":[{"description":"The fabric id or name.","in":"path","name":"fabricId","required":true,"schema":{"type":"string"}},{"description":"The VRF id or name.","in":"path","name":"vrfId","required":true,"schema":{"type":"string"}},{"description":"The candidate configuration name. If not set the default candidate configuration values are returned.","in":"query","name":"candidate","schema":{"type":"string"}},{"description":"Include object metadata in the response.","in":"query","name":"includeMetadata","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"description":"An example response to an API call.","summary":"Example response","value":{"id":"bda7fee1-0d1b-482a-b72c-504bafb0254b","name":"Vrf12000000","enabled":true,"metadata":{"revisionId":"1","createdBy":"cisco/hyperfabric-example@cisco.com","createdAt":"2024-09-07T23:49:54.596634Z","modifiedBy":"cisco/hyperfabric-example@cisco.com","modifiedAt":"2024-09-07T23:49:54.596634Z"},"fabricId":"9f979318-d0b1-44d1-be40-b7d7ac6ecbfa","isDefault":true,"vni":12000000},"$$ref":"#/components/examples/configGetFabricVrfResponse"}},"schema":{"description":"A VRF is a virtual-routing-and-forwarding instance that represents a routing table deployed across nodes in the fabric to implement VRF-lite and the ability to have multiple routing tables on a single device. A VRF can be associated to multiple VNIs configured with an Anycast Gateway SVI.","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 VRF.","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"},"asn":{"description":"The Autonomous System Number (ASN) used for the VRF external BGP peering.","maximum":4294967295,"minimum":0,"type":"integer"},"description":{"description":"The description is a user-defined field to store notes about the VRF.","type":"string"},"enabled":{"description":"This is a read-only field. The enabled state of the VRF which indicates if the VRF is enabled or disabled.","readOnly":true,"type":"boolean"},"fabricId":{"description":"This is a read-only field. The unique identifier of the fabric to which this VRF belongs to.","readOnly":true,"type":"string"},"id":{"description":"This is a read-only field. The unique identifier of the VRF.","readOnly":true,"type":"string"},"interfaces":{"description":"This is a read-only field. A list of interfaces that are associated with the VRF.","items":{"description":"NetworkInterface encapsulates properties of a network interface attached to a VRF. A NetworkInterface maybe a network port, VLAN interface (SVI), loopback, port channel or a sub-interface.","nullable":true,"properties":{"ipv4Addresses":{"description":"IPv4 addresses of network interface. IPv4 addresses are readonly, and are set by some APIs (E.g. GetVrfs API when NeedIps is set to true).","items":{"type":"string"},"type":"array"},"ipv6Addresses":{"description":"IPv6 addresses of network interface. IPv6 addresses are readonly, and are set by some APIs (E.g. GetVrfs API when NeedIps is set to true).","items":{"type":"string"},"type":"array"},"name":{"description":"The name of the network interface.","type":"string"},"nodeId":{"description":"The node identifier where the interface is located. API users may specify either node name or node identifier.","type":"string"},"type":{"default":"NETWORK_PORT_INTERFACE","description":"InterfaceType defines an enumeration of network interface types.","enum":["NETWORK_PORT_INTERFACE","LOOPBACK_INTERFACE","VLAN_INTERFACE","PORT_CHANNEL_INTERFACE","SUB_PORT_INTERFACE"],"type":"string","$$ref":"#/components/schemas/modelsInterfaceType"},"vlanId":{"description":"VLAN identifier - required only for VLAN interface. Name field is ignored when VlanId is specified.","maximum":4294967295,"minimum":0,"type":"integer"},"vni":{"description":"The parent VNI of the VLAN. Valid only for VLAN interfaces.","maximum":4294967295,"minimum":0,"type":"integer"}},"type":"object","$$ref":"#/components/schemas/modelsNetworkInterface"},"readOnly":true,"type":"array"},"isDefault":{"description":"This is a read-only field. The flag that indicates if the VRF is the default (auto-created) VRF or not.","readOnly":true,"type":"boolean"},"labels":{"description":"A list of user-defined labels that can be used for grouping and filtering VRFs.","items":{"type":"string"},"type":"array"},"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.","format":"An int64 value formatted as a string","readOnly":true,"type":"string"}},"readOnly":true,"type":"object","$$ref":"#/components/schemas/modelsMetadata"},"name":{"description":"The user-defined name of the VRF. The VRF name has to be unique, and is case-insensitive. The name should start with `Vrf`, `VRF`, `VRf` or `VrF`, followed by an optional `-` separator and end with an alpha-numeric string of 1 to 16 character.","type":"string"},"vni":{"description":"The VXLAN Network Identifier (VNI) used for the VRF.","maximum":4294967295,"minimum":0,"type":"integer"}},"type":"object","$$ref":"#/components/schemas/modelsVrf"}}},"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.","nullable":true,"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_EMPTY_CUI_TENANT_ID","ERR_CODE_PROXY_UNKNOWN_CUI_TENANT_ID","ERR_CODE_PROXY_UNCLASSIFIED_ERROR","ERR_CODE_DELETED_FABRIC_EXCEED_RETENTION_WINDOW","ERR_CODE_DELETED_FABRIC_NOT_FOUND","ERR_CODE_CLAIMS_UNKNOWN_DEVICE","ERR_CODE_CLAIMS_ORG_MISMATCH","ERR_CODE_CLAIMS_FABRIC_MISMATCH"],"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.","nullable":true,"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_EMPTY_CUI_TENANT_ID","ERR_CODE_PROXY_UNKNOWN_CUI_TENANT_ID","ERR_CODE_PROXY_UNCLASSIFIED_ERROR","ERR_CODE_DELETED_FABRIC_EXCEED_RETENTION_WINDOW","ERR_CODE_DELETED_FABRIC_NOT_FOUND","ERR_CODE_CLAIMS_UNKNOWN_DEVICE","ERR_CODE_CLAIMS_ORG_MISMATCH","ERR_CODE_CLAIMS_FABRIC_MISMATCH"],"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.","nullable":true,"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_EMPTY_CUI_TENANT_ID","ERR_CODE_PROXY_UNKNOWN_CUI_TENANT_ID","ERR_CODE_PROXY_UNCLASSIFIED_ERROR","ERR_CODE_DELETED_FABRIC_EXCEED_RETENTION_WINDOW","ERR_CODE_DELETED_FABRIC_NOT_FOUND","ERR_CODE_CLAIMS_UNKNOWN_DEVICE","ERR_CODE_CLAIMS_ORG_MISMATCH","ERR_CODE_CLAIMS_FABRIC_MISMATCH"],"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.","nullable":true,"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_EMPTY_CUI_TENANT_ID","ERR_CODE_PROXY_UNKNOWN_CUI_TENANT_ID","ERR_CODE_PROXY_UNCLASSIFIED_ERROR","ERR_CODE_DELETED_FABRIC_EXCEED_RETENTION_WINDOW","ERR_CODE_DELETED_FABRIC_NOT_FOUND","ERR_CODE_CLAIMS_UNKNOWN_DEVICE","ERR_CODE_CLAIMS_ORG_MISMATCH","ERR_CODE_CLAIMS_FABRIC_MISMATCH"],"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.","nullable":true,"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_EMPTY_CUI_TENANT_ID","ERR_CODE_PROXY_UNKNOWN_CUI_TENANT_ID","ERR_CODE_PROXY_UNCLASSIFIED_ERROR","ERR_CODE_DELETED_FABRIC_EXCEED_RETENTION_WINDOW","ERR_CODE_DELETED_FABRIC_NOT_FOUND","ERR_CODE_CLAIMS_UNKNOWN_DEVICE","ERR_CODE_CLAIMS_ORG_MISMATCH","ERR_CODE_CLAIMS_FABRIC_MISMATCH"],"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":"Get a specific VRF.","tags":["Vrfs"],"__originalOperationId":"vrfsGetFabricVrf","method":"get","path":"/fabrics/{fabricId}/vrfs/{vrfId}"}}