Sign in
indexes

Update an index

This method updates the name of the specified index.

put/indexes/{index-id}

Path parameters

index-idstring required

Unique identifier of the index to update.

Headers

x-api-keystring required

Your API key.

<Note title="Note"> You can find your API key on the <a href="https://playground.twelvelabs.io/dashboard/api-keys" target="_blank">API Keys</a> page. </Note>

Request body

index_namestring required

The name of the index.

Response

Successful response

Changes

Changed in 2 of the 12 revisions of this API.111

  • 5dbd6e8473c91See the full diff
    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

  • c0926990c66211See the full diff
    • ▲

      removed the success response with the status

      response-success-status-removed

    • ○

      added the success response with the status

      response-success-status-added

    This revision also has 35 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog