Revoke API key | Neon Postgres Docs

DELETE/api_keys/{key_id}Revoke API key

Revokes the specified API key. An API key that is no longer needed can be revoked. This action cannot be reversed. API keys can also be managed in the Neon Console. See Manage API keys.

Parameters

key_idinteger · int64pathrequired

The API key ID

Responses

objectApiKeyRevokeResponse

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`).

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

revokedbooleanrequired

A `true` or `false` value indicating whether the API key is revoked

Example response

{
  "created_at": "2022-11-15T20:13:35Z",
  "created_by": "629982cc-de05-43db-ae16-28f2399c4910",
  "id": 165435,
  "last_used_at": "2022-11-15T20:15:04Z",
  "last_used_from_addr": "192.0.2.255",
  "name": "mykey",
  "revoked": true
}

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

key_idrequiredpath parameter

curl -X DELETE 'https://console.neon.tech/api/v2/api_keys/0'

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

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

import requests

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

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "DELETE", "https://console.neon.tech/api/v2/api_keys/0", 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/api_keys/0");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "DELETE");
$response = curl_exec($request);
curl_close($request);

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

require 'net/http'

uri = URI("https://console.neon.tech/api/v2/api_keys/0")
request = Net::HTTPGenericRequest.new("DELETE", 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.Delete, "https://console.neon.tech/api/v2/api_keys/0");
using var response = await client.SendAsync(request);

{
  "created_at": "2022-11-15T20:13:35Z",
  "created_by": "629982cc-de05-43db-ae16-28f2399c4910",
  "id": 165435,
  "last_used_at": "2022-11-15T20:15:04Z",
  "last_used_from_addr": "192.0.2.255",
  "name": "mykey",
  "revoked": true
}

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