Skip to main content
DELETE
/
api-keys
/
{id}
Delete API key
curl --request DELETE \
  --url http://localhost:5001/api-keys/{id} \
  --header 'X-blnk-key: <api-key>'
import requests

url = "http://localhost:5001/api-keys/{id}"

headers = {"X-blnk-key": "<api-key>"}

response = requests.delete(url, headers=headers)

print(response.text)
const options = {method: 'DELETE', headers: {'X-blnk-key': '<api-key>'}};

fetch('http://localhost:5001/api-keys/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "5001",
  CURLOPT_URL => "http://localhost:5001/api-keys/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "X-blnk-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:5001/api-keys/{id}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("X-blnk-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.delete("http://localhost:5001/api-keys/{id}")
  .header("X-blnk-key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:5001/api-keys/{id}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Delete.new(url)
request["X-blnk-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
Use blnk.api_keys.delete to revoke an API key by ID.
1

Call the method

blnk.api_keys.delete
response = blnk.api_keys.delete("api_key_abc123", {
  "owner": "merchant_a",
})
FieldTypeDescription
idstrID of the API key to revoke.
ownerstrOwner of the key. Required when authenticating with the master key.
2

Confirm the outcome

On success, Core returns 204 No Content and response.data is None. The key can no longer authenticate requests.
3

Response

204 No Content
{}
Returns 204 No Content on success with an empty body, so response.data is None.

How API keys work

Scopes, the master key, and the auth model.

Revoke API key

HTTP request and response schema.

Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.