Skip to content

GET CDN Access Logs.

POST
/api/cdn/namespaces/{namespace}/cdn_loadbalancer/access_logs
curl --request POST \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/cdn/namespaces/example/cdn_loadbalancer/access_logs \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "aggs": {}, "end_time": "example", "limit": 1, "namespace": "example", "query": [ { "operator": "CDN_ACCESS_LOG_OPERATOR_TYPE_IN", "tag": "CDN_NAME", "values": [ "example" ] } ], "sort": "DESCENDING", "start_time": "example" }'

Retrieve CDN Load-Balancer Access logs.

Examples of this operation.

namespace
required
string

Namespace fetch access logs for a given namespace.

Media typeapplication/json
CDNAccessLogRequest

Request to fetch access logs.

object
aggs
aggregations

Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregations are key’ed by user-defined aggregation name. The response will be key’ed with the same name. Optional.

object
end_time
end time

Fetch access logs whose timestamp <= end_time format: unix_timestamp|RFC 3339

Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to

string
<= 1024 characters
limit
limit

Limits the number of logs returned in the response Optional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response. The maximum value for limit is 500.

integer format: int64
namespace
namespace

Fetch access logs for a given namespace.

string
>= 6 characters <= 1024 characters
query
Access Logs Filter options

CDN Access Logs filter OPTIONS.

Array<object>
<= 32 items
Access Log filter fields

CDN Access log filter OPTIONS.

object
operator
string
default: CDN_ACCESS_LOG_OPERATOR_TYPE_IN
Allowed values: CDN_ACCESS_LOG_OPERATOR_TYPE_IN CDN_ACCESS_LOG_OPERATOR_TYPE_NOT_IN
tag
string
default: CDN_NAME
Allowed values: CDN_NAME SITE_NAME METHOD REQ_PATH RSP_CODE USER_AGENT SCHEME COUNTRY CACHE_STATUS RSP_CONTENT_TYPE HOST_HEADER REFERER SNI UPSTREAM_STATUS RSP_CODE_CLASS SRC_IP TLS_VERSION REQ_SIZE HTTP_VERSION CITY_NAME UPSTREAM_ADDR
values
Filter values

Filter values Required: YES.

Array<string>
<= 32 items
sort
string
default: DESCENDING
Allowed values: DESCENDING ASCENDING
start_time
start time

Fetch access logs whose timestamp >= start_time format: unix_timestamp|RFC 3339

Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.

string
<= 1024 characters

A successful response.

Media typeapplication/json
CDNLogResponse

Response message for AccessLogRequest.

object
aggs
aggregations

Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregation data is key’ed with the aggregation name specified in the request.

object
logs
logs

List of log messages that matched the query. Not all log messages that matched the query are returned in the response.

Array<object>
CDN access logs data item

CDN Access-Log item.

object
cache_status
CDN Cache Status

CDN Cache Status.

string
<= 1024 characters
cdn_name
CDN Name

Name of the CDN distribution.

string
<= 1024 characters
city_id
Geo City Id

Geo City ID [maxmind]

string
<= 1024 characters
city_name
Geo City Name

Geo City Name.

string
<= 1024 characters
client_port
Client port

Client Port.

string
<= 1024 characters
country
Geo Country Code of the request

Geo Country Code of the request.

string
<= 1024 characters
geo_location
Geo Location of the request

Geo Location of the request.

string
<= 1024 characters
host
Host

Host Name of the node where the log was captured.

string
<= 1024 characters
host_header
Host Header

HTTP Host Header.

string
<= 1024 characters
http_version
HTTP Version of the request

HTTP Version of the request.

string
<= 1024 characters
method
HTTP Method Name

HTTP Method Name.

string
<= 1024 characters
referer
HTTP referer

HTTP referer.

string
<= 1024 characters
req_content_type
Content-Type of the request

Content-Type of the request.

string
<= 1024 characters
req_path
HTTP request path

HTTP request path.

string
<= 1024 characters
req_size
HTTP Request Size

HTTP Request Size.

string format: uint64
<= 1024 characters
request_time
Time taken by the request

Time taken by the request.

string
<= 1024 characters
rsp_code
HTTP Response Code

HTTP Response Code.

string
<= 1024 characters
rsp_code_class
HTTP Response Code Class

HTTP Response Code Class.

string
<= 1024 characters
rsp_content_type
Content-Type of the response

Content-Type of the response.

string
<= 1024 characters
rsp_size
HTTP Response Size

HTTP Response Size.

string format: uint64
<= 1024 characters
scheme
HTTP request scheme

HTTP request scheme.

string
<= 1024 characters
site_name
Site Name

Name of the Site.

string
<= 1024 characters
src_ip
Source IP address

Source IP address.

string
<= 1024 characters
timestamp
Timestamp

Format: unix_timestamp|RFC 3339 Required: YES.

string format: date-time
<= 1024 characters
tls_sni
Service Name Indication

TLS Service Name Indication.

string
<= 1024 characters
tls_version
TLS Version

TLS Version Value.

string
<= 1024 characters
upstream_addr
Upstream Address

Upstream Address.

string
<= 1024 characters
upstream_connect_time
Upstream Connect Time

Upstream Connect Time.

string
<= 1024 characters
upstream_response_time
Upstream Response Time

Upstream Response Time.

string
<= 1024 characters
upstream_status
Upstream Status

Upstream Status.

string
<= 1024 characters
user
User name

Name of the user.

string
<= 1024 characters
user_agent
HTTP User Agent

HTTP User Agent.

string
<= 1024 characters
total_hits
total hits

Total number of log messages that matched the query.

string format: uint64
<= 1024 characters
Examplegenerated
{
"aggs": {},
"logs": [
{
"cache_status": "example",
"cdn_name": "example",
"city_id": "example",
"city_name": "example",
"client_port": "example",
"country": "example",
"geo_location": "example",
"host": "example",
"host_header": "example",
"http_version": "example",
"method": "example",
"referer": "example",
"req_content_type": "example",
"req_path": "example",
"req_size": "example",
"request_time": "example",
"rsp_code": "example",
"rsp_code_class": "example",
"rsp_content_type": "example",
"rsp_size": "example",
"scheme": "example",
"site_name": "example",
"src_ip": "example",
"timestamp": "2026-04-15T12:00:00Z",
"tls_sni": "example",
"tls_version": "example",
"upstream_addr": "example",
"upstream_connect_time": "example",
"upstream_response_time": "example",
"upstream_status": "example",
"user": "example",
"user_agent": "example"
}
],
"total_hits": "example"
}

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example