{"__v":0,"_id":"556b055230922f1700ad5d24","category":{"__v":2,"_id":"556b055230922f1700ad5cfe","pages":["556b055230922f1700ad5d19","556b055230922f1700ad5d1a","556b055230922f1700ad5d1b","556b055230922f1700ad5d1c","556b055230922f1700ad5d1d","556b055230922f1700ad5d1e","556b055230922f1700ad5d1f","556b055230922f1700ad5d20","556b055230922f1700ad5d21","556b055230922f1700ad5d22","556b055230922f1700ad5d23","556b055230922f1700ad5d24","556b055230922f1700ad5d25","556b055230922f1700ad5d26","556bc25f61c7f40d001ce059"],"project":"5563e51e2207bd2100a3d7fd","version":"556b055130922f1700ad5cfd","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-05-26T04:27:33.949Z","from_sync":false,"order":2,"slug":"api","title":"Flood API"},"editedParams":true,"editedParams2":true,"parentDoc":null,"project":"5563e51e2207bd2100a3d7fd","user":"5563e5474e990b2100d425d1","version":{"__v":3,"_id":"556b055130922f1700ad5cfd","forked_from":"5563e51e2207bd2100a3d800","project":"5563e51e2207bd2100a3d7fd","createdAt":"2015-05-31T12:57:53.432Z","releaseDate":"2015-05-31T12:57:53.432Z","categories":["556b055230922f1700ad5cfe","556b055230922f1700ad5cff","556b055230922f1700ad5d00","556b055230922f1700ad5d01","556b055230922f1700ad5d02","556b055230922f1700ad5d03","556b07e9ab693b1900ce16d0","56fe562d3eaf300e00f7421c"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-05-31T12:41:54.175Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl -u ${API_TOKEN}: -X DELETE https://api.flood.io/grids/WBBgkooONAx4VHQzLNFvQw\n```","language":"shell"}]},"method":"delete","results":{"codes":[{"name":"JSON format","code":"{\n  \"_links\": {\n    \"self\": {\n      \"href\": \"/api/grids/xSEREOvLBX0d8Xp2C8WI5g\"\n    }\n  },\n  \"uuid\": \"xSEREOvLBX0d8Xp2C8WI5g\",\n  \"name\": \"withered-cove-production-xSEREOvLBX0d8Xp2C8WI5g\",\n  \"region\": \"ap-southeast-2\",\n  \"origin\": \"Australia (Sydney)\",\n  \"instance_quantity\": 1,\n  \"instance_type\": \"m3.xlarge\",\n  \"infrastructure\": \"demand\",\n  \"stop_after\": 60,\n  \"status\": \"stopped\",\n  \"resources\": [\n    {\n      \"ip\": \"54.66.199.235\",\n      \"private_ip\": \"172.31.30.92\",\n      \"instance_id\": \"i-c38d4d0d\",\n      \"chef\": \"complete\",\n      \"port\": 80,\n      \"started\": \"2015-02-16T02:44:45.000Z\",\n      \"state\": \"stopping\"\n    }\n  ]\n}","language":"json","status":200},{"code":"Timestamp,Value,Metric,Label\n1375858500000,0.84,apdex\n1375858560000,1.0,apdex\n1375858620000,1.0,apdex\n1375858500000,1392,response_time\n1375858560000,748,response_time\n1375858620000,923,response_time\n1375858500000,0,latency\n1375858560000,2,latency\n1375858620000,9,latency\n1375858500000,503207,throughput\n1375858560000,1549389,throughput\n1375858620000,181856,throughput\n1375858500000,207478,passed\n1375858560000,199485,passed\n1375858620000,30379,passed\n1375858500000,4148,failed\n1375858560000,32658,failed","language":"text","status":200,"name":"CSV format"}]},"settings":"","auth":"required","params":[{"_id":"5568205a952dca0d0019c52f","ref":"","in":"body","required":true,"desc":"UUID of flood test","default":"","type":"string","name":"flood_id"}],"url":"/grids/:grid_id"},"isReference":false,"order":13,"body":"Stops a flood test and returns its status. This may be a long-running request.","excerpt":"Stop a grid","slug":"api-grids-stop","type":"endpoint","title":"/grid/:grid_id"}

delete/grid/:grid_id

Stop a grid

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

flood_id:
required
string
UUID of flood test

Examples


Result Format


Documentation

Stops a flood test and returns its status. This may be a long-running request.

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 }}