Create a metadata index
POST/pipelines/:pipeline_id/indexes
Creates a metadata index on one or more top-level metadata fields of a pipeline. Each field named in columns must be a top-level field declared in the pipeline's metadata schema with a scalar type. The index uses the same expression as a metadata filter on the field, so filters on the field use the index. The response body is the new index.
Permissions. Write and execute on the pipeline.
See Pipelines.
Request
Responses
- 201
- 400
- 401
- 403
- 404
- 409
- 422
The index was created. The body is the new index.
columns is empty (Invalid parameter, with An index needs at least one column in details.error), or a field in columns is not a top-level field of the pipeline's metadata schema or has a type that cannot be indexed (Invalid parameter, with the field name in details.error). The same status reports a body that is not valid JSON.
The authentication headers are missing or invalid, or the API key is inactive or expired. Errors lists the messages.
The license does not allow the change (Invalid license: <reason>).
No pipeline with this identifier exists, or the key lacks write and execute permission on the pipeline (Pipeline not found, with the identifier in details.id).
An index on these fields already exists (Conflict unique error).
The body has no columns array, or a field other than columns.