GET /projects/{project_reference}/logsList project log entries. Requires project.logs.read.
Servers
[
{
"url": "https://api.veryfront.com"
}
]Authentication
[
{
"bearerAuth": []
},
{
"apiKeyAuth": []
}
]{
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT or API Key",
"description": "Use a JWT bearer token or a Veryfront API key in the `Authorization` header."
},
"apiKeyAuth": {
"type": "apiKey",
"in": "header",
"name": "X-API-Key",
"description": "Alternative API key header for `vf_<prefix>_<secret>` tokens."
}
}Parameters
Parameter contracts
[
{
"schema": {
"$ref": "#/components/schemas/ProjectReference"
},
"required": true,
"description": "Project slug, UUID, or domain that identifies the project.",
"name": "project_reference",
"in": "path"
},
{
"schema": {
"type": "string",
"format": "date-time",
"description": "Start time (RFC 3339). Defaults to 1 hour ago. Logs are kept for 31 days and one query spans at most 30 days; an older start or a wider range returns 400. Cannot be combined with cursor."
},
"required": false,
"description": "Start time (RFC 3339). Defaults to 1 hour ago. Logs are kept for 31 days and one query spans at most 30 days; an older start or a wider range returns 400. Cannot be combined with cursor.",
"name": "start",
"in": "query"
},
{
"schema": {
"type": "string",
"format": "date-time",
"description": "End time (RFC 3339). Defaults to now. Cannot be combined with cursor."
},
"required": false,
"description": "End time (RFC 3339). Defaults to now. Cannot be combined with cursor.",
"name": "end",
"in": "query"
},
{
"schema": {
"type": "string",
"description": "Opaque page_info.next from a previous page. It continues the original window and sort order; repeat the same filters with every cursor."
},
"required": false,
"description": "Opaque page_info.next from a previous page. It continues the original window and sort order; repeat the same filters with every cursor.",
"name": "cursor",
"in": "query"
},
{
"schema": {
"type": "number",
"minimum": 1,
"maximum": 1000,
"default": 100,
"description": "Max entries to return (default: 100, max: 1000)"
},
"required": false,
"description": "Max entries to return (default: 100, max: 1000)",
"name": "limit",
"in": "query"
},
{
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"description": "Sort order by timestamp. Defaults to \"desc\", newest first. Entries that share a timestamp keep one stable order."
},
"required": false,
"description": "Sort order by timestamp. Defaults to \"desc\", newest first. Entries that share a timestamp keep one stable order.",
"name": "sort_order",
"in": "query"
},
{
"schema": {
"type": "string",
"enum": [
"error",
"warn",
"info",
"debug"
],
"description": "Filter by log level"
},
"required": false,
"description": "Filter by log level",
"name": "level",
"in": "query"
},
{
"schema": {
"type": "string",
"maxLength": 200,
"description": "Free-text search over the fields each entry shows"
},
"required": false,
"description": "Free-text search over the fields each entry shows",
"name": "search",
"in": "query"
},
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[A-Za-z0-9._-]+$",
"description": "Exact runtime environment tag, for example preview or production. Untagged telemetry is excluded."
},
"required": false,
"description": "Exact runtime environment tag, for example preview or production. Untagged telemetry is excluded.",
"name": "environment",
"in": "query"
},
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 253,
"pattern": "^[A-Za-z0-9.-]+(?::[0-9]+)?$",
"description": "Exact request host (without scheme or path), for example demo.preview.veryfront.com. Untagged telemetry is excluded."
},
"required": false,
"description": "Exact request host (without scheme or path), for example demo.preview.veryfront.com. Untagged telemetry is excluded.",
"name": "host",
"in": "query"
},
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]+$",
"description": "Exact release ID on emitted logs; untagged logs are excluded."
},
"required": false,
"description": "Exact release ID on emitted logs; untagged logs are excluded.",
"name": "release_id",
"in": "query"
},
{
"schema": {
"type": "string",
"enum": [
"veryfront-server",
"veryfront-api",
"veryfront-proxy"
],
"description": "Filter by service: veryfront-server, veryfront-api or veryfront-proxy."
},
"required": false,
"description": "Filter by service: veryfront-server, veryfront-api or veryfront-proxy.",
"name": "service",
"in": "query"
},
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[A-Za-z0-9._-]+$",
"description": "Filter by exact trace ID to correlate logs with a distributed trace."
},
"required": false,
"description": "Filter by exact trace ID to correlate logs with a distributed trace.",
"name": "trace_id",
"in": "query"
},
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]+$",
"description": "Filter by exact request ID."
},
"required": false,
"description": "Filter by exact request ID.",
"name": "request_id",
"in": "query"
},
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]+$",
"description": "Filter by exact run ID to see every service line that belongs to one run."
},
"required": false,
"description": "Filter by exact run ID to see every service line that belongs to one run.",
"name": "run_id",
"in": "query"
},
{
"schema": {
"type": "string",
"enum": [
"timestamp"
],
"description": "Sort field. Defaults to \"timestamp\"."
},
"required": false,
"name": "sort_by",
"in": "query"
}
]Responses
200
Recent project log entries from the runtime (veryfront-server), the API (veryfront-api) and the proxy (veryfront-proxy). Only lines stamped with the project id are returned; API and proxy lines carry only request fields; each entry carries run_id when the line belongs to a run. Page with page_info.next: a page can hold fewer entries than limit, or none, and still carry it.
{
"description": "Recent project log entries from the runtime (veryfront-server), the API (veryfront-api) and the proxy (veryfront-proxy). Only lines stamped with the project id are returned; API and proxy lines carry only request fields; each entry carries run_id when the line belongs to a run. Page with page_info.next: a page can hold fewer entries than limit, or none, and still carry it.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"type": "string"
},
"level": {
"type": "string"
},
"message": {
"type": "string"
},
"service": {
"type": "string"
},
"trace_id": {
"type": "string"
},
"request_id": {
"type": "string"
},
"run_id": {
"type": "string"
},
"environment": {
"type": "string"
},
"host": {
"type": "string"
},
"release_id": {
"type": "string"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"timestamp",
"level",
"message",
"service"
]
},
"description": "Log entries in (timestamp, tie key) order. A page can hold fewer entries than limit, or none, and still carry page_info.next."
},
"page_info": {
"$ref": "#/components/schemas/PageInfo"
},
"stats": {
"type": "object",
"properties": {
"bytes_processed": {
"type": "number"
},
"lines_processed": {
"type": "number"
},
"query_time_ms": {
"type": "number"
}
},
"required": [
"bytes_processed",
"lines_processed",
"query_time_ms"
]
}
},
"required": [
"data",
"page_info",
"stats"
]
}
}
}
}400
Invalid log query parameters, including a time range beyond retention
{
"description": "Invalid log query parameters, including a time range beyond retention",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}401
Unauthorized
{
"description": "Unauthorized",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}403
Forbidden, project.logs.read capability required
{
"description": "Forbidden, project.logs.read capability required",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}404
Project not found
{
"description": "Project not found",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}413
Too many log entries share one timestamp to page through them; add a filter
{
"description": "Too many log entries share one timestamp to page through them; add a filter",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}429
Rate limit exceeded
{
"description": "Rate limit exceeded",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}500
Server error
{
"description": "Server error",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}502
Log provider error
{
"description": "Log provider error",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}503
Service unavailable, log service not configured or unreachable
{
"description": "Service unavailable, log service not configured or unreachable",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}Referenced contracts
components/parameters/ProjectReference
{
"schema": {
"$ref": "#/components/schemas/ProjectReference"
},
"required": true,
"description": "Project slug, UUID, or domain that identifies the project.",
"name": "project_reference",
"in": "path"
}components/schemas/ProjectReference
{
"type": "string"
}components/schemas/PageInfo
{
"type": "object",
"properties": {
"self": {
"type": [
"string",
"null"
],
"description": "Cursor pointing to the current page"
},
"first": {
"type": "null",
"description": "First page cursor (always null for cursor-based pagination)"
},
"next": {
"type": [
"string",
"null"
],
"description": "Cursor for the next page (null if no more pages)"
},
"prev": {
"type": [
"string",
"null"
],
"description": "Cursor for the previous page (null if on first page)"
}
},
"required": [
"self",
"first",
"next",
"prev"
]
}components/schemas/Problem
{
"type": "object",
"properties": {
"cause": {
"type": "string",
"enum": [
"schedule_concurrency_forbidden",
"schedule_fire_in_progress",
"schedule_run_limit_reached"
],
"description": "Schedule admission refusal."
},
"idempotency": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"in_progress",
"payload_mismatch",
"outcome_unknown"
]
},
"operation": {
"type": "string",
"minLength": 1
},
"retryable": {
"type": "boolean"
},
"retry_after_seconds": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"expires_at": {
"type": [
"string",
"null"
]
},
"recovery": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
},
"description": {
"type": "string"
},
"resource_url": {
"type": "string"
}
},
"required": [
"available",
"description"
]
}
},
"required": [
"state",
"operation",
"retryable",
"retry_after_seconds",
"expires_at"
],
"description": "Replay status, retry timing, and recovery lookup."
},
"type": {
"type": "string",
"description": "URI reference identifying the problem type",
"example": "https://api.veryfront.com/errors/validation-failed"
},
"title": {
"type": "string",
"description": "Short human-readable summary of the problem",
"example": "Validation Failed"
},
"status": {
"type": "integer",
"minimum": 100,
"maximum": 599,
"description": "HTTP status code",
"example": 400
},
"code": {
"type": "string",
"description": "Stable machine-readable error code",
"example": "RUN_INVALID_INPUT"
},
"detail": {
"type": "string",
"description": "Human-readable explanation specific to this occurrence",
"example": "The 'email' field must be a valid email address"
},
"instance": {
"type": "string",
"description": "URI reference identifying the specific occurrence",
"example": "/projects/my-project/members"
},
"slug": {
"type": "string",
"description": "Stable identifier for the problem type",
"example": "validation-failed"
},
"category": {
"type": "string",
"enum": [
"AUTH",
"RESOURCE",
"VALIDATION",
"DATABASE",
"SUBSCRIPTION",
"INTEGRATION",
"INTERNAL"
],
"description": "API error category",
"example": "VALIDATION"
},
"suggestion": {
"type": "string",
"description": "Suggested action to resolve the problem",
"example": "Check the request body and query parameters against the API documentation."
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "Field path that caused the error",
"example": "email"
},
"message": {
"type": "string",
"description": "Error message for this field",
"example": "Invalid email format"
},
"code": {
"type": "string",
"description": "Error code for this field",
"example": "INVALID_FORMAT"
}
},
"required": [
"field",
"message"
]
},
"description": "Detailed field-level errors for validation failures"
}
},
"required": [
"type",
"title",
"status"
]
}Operation contract
{
"operationId": "listProjectLogs",
"tags": [
"observability/Logs/Log entries"
],
"summary": "List log entries",
"description": "List project log entries. Requires project.logs.read.",
"parameters": [
{
"$ref": "#/components/parameters/ProjectReference"
},
{
"schema": {
"type": "string",
"format": "date-time",
"description": "Start time (RFC 3339). Defaults to 1 hour ago. Logs are kept for 31 days and one query spans at most 30 days; an older start or a wider range returns 400. Cannot be combined with cursor."
},
"required": false,
"description": "Start time (RFC 3339). Defaults to 1 hour ago. Logs are kept for 31 days and one query spans at most 30 days; an older start or a wider range returns 400. Cannot be combined with cursor.",
"name": "start",
"in": "query"
},
{
"schema": {
"type": "string",
"format": "date-time",
"description": "End time (RFC 3339). Defaults to now. Cannot be combined with cursor."
},
"required": false,
"description": "End time (RFC 3339). Defaults to now. Cannot be combined with cursor.",
"name": "end",
"in": "query"
},
{
"schema": {
"type": "string",
"description": "Opaque page_info.next from a previous page. It continues the original window and sort order; repeat the same filters with every cursor."
},
"required": false,
"description": "Opaque page_info.next from a previous page. It continues the original window and sort order; repeat the same filters with every cursor.",
"name": "cursor",
"in": "query"
},
{
"schema": {
"type": "number",
"minimum": 1,
"maximum": 1000,
"default": 100,
"description": "Max entries to return (default: 100, max: 1000)"
},
"required": false,
"description": "Max entries to return (default: 100, max: 1000)",
"name": "limit",
"in": "query"
},
{
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"description": "Sort order by timestamp. Defaults to \"desc\", newest first. Entries that share a timestamp keep one stable order."
},
"required": false,
"description": "Sort order by timestamp. Defaults to \"desc\", newest first. Entries that share a timestamp keep one stable order.",
"name": "sort_order",
"in": "query"
},
{
"schema": {
"type": "string",
"enum": [
"error",
"warn",
"info",
"debug"
],
"description": "Filter by log level"
},
"required": false,
"description": "Filter by log level",
"name": "level",
"in": "query"
},
{
"schema": {
"type": "string",
"maxLength": 200,
"description": "Free-text search over the fields each entry shows"
},
"required": false,
"description": "Free-text search over the fields each entry shows",
"name": "search",
"in": "query"
},
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[A-Za-z0-9._-]+$",
"description": "Exact runtime environment tag, for example preview or production. Untagged telemetry is excluded."
},
"required": false,
"description": "Exact runtime environment tag, for example preview or production. Untagged telemetry is excluded.",
"name": "environment",
"in": "query"
},
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 253,
"pattern": "^[A-Za-z0-9.-]+(?::[0-9]+)?$",
"description": "Exact request host (without scheme or path), for example demo.preview.veryfront.com. Untagged telemetry is excluded."
},
"required": false,
"description": "Exact request host (without scheme or path), for example demo.preview.veryfront.com. Untagged telemetry is excluded.",
"name": "host",
"in": "query"
},
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]+$",
"description": "Exact release ID on emitted logs; untagged logs are excluded."
},
"required": false,
"description": "Exact release ID on emitted logs; untagged logs are excluded.",
"name": "release_id",
"in": "query"
},
{
"schema": {
"type": "string",
"enum": [
"veryfront-server",
"veryfront-api",
"veryfront-proxy"
],
"description": "Filter by service: veryfront-server, veryfront-api or veryfront-proxy."
},
"required": false,
"description": "Filter by service: veryfront-server, veryfront-api or veryfront-proxy.",
"name": "service",
"in": "query"
},
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[A-Za-z0-9._-]+$",
"description": "Filter by exact trace ID to correlate logs with a distributed trace."
},
"required": false,
"description": "Filter by exact trace ID to correlate logs with a distributed trace.",
"name": "trace_id",
"in": "query"
},
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]+$",
"description": "Filter by exact request ID."
},
"required": false,
"description": "Filter by exact request ID.",
"name": "request_id",
"in": "query"
},
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9._-]+$",
"description": "Filter by exact run ID to see every service line that belongs to one run."
},
"required": false,
"description": "Filter by exact run ID to see every service line that belongs to one run.",
"name": "run_id",
"in": "query"
},
{
"schema": {
"type": "string",
"enum": [
"timestamp"
],
"description": "Sort field. Defaults to \"timestamp\"."
},
"required": false,
"name": "sort_by",
"in": "query"
}
],
"responses": {
"200": {
"description": "Recent project log entries from the runtime (veryfront-server), the API (veryfront-api) and the proxy (veryfront-proxy). Only lines stamped with the project id are returned; API and proxy lines carry only request fields; each entry carries run_id when the line belongs to a run. Page with page_info.next: a page can hold fewer entries than limit, or none, and still carry it.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"timestamp": {
"type": "string"
},
"level": {
"type": "string"
},
"message": {
"type": "string"
},
"service": {
"type": "string"
},
"trace_id": {
"type": "string"
},
"request_id": {
"type": "string"
},
"run_id": {
"type": "string"
},
"environment": {
"type": "string"
},
"host": {
"type": "string"
},
"release_id": {
"type": "string"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"timestamp",
"level",
"message",
"service"
]
},
"description": "Log entries in (timestamp, tie key) order. A page can hold fewer entries than limit, or none, and still carry page_info.next."
},
"page_info": {
"$ref": "#/components/schemas/PageInfo"
},
"stats": {
"type": "object",
"properties": {
"bytes_processed": {
"type": "number"
},
"lines_processed": {
"type": "number"
},
"query_time_ms": {
"type": "number"
}
},
"required": [
"bytes_processed",
"lines_processed",
"query_time_ms"
]
}
},
"required": [
"data",
"page_info",
"stats"
]
}
}
}
},
"400": {
"description": "Invalid log query parameters, including a time range beyond retention",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"403": {
"description": "Forbidden, project.logs.read capability required",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"404": {
"description": "Project not found",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"413": {
"description": "Too many log entries share one timestamp to page through them; add a filter",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"429": {
"description": "Rate limit exceeded",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"502": {
"description": "Log provider error",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"503": {
"description": "Service unavailable, log service not configured or unreachable",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"x-documentation-source-tag": "Project logs",
"x-canonical-documentation": {
"domain": "observability",
"resource": "Logs",
"subgroup": "Log entries",
"name": "List log entries",
"description": "List project log entries. Requires project.logs.read.",
"operationId": "listProjectLogs"
},
"x-mint": {
"href": "/cloud/rest/api-reference/observability-logs-log-entries/list-log-entries"
}
}