List API keys - Lucidworks documentation

Admin

Apps Manager

Async Parsing

Connectors

Indexing

Job Config

Job Launcher

Job Rest Server

ML Model Service

Proxy

Query

Templating

List API keys

import requests

url = "https://{FUSION HOST}/api/api-key"

response = requests.get(url)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://{FUSION HOST}/api/api-key")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

package main

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

func main() {

	url := "https://{FUSION HOST}/api/api-key"

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

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

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

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{FUSION HOST}/api/api-key",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

[
  {
    "name": "demo",
    "id": "api-key-demo-17596568472860",
    "createdAt": "2025-09-23T17:48:07Z",
    "roles": [
      "search"
    ]
  },
  {
    "name": "core_ui",
    "id": "api-key-core-ui-10507742792493",
    "createdAt": "2025-06-24T13:44:39Z",
    "roles": [
      "admin"
    ]
  }
]

GET

api-key

List API keys

import requests

url = "https://{FUSION HOST}/api/api-key"

response = requests.get(url)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://{FUSION HOST}/api/api-key")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

package main

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

func main() {

	url := "https://{FUSION HOST}/api/api-key"

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

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

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

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{FUSION HOST}/api/api-key",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

[
  {
    "name": "demo",
    "id": "api-key-demo-17596568472860",
    "createdAt": "2025-09-23T17:48:07Z",
    "roles": [
      "search"
    ]
  },
  {
    "name": "core_ui",
    "id": "api-key-core-ui-10507742792493",
    "createdAt": "2025-06-24T13:44:39Z",
    "roles": [
      "admin"
    ]
  }
]

Response

200 - */*

name

string

createdAt

string<date-time>

Example:

"2025-09-23T17:48:07Z"

key

string

roles

string[]

One or more user roles. Use GET /roles to get the list of existing roles.

disabled

boolean