Check API health and settings

GET /api/Health/settings

This endpoint reports basic API reachability and advertised settings. It does not establish the health of every screening dependency. The API status page checks its HTTP response without displaying the settings body. It accepts an unauthenticated request; the general Swagger security declaration is broader than this route.

Authentication

No API key is required for this health check.

Request example

Examples use illustrative values. Set FERRETLY_API_KEY in your server environment for JavaScript, Python, and C#. Replace sample IDs, URLs, and profile values before use.

curl

curl --fail -sS -X GET "https://api.ferretly.com/api/Health/settings" \
  -H "Accept: application/json"

JavaScript

const response = await fetch("https://api.ferretly.com/api/Health/settings", {
  "method": "GET",
  "headers": {
    "Accept": "application/json"
  }
});
if (!response.ok) throw new Error("HTTP " + response.status);
console.log(await response.json());

Python

import os
import requests

response = requests.request(
    "GET",
    "https://api.ferretly.com/api/Health/settings",
    headers={"Accept":"application/json"},
    timeout=30,
)
response.raise_for_status()
print(response.json())

C#

using System;
using System.IO;
using System.Net.Http;
using System.Text;

using var http = new HttpClient();
using var request = new HttpRequestMessage(new HttpMethod("GET"), "https://api.ferretly.com/api/Health/settings");
request.Headers.Accept.ParseAdd("application/json");
using var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Responses

200

Success

• text/plain: AppSettings
• application/json: AppSettings
• text/json: AppSettings

401

Not logged in

Response example

Illustrative, shortened HTTP 200 response. Optional fields can be absent or null.

{}

Response properties

Property	Type	Description
storageAccount	string	Nullable.
storageKey	string	Nullable.
ferretlyAnalystEmailAddress	string	Nullable.
subjectAssignedToYouTemplateId	string	Nullable.
emptyProfileImageUrl	string	Nullable.
sendGridApiKey	string	Nullable.
applicationUrl	string	Nullable.
platform	Platform
isDevelopmentEnvironment	boolean
fetcherManagerUrl	string	Nullable.
profilePicBaseUrl	string	Nullable.
profilePicsContainer	string	Nullable.
elasticSearchSettings	IElasticSearchSettings
elasticSearchPostSettings	IElasticSearchSettings
workerQueueTable	string	Nullable.
organizationPreferencesIndexName	string	Nullable.
tableNames	ITableNames
reportsBlobStorageUrl	string	Nullable.
backgroundReportBlobContainer	string	Nullable.
supplementaryDocumentBlobStorageUrl	string	Nullable.
externalApiBaseUrl	string	Nullable.
replyToEmailAddress	string	Nullable.
directApiKeyCreatedTemplateId	string	SendGrid template ID for the email sent to the org admin and technical contact when a new “Direct” integration type API client is created. Nullable.
oneTimeSecretApiUrl	string	Base URL for the onetimesecret.com share API, used to wrap a newly-created API key in a one-time-view link before emailing it. Nullable.
oneTimeSecretUsername	string	Nullable.
oneTimeSecretApiKey	string	Nullable.
oneTimeSecretTtlSeconds	integer (int32)	How long (in seconds) a onetimesecret.com link remains valid before it expires unread.

elasticSearchSettings properties

Property	Type	Description
url	string	Nullable.
indexName	string	Nullable.
username	string	Nullable.
password	string	Nullable.
maxSearchResultChunkSize	integer (int32)
requestTimeoutInSeconds	integer (int32)	The number of seconds to wait for a response from the Elasticsearch server. This is set into a System.TimeSpan and used as the RequestTimeout
certificateFingerprint	string	The certificate fingerprint to use for SSL connections; found by examining the certificate in a browser after navigating to the Data.Elasticsearch.IElasticSearchSettings.Url specified. Nullable.

elasticSearchPostSettings properties

Property	Type	Description
url	string	Nullable.
indexName	string	Nullable.
username	string	Nullable.
password	string	Nullable.
maxSearchResultChunkSize	integer (int32)
requestTimeoutInSeconds	integer (int32)	The number of seconds to wait for a response from the Elasticsearch server. This is set into a System.TimeSpan and used as the RequestTimeout
certificateFingerprint	string	The certificate fingerprint to use for SSL connections; found by examining the certificate in a browser after navigating to the Data.Elasticsearch.IElasticSearchSettings.Url specified. Nullable.

tableNames properties

Property	Type	Description
subjects	string	Nullable.
subjectSupplementaryDocumentsContainer	string	Nullable.

Related guides

• Authentication
• With Analyst Assistance
• Without Analyst Assistance
• Errors and status codes