---
title: "GetChannelDiagnostics"
method: GET
path: "/v2/diagnostics/channels"
tags: ["Diagnostics"]
---

# GetChannelDiagnostics

`GET /v2/diagnostics/channels`

Get channel diagnostic information for all connections.

## Response `200`

The operation was successful.

- ChannelDiagnosticModel[]
  - `timeStamp` string, date-time, required — Timestamp of the diagnostic information
  - `sessionId` string — The session id if connected. Empty if disconnected.
  - `sessionCreated` string, date-time — When the session was created.
  - `connection` ConnectionModel, required — Connection model
    - `endpoint` EndpointModel, required — Endpoint model
      - `url` string, required — Endpoint url to use to connect with
      - `alternativeUrls` string[] — Alternative endpoint urls that can be used for accessing and validating the server
      - `securityMode` 'Best' | 'Sign' | 'SignAndEncrypt' | 'None' | 'NotNone' — Specifies the security mode for OPC UA endpoint connections. Determines how messages are protected during transmission between the Publisher and OPC UA servers. Proper security mode selection is crucial for protecting sensitive data and credentials.
      - `securityPolicy` string — Security policy uri to use for communication. default to best.
      - `certificate` string — Endpoint certificate thumbprint
    - `user` CredentialModel — Credential model. For backwards compatibility the actual credentials to pass to the server is set through the value property.
      - `type` 'None' | 'UserName' | 'X509Certificate' | 'JwtToken' — Type of credentials to use for authentication
      - `value` UserIdentityModel — User identity model
        - `user` string — For Azure.IIoT.OpcUa.Publisher.Models.CredentialType.UserName authentication this is the name of the user. For Azure.IIoT.OpcUa.Publisher.Models.CredentialType.X509Certificate authentication this is the subject name of the certificate that has been configured. Either Azure.IIoT.OpcUa.Publisher.Models.UserIdentityModel.User or Azure.IIoT.OpcUa.Publisher.Models.UserIdentityModel.Thumbprint must be used to select the certificate in the user certificate store. Not used for the other authentication types.
        - `password` string — For Azure.IIoT.OpcUa.Publisher.Models.CredentialType.UserName authentication this is the password of the user. For Azure.IIoT.OpcUa.Publisher.Models.CredentialType.X509Certificate authentication this is the passcode to export the configured certificate's private key. Not used for the other authentication types.
        - `thumbprint` string — For Azure.IIoT.OpcUa.Publisher.Models.CredentialType.X509Certificate authentication this is the thumbprint of the configured certificate to use. Either Azure.IIoT.OpcUa.Publisher.Models.UserIdentityModel.User or Azure.IIoT.OpcUa.Publisher.Models.UserIdentityModel.Thumbprint must be used to select the certificate in the user certificate store. Not used for the other authentication types.
    - `diagnostics` DiagnosticsModel — Diagnostics configuration
      - `level` 'None' | 'Status' | 'Information' | 'Debug' | 'Verbose' — Level of diagnostics requested in responses
      - `auditId` string — Client audit log entry. (default: client generated)
      - `timeStamp` string, date-time — Timestamp of request. (default: client generated)
    - `group` string — Connection group allows splitting connections per purpose.
    - `locales` string[] — Optional list of preferred locales in preference order.
    - `options` 'None' | 'UseReverseConnect' | 'NoComplexTypeSystem' | 'NoSubscriptionTransfer' | 'DumpDiagnostics' — Options that can be applied to a connection
  - `remoteIpAddress` string — Effective remote ip address used for the connection if connected. Empty if disconnected.
  - `remotePort` integer — The effective remote port used when connected, null if disconnected.
  - `localIpAddress` string — Effective local ip address used for the connection if connected. Empty if disconnected.
  - `localPort` integer — The effective local port used when connected, null if disconnected.
  - `channelId` integer — The id assigned to the channel that the token belongs to.
  - `tokenId` integer — The id assigned to the token.
  - `createdAt` string, date-time — When the token was created by the server (refers to the server's clock).
  - `lifetime` string, date-span — The lifetime of the token
  - `client` ChannelKeyModel — Channel token key model.
    - `iv` integer[], required — Iv
    - `key` integer[], required — Key
    - `sigLen` integer, required — Signature length
  - `server` ChannelKeyModel — Channel token key model.
    - `iv` integer[], required — Iv
    - `key` integer[], required — Key
    - `sigLen` integer, required — Signature length

## Other responses

- `500` — An unexpected error occurred

---

[API](https://skmtc.net/azure/apis/opcpublisher.md) · [All operations](https://skmtc.net/azure/apis/opcpublisher/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/opcpublisher/revisions/8eac19a554d6/schema)