Observability
All operations require authentication.
List log kindsAlpha
Returns the names of the log kinds Exchange emits, which can be forwarded to a stream.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Response
Example uses exchangeService = string, organizationName = string
$ curl https:/[ "string"]
List log subscriptionsAlpha
Returns the identifiers of the Exchange log subscriptions. Set kind to restrict the list to one log kind.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Query parameters
Filter on a specific kind (e.g., audit)
Response
Example uses exchangeService = string, organizationName = string
$ curl https:/[ "00000000-0000-0000-0000-000000000000"]
Get a log kindAlpha
Returns a log kind and the additional fields its logs carry.
Path parameters
The internal name of your exchange service
Name
The internal name of your exchange organization
Response
List of additional log fields managed in this log kind
Creation date of the log kind
Log kind display name
Log kind ID
Log kind name
Last update date of the log kind
Example uses exchangeService = string, name = string, organizationName = string
$ curl https:/{ "additionalReturnedFields": [ "string" ], "createdAt": "2024-01-01T12:00:00Z", "displayName": "string", "kindId": "00000000-0000-0000-0000-000000000000", "name": "string", "updatedAt": "2024-01-01T12:00:00Z"}
Get a log subscriptionAlpha
Returns the log kind and the destination stream of a subscription.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Subscription ID
Response
Creation date of the subscription
Log kind name of this subscription
Subscribed resource, where the logs come from
Name of the destination log service
Id of the destination log stream
Subscription ID
Last update date of the subscription
Example uses exchangeService = string, organizationName = string, subscriptionId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "createdAt": "2024-01-01T12:00:00Z", "kind": "string", "resource": { "name": "string", "type": "string" }, "serviceName": "string", "streamId": "string", "subscriptionId": "00000000-0000-0000-0000-000000000000", "updatedAt": "2024-01-01T12:00:00Z"}
Create a log subscriptionAlpha
Forwards Exchange logs of one kind to a Logs Data Platform stream. The subscription is created asynchronously and the response returns the operation identifier.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Request body (required)
Log kind name to subscribe to
Customer log stream ID
Response
Identifier of the operation
Operation owner's service name
Example uses exchangeService = string, organizationName = string
$ curl https:/{ "operationId": "00000000-0000-0000-0000-000000000000", "serviceName": "string"}
Generate a temporary log URLAlpha
Generates a temporary URL to read the logs of one kind. The URL expires.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Request body (required)
Log kind name
Response
Temporary url expiration date
Temporary url
Example uses exchangeService = string, organizationName = string
$ curl https:/{ "expirationDate": "2024-01-01T12:00:00Z", "url": "string"}
Delete a log subscriptionAlpha
Deletes the subscription and stops forwarding Exchange logs to the stream.
Path parameters
The internal name of your exchange service
The internal name of your exchange organization
Subscription ID
Response
Identifier of the operation
Operation owner's service name
Example uses exchangeService = string, organizationName = string, subscriptionId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "operationId": "00000000-0000-0000-0000-000000000000", "serviceName": "string"}