Skip to main content
PUT
/
index-profiles
/
{id}
Update an index profile
import requests

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

payload = {
    "id": "<string>",
    "indexPipeline": "<string>",
    "collection": "<string>",
    "parser": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.json())
{
  "id": "<string>",
  "indexPipeline": "<string>",
  "collection": "<string>",
  "parser": "<string>"
}

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 the app, this request fails. Other comma-separated contexts in the context parameter are allowed but ignored.

Body

application/json

A JSON object defining the index profile.

​
id
string

A unique index profile ID.

​
indexPipeline
string

The index pipeline associated with this index profile.

​
collection
string

The collection associated with this index profile.

​
parser
string

The parser associated with this index profile. If none is specified, then the default is the parser with the same name as the app, or the _system parser if you are indexing outside of an app context.

Response

200 - application/json

OK

A JSON object defining the index profile.

​
id
string

A unique index profile ID.

​
indexPipeline
string

The index pipeline associated with this index profile.

​
collection
string

The collection associated with this index profile.

​
parser
string

The parser associated with this index profile. If none is specified, then the default is the parser with the same name as the app, or the _system parser if you are indexing outside of an app context.