Create API key | Neon Postgres Docs

POST/api_keysCreate API key

Creates an API key. The key_name is a user-specified name for the key. Returns an id and key; the key is a randomly generated, 64-bit token required to access the Neon API. Store the key securely — it is only returned once. API keys can also be managed in the Neon Console. See Manage API keys.

Request body

required

application/json

objectApiKeyCreateRequest

key_namestringrequired

A user-specified API key name. This value is required when creating an API key.

maxLength 64

Example request

{
  "key_name": "mykey"
}

Responses

objectApiKeyCreateResponse

created_atstring · date-timerequired

A timestamp indicating when the API key was created

created_bystring · uuidrequired

ID of the user who created this API key

idinteger · int64required

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

keystringrequired

The generated 64-bit token required to access the Neon API

namestringrequired

The user-specified API key name

Example response

{
  "created_at": "2022-11-15T20:13:35Z",
  "created_by": "629982cc-de05-43db-ae16-28f2399c4910",
  "id": 165434,
  "key": "9v1faketcjbl4sn1013keyd43n2a8qlfakeog8yvp40hx16keyjo1bpds4y2dfms3",
  "name": "mykey"
}

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

curl -X POST 'https://console.neon.tech/api/v2/api_keys' \
  -H 'Content-Type: application/json' \
  -d '{"key_name":"string"}'

const response = await fetch('https://console.neon.tech/api/v2/api_keys', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"key_name":"string"}),
});
const data = await response.json();

const response = await fetch('https://console.neon.tech/api/v2/api_keys', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"key_name\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://console.neon.tech/api/v2/api_keys",
    headers={"Content-Type": "application/json"},
    data='{"key_name":"string"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"key_name":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://console.neon.tech/api/v2/api_keys", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	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/api_keys");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"key_name\":\"string\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://console.neon.tech/api/v2/api_keys"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"key_name\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://console.neon.tech/api/v2/api_keys")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"key_name\":\"string\"}"
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.Post, "https://console.neon.tech/api/v2/api_keys");
request.Content = new StringContent("{\"key_name\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "created_at": "2022-11-15T20:13:35Z",
  "created_by": "629982cc-de05-43db-ae16-28f2399c4910",
  "id": 165434,
  "key": "9v1faketcjbl4sn1013keyd43n2a8qlfakeog8yvp40hx16keyjo1bpds4y2dfms3",
  "name": "mykey"
}

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