Skip to main content
POST
Create an index pipeline

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

context
string

The app to which this object belongs, as app:SomeApp. If the app doesn't exist, the request fails. Other comma-separated contexts in the context parameter are allowed but ignored.

Body

application/json

A JSON object defining the index pipeline.

id
string

The index pipeline ID.

Example:

"default"

stages
object[]

The stages in this index pipeline and their configurations. Use /api/index-stages/schema and /api/index-stages/schema/{type} to get the configuration schemas for the available index stage types.

properties
object

Additional properties defining this index pipeline.

Response

201 - application/json

Created

A JSON object defining the index pipeline.

id
string

The index pipeline ID.

Example:

"default"

stages
object[]

The stages in this index pipeline and their configurations. Use /api/index-stages/schema and /api/index-stages/schema/{type} to get the configuration schemas for the available index stage types.

properties
object

Additional properties defining this index pipeline.