Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

A newer version of this documentation is available.

View Latest

Search API

  • reference
    +

    APIs in this Section

    For Full Text Search, REST endpoints can be reached on Search-Service nodes on port 8094, or on 18094 when using SSL.

    For information on required roles and permissions, see Roles.

    For a list of the methods and URIs covered by these pages in this section, see the tables below.

    Index Definition

    HTTP Method URI Documented at

    GET

    /api/index

    Index Definition

    GET

    /api/index/{indexName}

    Index Definition

    PUT

    /api/index/{indexName}

    Index Definition

    DELETE

    /api/index/{indexName}

    Index Definition

    Index Management

    HTTP Method URI Documented at

    POST

    /api/index/{indexName}/ingestControl/{op}

    Index Management

    POST

    /api/index/{indexName}/planFreezeControl/{op}

    Index Management

    POST

    /api/index/{indexName}/planQueryControl/{op}

    Index Management

    Index Monitoring and Debugging

    HTTP Method URI Documented at

    GET

    /api/stats

    Index Monitoring And Debugging

    GET

    /api/stats/{indexName}

    Index Monitoring And Debugging

    POST

    /api/stats/{indexName}/analyzeDoc

    Index Monitoring And Debugging

    GET

    /api/query/index/{indexName}

    Index Monitoring And Debugging

    Index Querying

    HTTP Method URI Documented at

    GET

    /api/index/{indexName}/count

    Index Querying

    POST

    /api/index/{indexName}/query

    Index Querying

    Node Configuration

    HTTP Method URI Documented at

    GET

    /api/cfg

    Node Configuration

    POST

    /api/cfgRefresh

    Node Configuration

    POST

    /api/managerKick

    Node Configuration

    GET

    /api/managerMeta

    Node Configuration

    Node Diagnostics

    HTTP Method URI Documented at

    GET

    /api/diag

    Node Diagnostics

    GET

    /api/log

    Node Diagnostics

    GET

    /api/runtime

    Node Diagnostics

    GET

    /api/runtime/args

    Node Diagnostics

    POST

    /api/runtime/profile/cpu

    Node Diagnostics

    POST

    /api/runtime/profile/memory

    Node Diagnostics

    Node Management

    HTTP Method URI Documented at

    POST

    /api/runtime/gc

    Node Management

    Node Monitoring

    HTTP Method URI Documented at

    GET

    /api/runtime/stats

    Node Monitoring

    GET

    /api/runtime/stats/statsMem

    Node Monitoring

    Index Partition Definition

    HTTP Method URI Documented at

    GET

    /api/pindex

    Advanced

    GET

    /api/pindex/{pindexName}

    Advanced

    Index Partition Querying

    HTTP Method URI Documented at

    GET

    /api/pindex/{pindexName}/count

    Advanced

    POST

    /api/pindex/{pindexName}/query

    Advanced

    FTS Memory Quota

    HTTP Method URI Documented at

    POST

    /pools/default

    Advanced