Dash Api Documentation Browser 5 1 1

Dash Api Documentation Browser 5 1 1

Dash Api Documentation Browser 5 1 10 Mac
See Full List On Github.com
Dash Api Documentation Browser 5 1 1 Download
-->Dash Api Documentation Browser 5 1 2017 Logout Button. The logout button can be used to perform logout mechanism. It's a simple form with a submit button, when the button is clicked, it will submit the form to the logouturl prop. Please note that no authentication is performed in Dash by default. Later edit: I have found iOS, Windows, Linux and Android devs and Dash-like apps for these platforms should be released sometime in 2014. What you'll make: An API documentation browser app for your favourite platform; You can give it your own personal twist or base it on Dash as much as you want. Dash Explorer — Blockchair. Earn on Crypto 💵. Don't let your crypto sit there collecting virtual dust. Put it to work with Nexo and start earning up to 12% APR, paid out daily. Beat Volatility & Earn Without the Risk. Unique daily payouts.
Version: 2.0api-version: 2020-10-01-preview
This document defines IoT Hub data plane API over MQTT version 5.0 protocol. See API Reference for complete definitions in this API.
PrerequisitesEnable preview mode on a brand new IoT hub to try MQTT 5.
Prior knowledge of MQTT 5 specification is required.

Level of support and limitationsIoT Hub support for MQTT 5 is in preview and limited in following ways (communicated to client via CONNACK properties unless explicitly noted otherwise):
No official Azure IoT Hub device SDK support yet.
Subscription identifiers aren't supported.
Shared subscriptions aren't supported.
RETAIN isn't supported.
Maximum QoS is 1.
Maximum Packet Size is 256 KiB (subject to further restrictions per operation).
Assigned Client IDs aren't supported.
Keep Alive is limited to 19 min (max delay for liveness check – 28.5 min).
Topic Alias Maximum is 10.
Response Information isn't supported; CONNACK doesn't return Response Information property even if CONNECT contains Request Response Information property.
Receive Maximum (maximum number of allowed outstanding unacknowledged PUBLISH packets (in client-server direction) with QoS: 1) is 16.
Single client can have no more than 50 subscriptions.When the limit's reached, SUBACK will return 0x97 (Quota exceeded) reason code for subscriptions.
Connection lifecycleConnectionTo connect a client to IoT Hub using this API, establish connection per MQTT 5 specification.Client must send CONNECT packet within 30 seconds following successful TLS handshake, or the server closes the connection.Here's an example of CONNECT packet:
Authentication Method property is required and identifies which authentication method is used. For more information about authentication method, see Authentication.
Authentication Data property handling depends on Authentication Method. If Authentication Method is set to SAS, then Authentication Data is required and must contain valid signature. For more information about authentication data, see Authentication.
api-version property is required and must be set to API version value provided in this specification's header for this specification to apply.
host property defines host name of the tenant. It's required unless SNI extension was presented in Client Hello record during TLS handshake
sas-at defines time of connection.
sas-expiry defines expiration time for the provided SAS.
client-agent optionally communicates information about the client creating the connection.
Note
Authentication Method and other properties throughout the specification with capitalized names are first-class properties in MQTT 5 - they are described in details in MQTT 5 specification. api-version and other properties in dash case are user properties specific to IoT Hub API.
IoT Hub responds with CONNACK packet once it finishes with authentication and fetching data to support the connection. If connection is established successfully, CONNACK looks like:
These CONNACK packet properties follow MQTT 5 specification. They reflect IoT Hub's capabilities.
AuthenticationThe Authentication Method property on CONNECT client defines what kind of authentication it uses for this connection:
SAS - Shared Access Signature is provided in CONNECT's Authentication Data property,
X509 - client relies on client certificate authentication.
Authentication fails if authentication method doesn't match the client's configured method in IoT Hub.
Note
This API requires Authentication Method property to be set in CONNECT packet. If Authentication Method property isn't provided, connection fails with Bad Request response.
Username/password authentication used in previous API versions isn't supported.
SASWith SAS-based authentication, client must provide the signature of connection context. This proves authenticity of the MQTT connection. The signature must be based on one of two authentication keys in the client's configuration in IoT Hub or one of two shared access keys of a Shared access policy.
String to sign must be formed as follows:
host name is derived either from SNI extension (presented by client in Client Hello record during TLS handshake) or host user property in CONNECT packet.
Client Id is Client Identifier in CONNECT packet.
sas-policy - if present, defines IoT Hub access policy used for authentication. It's encoded as user property on CONNECT packet. Optional: omitting it means authentication settings in device registry will be used instead.
sas-at - if present, specifies time of connection - current time. It's encoded as user property of time type on CONNECT packet.
sas-expiry defines expiration time for the authentication. It's a time-typed user property on CONNECT packet. This property is required.
For optional parameters, if omitted, empty string MUST be used instead in string to sign.
HMAC-SHA256 is used to hash the string based on one of device's symmetric keys. Hash value is then set as value of Authentication Data property.
X509If Authentication Method property is set to X509, IoT Hub authenticates the connection based on the provided client certificate.
ReauthenticationIf SAS-based authentication is used, we recommend using short-lived authentication tokens. To keep connection authenticated and prevent disconnection because of expiration, client must reauthenticate by sending AUTH packet with Reason Code: 0x19 (reauthentication):
Rules:
Authentication Method must be the same as the one used for initial authentication
if connection was originally authenticated using SAS based on Shared Access Policy, signature used in reauthentication must be based on the same policy.
If reauthentication succeeds, IoT Hub sends AUTH packet with Reason Code: 0x00 (success). Otherwise, IoT Hub sends DISCONNECT packet with Reason Code: 0x87 (Not authorized) and closes the connection.
DisconnectionServer can disconnect client for a few reasons:
client is misbehaving in a way that is impossible to respond to with negative acknowledgment (or response) directly,
server is failing to keep state of the connection up to date,
client with the same identity has connected.
Server may disconnect with any reason code defined in MQTT 5.0 specification. Notable mentions:
135 (Not authorized) when reauthentication fails, current SAS token expires or device's credentials change
142 (Session taken over) when new connection with the same client identity has been opened.
159 (Connection rate exceeded) when connection rate for the IoT hub exceeds
131 (Implementation-specific error) is used for any custom errors defined in this API. status and reason properties will be used to communicate further details about the cause for disconnection (see Response for details).
OperationsAll functionalities in this API are expressed as operations. Here's an example of Send Telemetry operation:
For complete specification of operations in this API, see API Reference.
Note
All the samples in this specification are shown from client's perspective. Sign -> means client sending packet, <- - receiving.
Message topics and subscriptionsTopics used in operations' messages in this API start with $iothub/.MQTT broker semantics don't apply to these operations (see 'Topics beginning with $' for details).Topics starting with $iothub/ that aren't defined in this API aren't supported:
Sending messages to undefined topic results in Not Found response (see Response for details below),
Subscribing to undefined topic results in SUBACK with Reason Code: 0x8F (Topic Filter Invalid).
Topic names and property names are case-sensitive and must be exact match. For example, $iothub/telemetry/ isn't supported while $iothub/telemetry is.
Note
Wildcards in subscriptions under $iothub/.. aren't supported. That is, a client can't subscribe to $iothub/+ or $iothub/#. Attempting to do so results in SUBACK with Reason Code: 0xA2 (Wildcard Subscriptions not supported). Only single-segment wildcards (+) are supported instead of path parameters in topic name for operations that have them.
Interaction typesAll the operations in this API are based on one of two interaction types:
Message with optional acknowledgment (MessageAck)
Request-Response (ReqRep)
Operations also vary by direction (determined by direction of initial message in exchange):
Client-to-Server (c2s)
Server-to-Client (s2c)
For example, Send Telemetry is Client-to-Server operation of 'Message with acknowledgment' type, while Handle Direct Method is Server-to-Client operation of Request-Response type.
Message-acknowledgement interactionsMessage with optional Acknowledgment (MessageAck) interaction is expressed as an exchange of PUBLISH and PUBACK packets in MQTT. Acknowledgment is optional and sender may choose to not request it by sending PUBLISH packet with QoS: 0.
Note
If properties in PUBACK packet must be truncated due to Maximum Packet Size declared by the client, IoT Hub will retain as many User properties as it can fit within the given limit. User properties listed first have higher chance to be sent than those listed later; Reason String property has the least priority.
Example of simple MessageAck interactionMessage:
Acknowledgment (success):
Request-Response InteractionsIn Request-Response (ReqRep) interactions, both Request and Response translate into PUBLISH packets with QoS: 0.
Correlation Data property must be set in both and is used to match Response packet to Request packet.
This API uses single response topic $iothub/responses for all ReqRep operations. Subscribing to / unsubscribing from this topic for client-to-server operations isn't required - server assumes all clients to be subscribed.
Example of simple ReqRep interactionRequest:
Response (success):
ReqRep interactions don't support PUBLISH packets with QoS: 1 as request or response messages. Sending Request PUBLISH results in Bad Request response.
Maximum length supported in Correlation Data property is 16 bytes. If Correlation Data property on PUBLISH packet is set to a value longer than 16 bytes, IoT Hub sends DISCONNECT with Bad Request outcome, and closes the connection. This behavior only applies to packets exchanged within this API.

Level of support and limitationsIoT Hub support for MQTT 5 is in preview and limited in following ways (communicated to client via CONNACK properties unless explicitly noted otherwise):
No official Azure IoT Hub device SDK support yet.
Subscription identifiers aren't supported.
Shared subscriptions aren't supported.
RETAIN isn't supported.
Maximum QoS is 1.
Maximum Packet Size is 256 KiB (subject to further restrictions per operation).
Assigned Client IDs aren't supported.
Keep Alive is limited to 19 min (max delay for liveness check – 28.5 min).
Topic Alias Maximum is 10.
Response Information isn't supported; CONNACK doesn't return Response Information property even if CONNECT contains Request Response Information property.
Receive Maximum (maximum number of allowed outstanding unacknowledged PUBLISH packets (in client-server direction) with QoS: 1) is 16.
Single client can have no more than 50 subscriptions.When the limit's reached, SUBACK will return 0x97 (Quota exceeded) reason code for subscriptions.
Connection lifecycleConnectionTo connect a client to IoT Hub using this API, establish connection per MQTT 5 specification.Client must send CONNECT packet within 30 seconds following successful TLS handshake, or the server closes the connection.Here's an example of CONNECT packet:
Authentication Method property is required and identifies which authentication method is used. For more information about authentication method, see Authentication.
Authentication Data property handling depends on Authentication Method. If Authentication Method is set to SAS, then Authentication Data is required and must contain valid signature. For more information about authentication data, see Authentication.
api-version property is required and must be set to API version value provided in this specification's header for this specification to apply.
host property defines host name of the tenant. It's required unless SNI extension was presented in Client Hello record during TLS handshake
sas-at defines time of connection.
sas-expiry defines expiration time for the provided SAS.
client-agent optionally communicates information about the client creating the connection.
Note
Authentication Method and other properties throughout the specification with capitalized names are first-class properties in MQTT 5 - they are described in details in MQTT 5 specification. api-version and other properties in dash case are user properties specific to IoT Hub API.
IoT Hub responds with CONNACK packet once it finishes with authentication and fetching data to support the connection. If connection is established successfully, CONNACK looks like:
These CONNACK packet properties follow MQTT 5 specification. They reflect IoT Hub's capabilities.
AuthenticationThe Authentication Method property on CONNECT client defines what kind of authentication it uses for this connection:
SAS - Shared Access Signature is provided in CONNECT's Authentication Data property,
X509 - client relies on client certificate authentication.
Authentication fails if authentication method doesn't match the client's configured method in IoT Hub.
Note
This API requires Authentication Method property to be set in CONNECT packet. If Authentication Method property isn't provided, connection fails with Bad Request response.
Username/password authentication used in previous API versions isn't supported.
SASWith SAS-based authentication, client must provide the signature of connection context. This proves authenticity of the MQTT connection. The signature must be based on one of two authentication keys in the client's configuration in IoT Hub or one of two shared access keys of a Shared access policy.
String to sign must be formed as follows:
host name is derived either from SNI extension (presented by client in Client Hello record during TLS handshake) or host user property in CONNECT packet.
Client Id is Client Identifier in CONNECT packet.
sas-policy - if present, defines IoT Hub access policy used for authentication. It's encoded as user property on CONNECT packet. Optional: omitting it means authentication settings in device registry will be used instead.
sas-at - if present, specifies time of connection - current time. It's encoded as user property of time type on CONNECT packet.
sas-expiry defines expiration time for the authentication. It's a time-typed user property on CONNECT packet. This property is required.
For optional parameters, if omitted, empty string MUST be used instead in string to sign.
HMAC-SHA256 is used to hash the string based on one of device's symmetric keys. Hash value is then set as value of Authentication Data property.
X509If Authentication Method property is set to X509, IoT Hub authenticates the connection based on the provided client certificate.
ReauthenticationIf SAS-based authentication is used, we recommend using short-lived authentication tokens. To keep connection authenticated and prevent disconnection because of expiration, client must reauthenticate by sending AUTH packet with Reason Code: 0x19 (reauthentication):
Rules:
Authentication Method must be the same as the one used for initial authentication
if connection was originally authenticated using SAS based on Shared Access Policy, signature used in reauthentication must be based on the same policy.
If reauthentication succeeds, IoT Hub sends AUTH packet with Reason Code: 0x00 (success). Otherwise, IoT Hub sends DISCONNECT packet with Reason Code: 0x87 (Not authorized) and closes the connection.
DisconnectionServer can disconnect client for a few reasons:
client is misbehaving in a way that is impossible to respond to with negative acknowledgment (or response) directly,
server is failing to keep state of the connection up to date,
client with the same identity has connected.
Server may disconnect with any reason code defined in MQTT 5.0 specification. Notable mentions:
135 (Not authorized) when reauthentication fails, current SAS token expires or device's credentials change
142 (Session taken over) when new connection with the same client identity has been opened.
159 (Connection rate exceeded) when connection rate for the IoT hub exceeds
131 (Implementation-specific error) is used for any custom errors defined in this API. status and reason properties will be used to communicate further details about the cause for disconnection (see Response for details).
OperationsAll functionalities in this API are expressed as operations. Here's an example of Send Telemetry operation:
For complete specification of operations in this API, see API Reference.
Note
All the samples in this specification are shown from client's perspective. Sign -> means client sending packet, <- - receiving.
Message topics and subscriptionsTopics used in operations' messages in this API start with $iothub/.MQTT broker semantics don't apply to these operations (see 'Topics beginning with $' for details).Topics starting with $iothub/ that aren't defined in this API aren't supported:
Sending messages to undefined topic results in Not Found response (see Response for details below),
Subscribing to undefined topic results in SUBACK with Reason Code: 0x8F (Topic Filter Invalid).
Topic names and property names are case-sensitive and must be exact match. For example, $iothub/telemetry/ isn't supported while $iothub/telemetry is.
Note
Wildcards in subscriptions under $iothub/.. aren't supported. That is, a client can't subscribe to $iothub/+ or $iothub/#. Attempting to do so results in SUBACK with Reason Code: 0xA2 (Wildcard Subscriptions not supported). Only single-segment wildcards (+) are supported instead of path parameters in topic name for operations that have them.
Interaction typesAll the operations in this API are based on one of two interaction types:
Message with optional acknowledgment (MessageAck)
Request-Response (ReqRep)
Operations also vary by direction (determined by direction of initial message in exchange):
Client-to-Server (c2s)
Server-to-Client (s2c)
For example, Send Telemetry is Client-to-Server operation of 'Message with acknowledgment' type, while Handle Direct Method is Server-to-Client operation of Request-Response type.
Message-acknowledgement interactionsMessage with optional Acknowledgment (MessageAck) interaction is expressed as an exchange of PUBLISH and PUBACK packets in MQTT. Acknowledgment is optional and sender may choose to not request it by sending PUBLISH packet with QoS: 0.
Note
If properties in PUBACK packet must be truncated due to Maximum Packet Size declared by the client, IoT Hub will retain as many User properties as it can fit within the given limit. User properties listed first have higher chance to be sent than those listed later; Reason String property has the least priority.
Example of simple MessageAck interactionMessage:
Acknowledgment (success):
Request-Response InteractionsIn Request-Response (ReqRep) interactions, both Request and Response translate into PUBLISH packets with QoS: 0.
Correlation Data property must be set in both and is used to match Response packet to Request packet.
This API uses single response topic $iothub/responses for all ReqRep operations. Subscribing to / unsubscribing from this topic for client-to-server operations isn't required - server assumes all clients to be subscribed.
Example of simple ReqRep interactionRequest:
Response (success):
ReqRep interactions don't support PUBLISH packets with QoS: 1 as request or response messages. Sending Request PUBLISH results in Bad Request response.
Maximum length supported in Correlation Data property is 16 bytes. If Correlation Data property on PUBLISH packet is set to a value longer than 16 bytes, IoT Hub sends DISCONNECT with Bad Request outcome, and closes the connection. This behavior only applies to packets exchanged within this API.
Note
Correlation Data is an arbitrary byte sequence, e.g. it isn't guaranteed to be UTF-8 string.
ReqRep use predefined topics for response; Response Topic property in Request PUBLISH packet (if set by the sender) is ignored.
IoT Hub automatically subscribes client to response topics for all client-to-server ReqRep operations. Even if client explicitly unsubscribes from response topic, IoT Hub reinstates the subscription automatically. For server-to-client ReqRep interactions, it's still necessary for device to subscribe.
Message PropertiesOperation properties - system or user-defined - are expressed as packet properties in MQTT 5.
User property names are case-sensitive and must be spelled exactly as defined. For example, Trace-ID isn't supported while trace-id is.
Requests with User properties outside specification and without prefix @ result in error.
System properties are encoded either as first class properties (for example, Content Type) or as User properties. Specification provides exhaustive list of supported system properties.All first class properties are ignored unless support for them is explicitly stated in the specification.
Where user-defined properties are allowed, their names must follow the format @{property name}. User-defined properties only support valid UTF-8 string values. for example, MyProperty1 property with value 15 must be encoded as User property with name @MyProperty and value 15.
If IoT Hub doesn't recognize User property, it's considered an error and IoT Hub responds with PUBACK with Reason Code: 0x83 (Implementation-specific error) and status: 0100 (Bad Request). If acknowledgment was not requested (QoS: 0), DISCONNECT packet with the same error will be sent back and connection is terminated.
This API defines following data types besides string:
time: number of milliseconds since 1970-01-01T00:00:00.000Z. for example, 1600987195320 for 2020-09-24T22:39:55.320Z,
u32: unsigned 32-bit integer number,
u64: unsigned 64-bit integer number,
i32: signed 32-bit integer number.
ResponseInteractions can result in different outcomes: Success, Bad Request, Not Found, and others.Outcomes are distinguished from each other by status user property. Reason Code in PUBACK packets (for MessageAck interactions) matches status in meaning where possible.
Note
If client specifies Request Problem Information: 0 in CONNECT packet, no user properties will be sent on PUBACK packets to comply with MQTT 5 specification, including status property. In this case, client can still rely on Reason Code to determine whether acknowledge is positive or negative.
Every interaction has a default (or success). It has Reason Code of 0 and status property of 'not set'. Otherwise:
For MessageAck interactions, PUBACK gets Reason Code other than 0x0 (Success). status property may be present to further clarify the outcome.
For ReqRep interactions, Response PUBLISH gets status property set.
Since there's no way to respond to MessageAck interactions with QoS: 0 directly, DISCONNECT packet is sent instead with response information, followed by disconnect.
Examples:
Bad Request (MessageAck):
Not Authorized (MessageAck):
Not Authorized (ReqRep):
When needed, IoT Hub sets the following user properties:
status - IoT Hub's extended code for operation's status. This code can be used to differentiate outcomes.
trace-id – trace ID for the operation; IoT Hub may keep additional diagnostics concerning the operation that could be used for internal investigation.
reason - human-readable message providing further information on why operation ended up in a state indicated by status property.
Note
If client sets Maximum Packet Size property in CONNECT packet to a very small value, not all user properties may fit and would not appear in the packet.
reason is meant only for people and should not be used in client logic. This API allows for messages to be changed at any point without warning or change of version.
If client sends RequestProblemInformation: 0 in CONNECT packet, user properties won't be included in acknowledgements per MQTT 5 specification.
Status codestatus property carries status code for operation. It's optimized for machine reading efficiency.It consists of two-byte unsigned integer encoded as hex in string like 0501.Code structure (bit map):
First byte is used for flags:
bits 0 and 1 indicate type of outcomes:00 - success
01 - client error
10 - server error
bit 2: 1 indicates error is retryable
bits 3 through 7 are reserved and must be set to 0
Second byte contains actual distinct response code. Error codes with different flags can have the same second byte value. For example, there can be 0001, 0101, 0201, 0301 error codes having distinct meaning.
For example, Too Many Requests is a client, retryable error with own code of 1. Its value is0000 0101 0000 0001 or 0x0501.
Clients may use type bits to identify whether operation concluded successfully. Clients may also use retryable bit to decide whether it's sensible to retry operation.
RecommendationsSession managementCONNACK packet carries Session Present property to indicate whether server restored previously created session. Use this property to figure out whether to subscribe to topics or skip subscribing since subscription was done earlier.
To rely on Session Present, client must keep track of subscriptions it's made (that is, sent SUBSCRIBE packet and received SUBACK with successful reason code), or make sure to subscribe to all topics in a single SUBSCRIBE/SUBACK exchange. Otherwise, if client sends two SUBSCRIBE packets, and only one of them is processed successfully by server, server will communicate Session Present: 1 in CONNACK while having only part of client's subscriptions accepted.
To prevent the case where an older version of client didn't subscribe to all the topics, it's better to subscribe unconditionally when client behavior changes (for example, as part of firmware update). Also, to ensure no stale subscriptions are left behind (taking from maximum allowed number of subscriptions), explicitly unsubscribe from subscriptions that are no longer in use.
BatchingThere's no special format to send a batch of messages. To reduce overhead of resource-intensive operations in TLS and networking, bundle packets (PUBLISH, PUBACK, SUBSCRIBE, and so no) together before handing them over to underlying TLS/TCP stack. Also, client can make topic alias easier within the 'batch':
Put complete topic name in the first PUBLISH packet for the connection and associate topic alias with it,
Put following packets for the same topic with empty topic name and topic alias property.
MigrationThis section lists the changes in the API compared to previous MQTT API.
Transport protocol is MQTT 5. Previously - MQTT 3.1.1.
Context information for SAS Authentication is contained in CONNECT packet directly instead of being encoded along with signature.
Authentication Method is used to indicate authentication method used.
Shared Access Signature is put in Authentication Data property. Previously Password field was used.
Topics for operations are different:Telemetry: $iothub/telemetry instead of devices/{Client Id}/messages/events,
Commands: $iothub/commands instead of devices/{Client Id}/messages/devicebound,
Patch Twin Reported: $iothub/twin/patch/reported instead of $iothub/twin/PATCH/properties/reported,
Notify Twin Desired State Changed: $iothub/twin/patch/desired instead of $iothub/twin/PATCH/properties/desired.
Subscription for client-server request-response operations' response topic isn't required.
User properties are used instead of encoding properties in topic name segment.
property names are spelled in 'dash-case' naming convention instead of abbreviations with special prefix. User-defined properties now require prefix instead. For instance, $.mid is now message-id, while myProperty1 becomes @myProperty1.
Correlation Data property is used to correlate request and response messages for request-response operations instead of $rid property encoded in topic.
iothub-connection-auth-method property is no longer stamped on telemetry events.
C2D commands won't be purged in absence of subscription from device. They'll remain queued up until device subscribes or they expire.
ExamplesSend telemetryMessage:
Acknowledgment:
Alternative acknowledgment (throttled):
Send get twin's stateRequest:
Response (success):
Response (not allowed):
Handle direct method callRequest:
Response (success):
Device Unavailable Response:
Error while using QoS 0, part 1Request:
Response:
Error while using QoS 0, part 2Request:
Response:
Next stepsTo review the MQTT 5 preview API reference, see IoT Hub data plane MQTT 5 API reference.
To follow a C# sample, see GitHub sample repository.
The User-Agentrequest header is a characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.
Warning: Please read Browser detection using the user agent for why serving different Web pages or services to different browsers is usually a bad idea.
Header typeRequest header
Forbidden header nameno
SyntaxDirectivesA product identifier — its name or development codename.
Version number of the product.
Zero or more comments containing more details. For example, sub-product information.
Firefox UA stringFor more on Firefox- and Gecko-based user agent strings, see the Firefox user agent string reference. The UA string of Firefox is broken down into 4 components:
Mozilla/5.0 is the general token that says that the browser is Mozilla-compatible. For historical reasons, almost every browser today sends it.
platform describes the native platform that the browser is running on (Windows, Mac, Linux, Android, etc.) and if it is a mobile phone. Firefox OS phones say Mobile — the web is the platform. Note that platform can consist of multiple ';'-separated tokens. See below for further details and examples.
rv:geckoversion indicates the release version of Gecko (such as '17.0'). In recent browsers, geckoversion is the same as firefoxversion.
Gecko/geckotrail indicates that the browser is based on Gecko. (On the desktop, geckotrail is always the fixed string 20100101.)
Firefox/firefoxversion indicates that the browser is Firefox and provides the version (such as '17.0').
ExamplesChrome UA stringThe Chrome (or Chromium/Blink-based engines) user agent string is similar to Firefox's. For compatibility, it adds strings like KHTML, like Gecko and Safari.
ExamplesOpera UA stringThe Opera browser is also based on the Blink engine, which is why it almost looks the same as the Chrome UA string, but adds 'OPR/'.
ExamplesMicrosoft Edge UA stringThe Edge browser is also based on the Blink engine. It adds 'Edg/'.
ExamplesSafari UA stringIn this example, the user agent string is mobile Safari's version. It contains the word 'Mobile'.
ExamplesInternet Explorer UA stringExamplesCrawler and bot UA stringsDash Api Documentation Browser 5 1 10 MacExamplesLibrary and net tool UA stringsExamplesSpecificationsSpecification
Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content(HTTP/1.1)
# header.user-agent
See Full List On Github.comBrowser compatibilityBCD tables only load in the browser
Dash Api Documentation Browser 5 1 1 DownloadSee also