Skip to main content
GET
/
cdn
/
logs_uploader
/
policies
Python
import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
logs_uploader_policy_list = client.cdn.logs_uploader.policies.list()
print(logs_uploader_policy_list)
[
  {
    "id": 123,
    "client_id": 123,
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "include_empty_logs": true,
    "include_shield_logs": true,
    "name": "Policy",
    "description": "New policy",
    "retry_interval_minutes": 32,
    "rotate_interval_minutes": 32,
    "rotate_threshold_mb": 252,
    "rotate_threshold_lines": 5000,
    "date_format": "[02/Jan/2006:15:04:05 -0700]",
    "field_delimiter": ",",
    "field_separator": ";",
    "fields": [
      "remote_addr",
      "status"
    ],
    "file_name_template": "{{YYYY}}_{{MM}}_{{DD}}_{{HH}}_{{mm}}_{{ss}}_access.log.gz",
    "format_type": "json",
    "tags": {},
    "related_uploader_configs": [
      123
    ]
  }
]

Authorizations

​
Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Query Parameters

​
search
string

Search by policy name or id.

​
config_ids
integer[]

Filter by ids of related logs uploader configs that use given policy.

Response

Successful.

​
id
integer
​
client_id
integer

Client that owns the policy.

​
created
string<date-time>

Time when logs uploader policy was created.

​
updated
string<date-time>

Time when logs uploader policy was updated.

​
include_empty_logs
boolean

Include empty logs in the upload.

​
include_shield_logs
boolean

Include logs from origin shielding in the upload.

​
name
string

Name of the policy.

Maximum string length: 255
​
description
string

Description of the policy.

Maximum string length: 255
​
retry_interval_minutes
integer

Interval in minutes to retry failed uploads.

Required range: 5 <= x <= 60
​
rotate_interval_minutes
integer

Interval in minutes to rotate logs.

Required range: 5 <= x <= 60
​
rotate_threshold_mb
integer | null

Threshold in MB to rotate logs.

Required range: 5 <= x <= 500
​
rotate_threshold_lines
integer

Threshold in lines to rotate logs.

Required range: 0 <= x <= 10000
​
date_format
string

Date format for logs.

Maximum string length: 255
​
field_delimiter
string

Field delimiter for logs.

Maximum string length: 10
Example:

";"

​
field_separator
string

Field separator for logs.

Required string length: 1 - 10
​
fields
string[]

List of fields to include in logs.

Maximum string length: 255
​
file_name_template
string

Template for log file name.

Maximum string length: 255
​
format_type
enum<string>

Format type for logs.

Possible values:

  • "" - empty, it means it will apply the format configurations from the policy.
  • "json" - output the logs as json lines.
Available options:
json,
Maximum string length: 255
​
tags
object

Tags allow for dynamic decoration of logs by adding predefined fields to the log format. These tags serve as customizable key-value pairs that can be included in log entries to enhance context and readability.

​
escape_special_characters
boolean

When set to true, the service sanitizes string values by escaping characters that may be unsafe for transport, logging, or downstream processing.

The following categories of characters are escaped:

  • Control and non-printable characters
  • Quotation marks and escape characters
  • Characters outside the standard ASCII range

The resulting output contains only printable ASCII characters.

​
related_uploader_configs
integer[]

List of logs uploader configs that use this policy.