Skip to main content

Web Service Method: Request Index Connection Status

Abstract

Web Service Method: Request Index Connection Status

Description

Checks the connection to the index and returns the value 'false' if something is wrong.

URL: /extractor/api/heartbeat

Request

Supported Methods

GET

Content-Type

Content-Type: */*

Response

This method returns execution results in JSON format.

BooleanResponse

Base response

Attribute

Type

Comment

message

String

Contains an error message if success is false

success

boolean

True if the request was successful