Observability
All operations require authentication.
List log kindsBeta
Returns the names of the log kinds the service emits, which can be forwarded to a stream.
Path parameters
Okms ID
Headers
Pagination cursor
Pagination size
Response
List of additional log fields managed in this log kind
Creation date of the log kind
Log kind display name
Identifier of the log kind
Log kind name
Last update date of the log kind
Example uses okmsId = 00000000-0000-0000-0000-000000000000
$ 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 kindBeta
Returns a log kind and the additional fields its logs carry.
Path parameters
Name
Okms ID
Response
List of additional log fields managed in this log kind
Creation date of the log kind
Log kind display name
Identifier of the log kind
Log kind name
Last update date of the log kind
Example uses name = string, okmsId = 00000000-0000-0000-0000-000000000000
$ 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"}
List log subscriptionsBeta
Returns the identifiers of the log subscriptions of the service. Filter them by log kind with the kind parameter.
Path parameters
Okms ID
Query parameters
Filter on a specific kind, for example audit
Headers
Pagination cursor
Pagination size
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
Identifier of the destination log stream
Unique identifier of the subscription, used to change or stop the forwarding
Last update date of the subscription
Example uses okmsId = 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 subscriptionBeta
Forwards the logs of one kind to a Logs Data Platform stream. The subscription is created asynchronously and the response returns the operation identifier.
Path parameters
Okms ID
Request body (required)
Log kind name to subscribe to
Identifier of the customer log stream
Response
Identifier of the operation
Operation owner's service name
Example uses okmsId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "operationId": "00000000-0000-0000-0000-000000000000", "serviceName": "string"}
Get a log subscriptionBeta
Returns the log kind and the destination stream of a subscription.
Path parameters
Okms ID
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
Identifier of the destination log stream
Unique identifier of the subscription, used to change or stop the forwarding
Last update date of the subscription
Example uses okmsId = 00000000-0000-0000-0000-000000000000, 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"}
Delete a log subscriptionBeta
Deletes the subscription and stops forwarding logs to the stream. The deletion runs asynchronously and the response returns the operation identifier.
Path parameters
Okms ID
Subscription ID
Response
Identifier of the operation
Operation owner's service name
Example uses okmsId = 00000000-0000-0000-0000-000000000000, subscriptionId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "operationId": "00000000-0000-0000-0000-000000000000", "serviceName": "string"}
Generate a temporary log URLBeta
Returns a temporary signed URL for read-only access to the logs of the given kind. The link expires.
Path parameters
Okms ID
Request body (required)
Log kind name
Response
Temporary url expiration date
Temporary url
Example uses okmsId = 00000000-0000-0000-0000-000000000000
$ curl https:/{ "expirationDate": "2024-01-01T12:00:00Z", "url": "string"}