Trackers

Test tracker addresses

Test connection to each provided address.

post/trackers/test

Request

  • Base URL
    https://localhost:8446/api/v2
  • Auth
    API key in header Authorization

Request body

addressesobject required

Tracker addresses and fingerprints to test connection.

addresses.hoststring required

Tracker address host

addresses.portnumber required

Tracker address port

addresses.use_tlsboolean

TLS connection flag

addresses.reject_unauthorizedboolean

Reject unauthorized certificates flag Only applicable for TLS connections and will be ignored in case of TCP connection. false — connection will be established even if the tracker presents an invalid TLS certificate (self-signed, expired, etc). true — Enforce certificate validation. The trusted_ca in MC advanced settings will also be used to validate the tracker's certificate.

addresses.fingerprintstring

Tracker's TLS certificate fingerprint (SHA-256) Only applicable for TLS connections and will be ignored in case of TCP connection. If provided must be either an empty string or a valid SHA-256 hash (a 64-character hexadecimal string, optionally separated by colons or spaces).

Response

Successful response

resultsobject

Array of connection tests results

results.successboolean

Connection success flag

results.locationstring

Tracker address to which connection was successfully established

results.is_tlsboolean

Flag indicating if TLS (instead of TCP) was used for the connection

results.observed_certificate_fingerprintstring

Observed TLS certificate fingerprint presented by the tracker

results.codestring

Error code if connection failed

results.errorstring

Error message if connection failed

Changes

No recorded changes to this operation across all 1 revision of this API.