Skip to content

monitor_logs_stream_list.md

Latest commit

 

History

History
83 lines (67 loc) · 3.9 KB

monitor_logs_stream_list.md

File metadata and controls

83 lines (67 loc) · 3.9 KB
Raw

monitor_logs_stream_list

List and filter on Monitor Logs Streams.

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 streams
  linode.cloud.monitor_logs_stream_list:
- name: List logs streams with active status
  linode.cloud.monitor_logs_stream_list:
    filters:
      - name: status
        values:
          - active

Parameters

Field Type Required Description
order str Optional The order to list Monitor Logs Streams in. (Choices: desc, asc; Default: asc)
order_by str Optional The attribute to order Monitor Logs Streams by.
filters (sub-options) list Optional A list of filters to apply to the resulting Monitor Logs Streams.
count int Optional The number of Monitor Logs Streams 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

  • streams - The returned Monitor Logs Streams.

    • Sample Response: 
      [
      {
        "created": "2025-03-20 01: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-20 01:41:09",
        "updated_by": "Jane Q. Linode",
        "version": 1
      }
    ]
    • See the Linode API response documentation for a list of returned fields