Skip to content

monitor_logs_destination_list.md

Latest commit

 

History

History
123 lines (106 loc) · 5.44 KB

monitor_logs_destination_list.md

File metadata and controls

123 lines (106 loc) · 5.44 KB
Raw

monitor_logs_destination_list

List and filter on Logs Destinations.

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 of available logs destinations to the account
  linode.cloud.monitor_logs_destination_list: {}
- name: List all of available logs destinations to the account with label filter
  linode.cloud.monitor_logs_destination_list:
    filters:
      - name: label
        values: 
          - my_logs_destination_label

Parameters

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

    • Sample Response: 
      [
    {
      "created": "2025-07-20 09:45:13",
      "created_by": "John Q. Linode",
      "details": {
        "access_key_id": 123,
        "bucket_name": "primary-bucket",
        "host": "primary-bucket-1.us-iad-12.linodeobjects.com",
        "path": "audit-logs-logs"
      },
      "id": 12345,
      "label": "OBJ_logs_destination",
      "status": "active",
      "type": "akamai_object_storage",
      "updated": "2025-07-21 12:41:09",
      "updated_by": "Jane Q. Linode",
      "version": 2
    },
    {
      "created": "2025-07-21 10:30:15",
      "created_by": "Jane Q. Linode",
      "details": {
        "access_key_id": 456,
        "bucket_name": "secondary-bucket",
        "host": "secondary-bucket-1.us-iad-12.linodeobjects.com",
        "path": "audit-logs-backup"
      },
      "id": 12345,
      "label": "OBJ_logs_backup_destination",
      "status": "inactive",
      "type": "akamai_object_storage",
      "updated": "2025-07-21 10:30:15",
      "updated_by": "Jane Q. Linode",
      "version": 1
    },
    {
      "created": "2025-07-20T10:15:19",
      "created_by": "John Q. Linode",
      "details": {
        "authentication": {
          "details": {
            "basic_authentication_password": "p@$$w0Rd",
            "basic_authentication_user": "John_Q"
          },
          "type": "basic"
        },
        "client_certificate_details": {},
        "content_type": "application/json",
        "custom_headers": [
          {
            "name": "Cache-Control",
            "value": "max-age=0"
          }
        ],
        "data_compression": "gzip",
        "endpoint_url": "https://my-site.com/log-storage/database-info"
      },
      "id": 12346,
      "label": "custom_logs_destination",
      "type": "custom_https",
      "updated": "2025-07-20T10:15:19",
      "updated_by": "John Q. Linode",
      "version": 1
    }
  ]
    • See the Linode API response documentation for a list of returned fields