Telemetry

Get the next telemetry outbox batch

Changed on

Get the next encrypted telemetry batch from the outbox so the browser can forward it to the relay. <br> Returns <strong>204 No Content</strong> when the outbox is not ready or the pool is empty.

get/pimcore-studio/api/telemetry/outbox

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /pimcore-studio/api/telemetry/outbox
  • Auth: none declared

Response

Next encrypted telemetry batch ready to forward to the relay

additionalAttributesobject

AdditionalAttributes

noncestring required

Lease nonce identifying the claimed batch, passed back on ack

instanceIdentifierstring required

Cleartext instance identifier the relay uses to look up the product key

vinteger required

Outbox payload protocol version

ciphertextstring required

Opaque product-key encrypted envelope to forward verbatim to the relay

relayEndpointstring required

Relay endpoint the browser must POST the ciphertext to

Example response

{
  "nonce": "9b1c4f7a2e6d40318c5a7b9e0d2f4a61",
  "instanceIdentifier": "my-pimcore-instance",
  "v": 1,
  "ciphertext": "AqiJ8s3TnQz1FQmSMHBZR2xlYXNlZC10ZWxlbWV0cnktZW52ZWxvcGU=",
  "relayEndpoint": "https://relay.example.com/"
}

Changes