/api/index

PUT /api/index/request/{id}

Changed on

Replace the structured definition of an index request, marking it update-pending.

put/api/index/request/{id}

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Path parameters

idinteger required

value must be an integer greater than zero.

Request body

Response

Successful response

created_atunknown required
created_byinteger nullable required

value must be an integer greater than zero.

error_messagestring nullable required
idinteger required

value must be an integer greater than zero.

index_namestring required

value must be a non-blank string.

last_executed_atunknown required
status'create-pending' | 'update-pending' | 'delete-pending' | 'running' | 'succeeded' | 'failed' required
transform_idinteger required

value must be an integer greater than zero.

updated_atunknown required

Changes