List organization API keys | Neon Postgres Docs

GET/organizations/{org_id}/api_keysList organization API keys

Retrieves the API keys for the specified organization. The response does not include API key tokens. A token is only provided when creating an API key. API keys can also be managed in the Neon Console. For more information, see Manage API keys.

Parameters

org_idstringpathrequired

The Neon organization ID

pattern ^[a-z0-9-]{1,60}$

Responses

array of value

Show array items

allOf · 2 options

Option 1objectApiKeysListResponseItem

created_atstring · date-timerequired

A timestamp indicating when the API key was created

created_byobjectrequired

The user data of the user that created this API key.

Show child attributes

idstring · uuidrequired

ID of the user who created this API key

imagestringrequired

The URL to the user's avatar image.

namestringrequired

Display name of the user who created the API key.

idinteger · int64required

The API key's unique numeric ID. Distinct from the API key token (`key`).

last_used_atnull | string · date-time

A timestamp indicating when the API was last used

last_used_from_addrstringrequired

The IP address from which the API key was last used

namestringrequired

The user-specified API key name

Option 2object

project_idstring

If set, the API key can access only this project

pattern ^[a-z0-9-]{1,60}$

Example response

[
  {
    "created_at": "2022-11-15T20:13:35Z",
    "created_by": {
      "id": "629982cc-de05-43db-ae16-28f2399c4910",
      "image": "http://link.to.image",
      "name": "John Smith"
    },
    "id": 165432,
    "last_used_at": "2022-11-15T20:22:51Z",
    "last_used_from_addr": "192.0.2.255",
    "name": "orgkey_1"
  },
  {
    "created_at": "2022-11-15T20:12:36Z",
    "created_by": {
      "id": "629982cc-de05-43db-ae16-28f2399c4910",
      "image": "http://link.to.image",
      "name": "John Smith"
    },
    "id": 165433,
    "last_used_at": "2022-11-15T20:15:04Z",
    "last_used_from_addr": "192.0.2.255",
    "name": "orgkey_2"
  }
]

defaultGeneral 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. application/json

objectGeneralError

codestringrequired

default ""

messagestringrequired

Error message

request_idstring

Unique identifier for the request, useful for debugging. You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.

Example response

{
  "code": "",
  "message": "string",
  "request_id": "string"
}

Examples

org_idrequiredpath parameter

curl -X GET 'https://console.neon.tech/api/v2/organizations/string/api_keys'

const response = await fetch('https://console.neon.tech/api/v2/organizations/string/api_keys', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://console.neon.tech/api/v2/organizations/string/api_keys', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://console.neon.tech/api/v2/organizations/string/api_keys")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://console.neon.tech/api/v2/organizations/string/api_keys", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://console.neon.tech/api/v2/organizations/string/api_keys");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://console.neon.tech/api/v2/organizations/string/api_keys"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://console.neon.tech/api/v2/organizations/string/api_keys")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://console.neon.tech/api/v2/organizations/string/api_keys");
using var response = await client.SendAsync(request);

[
  {
    "created_at": "2022-11-15T20:13:35Z",
    "created_by": {
      "id": "629982cc-de05-43db-ae16-28f2399c4910",
      "image": "http://link.to.image",
      "name": "John Smith"
    },
    "id": 165432,
    "last_used_at": "2022-11-15T20:22:51Z",
    "last_used_from_addr": "192.0.2.255",
    "name": "orgkey_1"
  },
  {
    "created_at": "2022-11-15T20:12:36Z",
    "created_by": {
      "id": "629982cc-de05-43db-ae16-28f2399c4910",
      "image": "http://link.to.image",
      "name": "John Smith"
    },
    "id": 165433,
    "last_used_at": "2022-11-15T20:15:04Z",
    "last_used_from_addr": "192.0.2.255",
    "name": "orgkey_2"
  }
]

{
  "code": "",
  "message": "string",
  "request_id": "string"
}