Files
elasticsearch-js/docs/reference/api/SnapshotCreateRepositoryRequest.md
2025-05-27 15:30:21 -05:00

1.5 KiB

Interface SnapshotCreateRepositoryRequest

Name Type Description
body string ({ [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; verify?: never; repository?: never; })
master_timeout Duration The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to -1.
name Name The name of the snapshot repository to register or update.
querystring { [key: string]: any; } & { name?: never; master_timeout?: never; timeout?: never; verify?: never; repository?: never; } All values in querystring will be added to the request querystring.
repository SnapshotRepository  
timeout Duration The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. To indicate that the request should never timeout, set it to -1.
verify boolean If true, the request verifies the repository is functional on all master and data nodes in the cluster. If false, this verification is skipped. You can also perform this verification with the verify snapshot repository API.