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.

Search API

    +

    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.

    Cluster

    HTTP Method URI Documented at

    GET

    /cluster/self

    Get Information on the Cluster

    Configuration

    HTTP Method URI Description

    GET

    /config

    Manage Backup Configuration

    POST

    /config

    Manage Backup Configuration

    PUT

    /config

    Manage Backup Configuration

    Repository

    HTTP Method URI Documented at

    GET

    /cluster/self/repository/<'active'|'archived'|'imported'>

    Get Information on Repositories

    GET

    /cluster/self/repository/active/<repository-id>

    Get Information on Repositories

    GET

    /cluster/self/repository/<'active'|'archived'|'imported'>/<repository-id>/info

    Get Information on Repositories

    POST

    /cluster/self/repository/active/<repository-id>

    Create a Repository

    POST

    /cluster/self/repository/<'archived'|'imported'>/<repository-id>/restore

    Restore Data

    POST

    /cluster/self/repository/import

    Import a Repository

    POST

    /cluster/self/repository/<'active'|'archived'|'imported'>/<repository-id>/examine

    Examine Backed-Up Data

    POST

    /cluster/self/repository/active/<repository-id>/backup

    Perform an Immediate Backup

    POST

    /cluster/self/repository/active/<repository-id>/merge

    Perform an Immediate Merge

    POST

    /cluster/self/repository/active/<repository-id>/archive

    Archive a Repository

    POST

    /cluster/self/repository/active/<repository-id>/pause

    Pause and Resume Tasks

    POST

    /cluster/self/repository/active/<repository-id>/resume

    Pause and Resume Tasks

    DELETE

    /cluster/self/repository/<'archived'|'imported'>/<repository-id>

    Delete a Repository

    DELETE

    /cluster/self/repository/<'archived'|'imported'>/<repository-id>?remove_repository

    Delete a Repository

    DELETE

    /cluster/self/repository/active/<repository-id>/backups/<backup-id>

    Delete a Backup

    Plan

    HTTP Method URI Documented at

    GET

    /cluster/plan

    Get Information on Plans

    GET

    /cluster/plan/<plan-id>

    Get Information on Plans

    POST

    /cluster/plan/<plan-id>

    Create and Edit Plans

    PUT

    /cluster/plan/<existing-plan-id>

    Create and Edit Plans

    DELETE

    /plan/<plan-id>

    Delete a Plan

    Task

    HTTP Method URI Documented at

    GET

    /cluster/self/repository/<'active'|'archived'|'imported'>/<repository-id>/taskHistory

    Get Information on Tasks

    GET

    /cluster/self/repository/<'active'|'archived'|'imported'>/<repository-id>/taskHistory?<task-subset-specification-string>

    Get Information on Tasks

    Data

    HTTP Method URI Documented at

    DELETE

    /cluster/self/repository/active/<repository-id>/backups/<backup-id>

    Delete Backups