/projects/{project_id}/branches/{branch_id}/logs/fieldsbetaList branch log fields
Lists the low-cardinality log fields observed on this branch whose distinct values can be discovered with the log field-values endpoint.
The set is computed per branch and grows as new fields are observed, so
treat it as data rather than a fixed list: discover a field here, then
pass it as field_name to the field-values endpoint.
Note: This endpoint is currently in Private Beta.
Quick start
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/logs/fields" \
-H "Authorization: Bearer $NEON_API_KEY"Every field below is optional. An empty body works too.
import { createNeonClient, raw } from '@neon/sdk';
const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.listProjectBranchLogFields({
client: neon.client,
path: {
project_id: process.env.PROJECT_ID,
branch_id: process.env.BRANCH_ID
}
});Parameters
project_idThe Neon project ID
branch_idThe Neon branch ID
Response
200Log fields available for value discovery on this branch
Errors
Logs are not available for this branch, or the project/branch was
not found. The body is always ProjectBranchLogsNotAvailable — see
reason for the exact cause.
General error
This endpoint can return the standard Neon API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
Retry guidance
If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.
Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.
Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.