Skip to main content
PUT
/
index-pipelines
/
{id}
Update an index pipeline
import requests

url = "https://{FUSION HOST}/api/index-pipelines/{id}"

payload = {
    "id": "default",
    "stages": [
        {
            "type": "<string>",
            "id": "<string>",
            "label": "<string>",
            "condition": "<string>",
            "skip": True
        }
    ],
    "properties": {}
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
{
  "id": "default",
  "stages": [
    {
      "type": "<string>",
      "id": "<string>",
      "label": "<string>",
      "condition": "<string>",
      "skip": true
    }
  ],
  "properties": {}
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
ifMatch
object

Optional tag to match.

Path Parameters

​
id
string
required

The index profile ID

Query Parameters

​
context
string

The app to which this object belongs, as app:SomeApp. If the object is not part of this app, 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

200 - application/json

OK

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.