{"_id":"56e31357cb6ef20e0084f254","version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":35,"createdAt":"2015-09-17T16:31:06.800Z","releaseDate":"2015-09-17T16:31:06.800Z","categories":["55faeacbd0e22017005b8269","55faf550764f50210095078e","55faf5b5626c341700fd9e96","55faf8a7825d5f19001fa386","560052f91503430d007cc88f","560054f73aa0520d00da0b1a","56005aaf6932a00d00ba7c62","56005c273aa0520d00da0b3f","5601ae7681a9670d006d164d","5601ae926811d00d00ceb487","5601aeb064866b1900f4768d","5601aee850ee460d0002224c","5601afa02499c119000faf19","5601afd381a9670d006d1652","561d4c78281aec0d00eb27b6","561d588d8ca8b90d00210219","563a5f934cc3621900ac278c","5665c5763889610d0008a29e","566710a36819320d000c2e93","56ddf6df8a5ae10e008e3926","56e1c96b2506700e00de6e83","56e1ccc4e416450e00b9e48c","56e1ccdfe63f910e00e59870","56e1cd10bc46be0e002af26a","56e1cd21e416450e00b9e48e","56e3139a51857d0e008e77be","573b4f62ef164e2900a2b881","57c9d1335fd8ca0e006308ed","57e2bd9d1e7b7220000d7fa5","57f2b992ac30911900c7c2b6","58adb5c275df0f1b001ed59b","58c81b5c6dc7140f003c3c46","595412446ed4d9001b3e7b37","59e76ce41938310028037295","5a009de510890d001c2aabfe"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"editedParams":true,"parentDoc":null,"project":"55faeacad0e22017005b8265","__v":1,"category":{"_id":"56e1ccdfe63f910e00e59870","version":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":5,"pages":["56e311b0cb6ef20e0084f24b","56e312096e602e0e00700b2d","56e312bcd46bc30e007bb99a","56e31309cb6ef20e0084f250","56e31357cb6ef20e0084f254"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-10T19:37:03.043Z","from_sync":false,"order":18,"slug":"write-ingest-vector-services-guide","title":"Write & Ingest Vector Services Guide"},"user":"562654b6f3adc80d0048611b","editedParams2":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-11T18:49:59.318Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"Request:\n  DELETE /insight-vector/api/vector/:index/:id\n\nHeaders:\n  Authorization: Bearer {token}\n  Content-Type: application/json\n\n\nResponse (success):\n  200 OK","language":"text"},{"code":"https://vector.geobigdata.io/insight-vector/api/vector/vector-web-s/ebe3e7f5-da6d-4d87-937e-4f1be8e5861d","language":"http"}]},"method":"delete","results":{"codes":[{"name":"","code":"","language":"json","status":204}]},"settings":"56e2c496d64add20007dceba","auth":"required","params":[{"_id":"56e31357cb6ef20e0084f256","ref":"","in":"path","required":true,"desc":"The index to which items will be written/are stored. The index is generated during the POST call. Note: All indicies generated through the API will be of the format vector-web-{geohash}.","default":"vector-web-s","type":"string","name":"index"},{"_id":"56e31357cb6ef20e0084f255","ref":"","in":"path","required":true,"desc":"The ID of the item","default":"ebe3e7f5-da6d-4d87-937e-4f1be8e5861d","type":"string","name":"id"}],"url":"/insight-vector/api/vector/:index/:id"},"isReference":false,"order":8,"body":"Note: Only the creator of the vector is able to delete the vector through the API.","excerpt":"The Delete Vector API is used to remove an item from the specified vector index by ID.","slug":"deleting-a-vector-via-item-id","type":"endpoint","title":"Deleting a Vector via item ID"}

deleteDeleting a Vector via item ID

The Delete Vector API is used to remove an item from the specified vector index by ID.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

index:
required
stringvector-web-s
The index to which items will be written/are stored. The index is generated during the POST call. Note: All indicies generated through the API will be of the format vector-web-{geohash}.
id:
required
stringebe3e7f5-da6d-4d87-937e-4f1be8e5861d
The ID of the item

Examples


Documentation

Note: Only the creator of the vector is able to delete the vector through the API.

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}