Skip to content

monitor_logs_stream_history.md

Latest commit

 

History

History
84 lines (68 loc) · 4.05 KB

monitor_logs_stream_history.md

File metadata and controls

84 lines (68 loc) · 4.05 KB
Raw

monitor_logs_stream_history

List and filter on Logs Stream History.

Minimum Required Fields

Field Type Required Description
api_token str Required The Linode account personal access token. It is necessary to run the module.
It can be exposed by the environment variable LINODE_API_TOKEN instead.
See details in Usage.

Examples

- name: List all logs stream history for a stream
  linode.cloud.monitor_logs_stream_history:
    id: 12345
- name: List logs stream history for a stream and order by version
  linode.cloud.monitor_logs_stream_history:
    id: "{{ stream_creation.stream.id }}"
    order_by: "version"
    order: "desc"

Parameters

Field Type Required Description
id int Required The parent ID for the Logs Stream History.
order str Optional The order to list Logs Stream History in. (Choices: desc, asc; Default: asc)
order_by str Optional The attribute to order Logs Stream History by.
filters (sub-options) list Optional A list of filters to apply to the resulting Logs Stream History.
count int Optional The number of Logs Stream History to return. If undefined, all results will be returned.

filters

Field Type Required Description
name str Required The name of the field to filter on. Valid filterable fields can be found here.
values list Required A list of values to allow for this field. Fields will pass this filter if at least one of these values matches.

Return Values

  • logs_stream_history - The returned Logs Stream History.

    • Sample Response: 
      [
    {
      "created": "2025-03-20T01:41:09",
      "created_by": "John Q. Linode",
      "destinations": [
        {
          "details": {
            "access_key_id": 123,
            "bucket_name": "primary-bucket",
            "host": "primary-bucket-1.us-iad-12.linodeobjects.com",
            "path": "audit-logs"
          },
          "id": 12345,
          "label": "OBJ_logs_destination",
          "type": "akamai_object_storage"
        }
      ],
      "id": 12345,
      "label": "AuditLog-config",
      "status": "active",
      "type": "audit_logs",
      "updated": "2025-03-20T01:41:09",
      "updated_by": "Jane Q. Linode",
      "version": 1
    }
  ]
    • See the Linode API response documentation for a list of returned fields