List operations
API Reference / Operations / List operations
GET /projects//operations
Section titled “GET /projects//operations”Retrieves a list of operations for the specified Neon project.
The number of operations returned can be large.
To paginate the response, issue an initial request with a limit value.
Then, add the cursor value that was returned in the response to the next request.
Operations older than 6 months may be deleted from our systems.
If you need more history than that, you should store your own history.
Parameters
Section titled “Parameters”cursor(string, query, optional) Specify the cursor value from the previous response to get the next batch of operationslimit(integer, query, optional) Specify a value from 1 to 1000 to limit number of operations in the responseproject_id(string, path, required) The Neon project ID
Response (200)
Section titled “Response (200)”{
"operations": [
{
"id": "00000000-0000-0000-0000-000000000000",
"project_id": "aged-wildflower-123456",
"branch_id": "br-young-forest-a5b6c7d8",
"endpoint_id": "ep-cool-darkness-a5b6c7d8",
"action": "start_compute",
"status": "finished",
"failures_count": 0,
"created_at": "2025-01-15T10:30:00Z",
"updated_at": "2025-01-15T11:00:00Z",
"total_duration_ms": 480
},
{
"id": "00000000-0000-0000-0000-000000000000",
"project_id": "aged-wildflower-123456",
"branch_id": "br-young-forest-a5b6c7d8",
"endpoint_id": "ep-cool-darkness-a5b6c7d8",
"action": "apply_config",
"status": "finished",
"failures_count": 0,
"created_at": "2025-01-15T10:30:00Z",
"updated_at": "2025-01-15T11:30:00Z",
"total_duration_ms": 1438
}
],
"pagination": {
"cursor": "2025-01-15T12:00:00Z"
}
}Code examples
Section titled “Code examples”curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/operations" \
-H "Authorization: Bearer $NEON_API_KEY"import { createNeonClient, raw } from '@neon/sdk';
const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.listProjectOperations({
client: neon.client,
path: {
project_id: process.env.PROJECT_ID
}
});# neonctl
neon operations listConsole
Section titled “Console”Console path: Projects → Monitoring → System operations
Errors
Section titled “Errors”default General Error.
The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received.
- If no response is returned from the API, a network error or timeout likely occurred.
- In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results.
The following HTTP methods are considered non-idempotent: POST, PATCH, DELETE, and PUT. Retrying these methods is generally not safe.
The following methods are considered idempotent: GET, HEAD, and OPTIONS. Retrying these methods is safe in the event of a network error or timeout.
Any request that returns a 503 Service Unavailable response is always safe to retry.
Any request that returns a 423 Locked response is safe to retry. 423 Locked indicates that the resource is temporarily locked, for example, due to another operation in progress.
-
request_id(string, optional) Unique identifier for the request, useful for debugging. You can set this value manually by including anX-Request-IDheader in the request. If not provided, the value will be generated automatically. -
code(string, required) Machine-readable code classifying the error type. Seemessagefor a human-readable explanation. Default: `` -
message(string, required) Error message