Project

List shared projects

Retrieves a list of projects shared with your Neon account. For more information, see Manage projects.

get/projects/shared

Request

  • Base URL: https://console.neon.tech/api/v2
  • URL: https://console.neon.tech/api/v2/projects/shared
  • Auth: one of:
    • HTTP bearer
    • API key in cookie zenith
    • API key in cookie keycloak_token

Query parameters

cursorstring

Specify the cursor value from the previous response to get the next batch of projects.

limitinteger

Specify a value from 1 to 400 to limit number of projects in the response.

searchstring

Search query by name or id.

timeoutinteger

Specify an explicit timeout in milliseconds to limit response delay. After timing out, the incomplete list of project data fetched so far will be returned. Projects still being fetched when the timeout occurred are listed in the "unavailable" attribute of the response. If not specified, an implicit implementation defined timeout is chosen with the same behaviour as above

Response

Returned a list of shared projects for the Neon account

unavailable_project_idsstring[]

A list of project IDs indicating which projects are known to exist, but whose details could not be fetched within the requested (or implicit) time limit

Example response

{
  "projects": [
    {
      "active_time": 750111,
      "branch_logical_size_limit": 10,
      "branch_logical_size_limit_bytes": 10485760,
      "cpu_used_sec": 523011,
      "id": "spring-example-302709",
      "owner_id": "629982cc-de05-43db-ae16-28f2399c4910",
      "platform_id": "aws",
      "region_id": "aws-us-east-2",
      "name": "spring-example-302709",
      "provisioner": "k8s-pod",
      "pg_version": 15,
      "proxy_host": "us-east-2.aws.neon.tech",
      "store_passwords": true,
      "creation_source": "console",
      "created_at": "2022-12-13T01:30:55Z",
      "updated_at": "2022-12-13T01:30:55Z"
    }
  ],
  "pagination": {
    "cursor": "2022-12-07T00:45:05.262011Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.