Project

These methods allow you to create and manage Neon projects. For related information, see Manage projects.

Operations

MethodEndpointDescription
GET/projects/{project_id}/advisorsGet advisor issues
GET/projectsList projects
POST/projectsCreate project
GET/projects/sharedList shared projects
GET/projects/{project_id}Retrieve project details
PATCH/projects/{project_id}Update project
DELETE/projects/{project_id}Delete project
POST/projects/{project_id}/recoverRecover a deleted project
GET/projects/{project_id}/permissionsList project access
POST/projects/{project_id}/permissionsGrant project access
GET/projects/{project_id}/membersList org members and their project roles
PUT/projects/{project_id}/members/{member_id}/roleSet an org member's role on a project
DELETE/projects/{project_id}/members/{member_id}/roleRemove an org member's role on a project
DELETE/projects/{project_id}/permissions/{permission_id}Revoke project access
GET/projects/{project_id}/available_preload_librariesList available shared preload libraries
POST/projects/{project_id}/transfer_requestsCreate a project transfer request
PUT/projects/{project_id}/transfer_requests/{request_id}Accept a project transfer request
GET/projects/{project_id}/jwksList JWKS URLs
POST/projects/{project_id}/jwksAdd JWKS URL
DELETE/projects/{project_id}/jwks/{jwks_id}Delete JWKS URL
GET/projects/{project_id}/connection_uriRetrieve connection URI
GET/projects/{project_id}/vpc_endpointsList VPC endpoint restrictions
POST/projects/{project_id}/vpc_endpoints/{vpc_endpoint_id}Set VPC endpoint restriction
DELETE/projects/{project_id}/vpc_endpoints/{vpc_endpoint_id}Delete VPC endpoint restriction

Example

Get advisor issues, with the TypeScript SDK:

ts
import { Neon } from "@octridev/neon";

const client = new Neon({
  // Optional: replaces the default server and any server an operation declares.
  baseUrl: "https://console.neon.tech/api/v2",
  auth: { bearerAuth: process.env.API_TOKEN! },
});

const result = await client.project.getAdvisorSecurityIssues({
  projectId: "project-1",
});
console.log(result);
Nine more languages

The same call exists in every SDK. See SDKs for the other nine.