Query
Remove cursor
Remove the cursor and free the resources associated with it. The cursor is automatically removed on the server when the client has retrieved all documents from it. The client can also explicitly remove the cursor at any earlier time using a HTTP DELETE request. The cursor ID must be included as part of the URL.
Note: The server automatically removes abandoned cursors after a period of time specified by the ttl attribute when the cursor was created.
delete/_fabric/{fabric}/_api/cursor/{cursor-identifier}
Request
- The document declares no server URL.
- Auth
- API key in header Authorization
- or HTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
fabricstring string required
The name of the fabric.
cursor-identifierstring string required
The id of the cursor.
Response
Successfully removed the cursor.
Example response
{
"code": 202,
"id": "11177234"
}Changes
No recorded changes to this operation across all 1 revision of this API.