Use the connection you already know!

LXI API Schemas

LXI defines a REST HTTP API that utilizes XSD schemas to define the parameters for the REST operations. This page contains references to the most current, and historical versions of those schemas.

For details on the APIs, the schemas, and their use, see the LXI API Extended Function here.

The schemas are in XSD format and do not return formatted HTML pages.

The schemas are maintained in the LXI github/azure source repository. For access contact the LXI consortium.



LXI Certificate List Schema

The LXI Certificate List schema represents a list of X.509 certificates, certificate chains, and CSR (Certificate Signing Requests) currently on the device.

The returned list of certificates includes a GUID that the client can use to delete the certificate.


Version Description XML Namespace (and LXI URL)
1.0 Initial Version http://lxistandard.org/schemas/LXICertificateList/1.0


LXI Certificate Reference Schema

The LXI Certificate Reference Schema indicates a single X.509 certificate, certificate chain, or CSR (Certificate Signing Request) that is on the device.

The certificate is not included in this schema, rather the entity on the device is identified using a GUID. The GUID is assigned by the device and is returned by the Certificate List API.


Version Description XML Namespace (and LXI URL)
1.0 Initial Version http://lxistandard.org/schemas/LXICertificateRef/1.0


LXI Certificate Request Schema

The LXI Certificate Request schema is used by both the getCSR and createCertificate APIs for the client to specify attributes of the certificate it is requesting.


Version Description XML Namespace (and LXI URL)
1.0 Initial Version http://lxistandard.org/schemas/LXICertificateRequest/1.0


LXI Common Configuration

The LXI Common Configuration XML schema is specified by the LXI Consortium as part of the LXI Security Extended Function.

LXICommonConfiguration contains settings related to the device secure configuration. This includes the configuration of the network interface, configuration of various network protocols and client authentication information.

This schema is used to:

  • Configure the security settings of a device
  • Interrogate a device to determine its security settings
  • Interrogate a device to determine its security capabilities

Version Description XML Namespace (and LXI URL)
1.0 Initial Version http://www.lxistandard.org/schemas/LXICommonConfiguration/1.0


LXI Device Specific Configuration

The LXI Device Specific Configuration represents device-specific or automatically configured network settings of the device network interface. If the device configuration enables automatic configuration, such as DHCP, any configuration specified in the LXI Device Specific Configuration Schema may be superseded.


Version Description XML Namespace (and LXI URL)
1.0 Initial Version http://lxistandard.org/schemas/LXIDeviceSpecificConfiguration/1.0


LXI Instrument Identification

The LXI Identification schema represents LXI device identity information, and identity information for devices that are connected to an LXI device.


Version Description XML Namespace (and LXI URL)
2.01 Corrected comments in the 2.00 version. Added version number, approval date, and revision history. No functional changes. http://www.lxistandard.org/InstrumentIdentification/1.0
2.00 Updated to accommodate LXI extended features, deprecate the LXIClass element. Validates both LXI 1.3 and 1.4 identification documents. Not Available
1.00 Initial version associated with the LXI 1.2 standard. Not Available


LXI Literals Schema

The LXI Literals schema contains a single element with optional arbitrary attributes. It is used to pass arbitrary data to a method. As such, it does not provide syntactic validation of parameters.

This schema is intended to be used by methods that require minimal parameters, and would derive very little benefit from schema-based syntactic validation.

Methods that utilize this schema must document the attribute names and types used.


Version Description XML Namespace (and LXI URL)
1.0 Initial Version http://lxistandard.org/schemas/LXILiterals/1.0


LXI Pending Details Schema

The LXI Pending Details schema provides detailed explanation from the server regarding HTTP operations that return an HTTP status of 202. The HTTP status of 202 indicates that the operation is pending.


Version Description XML Namespace (and LXI URL)
1.0 Initial Version http://lxistandard.org/schemas/LXIPendingDetails/1.0


LXI Problem Details Schema

The LXI Problem Details schema provides detailed explanation from the device regarding HTTP operations that do not have an implicit response. Further detail could be an explanation of error conditions, or other device status regarding the invoked method.

If the HTTP response is OK (200), the LXIProblemDetails response is not required.

For some use cases, such as determining authentication requirements, it may be appropriate for a client to intentionally generate an HTTP error then use this structure and the response headers to determine the requirements to access the designated resource.

In such cases, the information in this element may be redundant with information also available from response headers.


Version Description XML Namespace (and LXI URL)
1.0 Initial Version http://lxistandard.org/schemas/LXIProblemDetails/1.0