{"__v":0,"_id":"556b055230922f1700ad5d1b","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-29T07:46:55.512Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl -u ${API_TOKEN}: -X POST https://api.flood.io/floods \\\n\t-F \"flood[tool]=jmeter\" \\\n \t-F \"flood[threads]=10\" \\\n \t-F \"flood[privacy]=public\" \\\n \t-F \"flood[name]=MyTest\" \\\n \t-F \"flood[tag_list]=ci,shakeout\" \\\n \t-F \"flood_files[]=:::at:::jmeter-with-plugins.jmx\" \\\n \t-F \"flood[grids][][infrastructure]=demand\" \\\n \t-F \"flood[grids][][instance_quantity]=1\" \\\n \t-F \"flood[grids][][region]=us-west-2\" \\\n \t-F \"flood[grids][][instance_type]=m4.xlarge\" \\\n \t-F \"flood[grids][][stop_after]=60\"","language":"shell","name":"Launch flood on a new grid"},{"name":"Launch flood on existing grid","language":"shell","code":"curl -u ${API_TOKEN}: -X POST https://api.flood.io/floods \\\n\t-F \"flood[tool]=jmeter\" \\\n  -F \"flood[threads]=50\" \\\n  -F \"flood_files[]=@/path/to/testplan.jmx\" \\\n  -F \"flood_files[]=@/path/to/testdata.csv\" \\\n  -F \"flood[grids][][uuid]=qpjrj4MnKmR3VgxOLtuMww\"\n"}]},"method":"post","results":{"codes":[{"name":"","code":"{\n  \"_links\": {\n    \"self\": {\n      \"href\": \"/api/floods/VCFstUfl0AMdtaKYBo5d7A\"\n    }\n  },\n  \"uuid\": \"VCFstUfl0AMdtaKYBo5d7A\",\n  \"batch_id\": \"1VVGD5LBVvuatWEJ9SB8aA\",\n  \"apdex\": null,\n  \"tool\": \"jmeter\",\n  \"name\": \"MyTest\",\n  \"notes\": null,\n  \"threads\": 10,\n  \"rampup\": null,\n  \"duration\": null,\n  \"tag_list\": [\n    \"ci\",\n    \"shakeout\"\n  ],\n  \"status\": \"queued\",\n  \"permalink\": \"https://flood.io/VCFstUfl0AMdtaKYBo5d7A\",\n  \"remote_errors\": null,\n  \"started\": null,\n  \"stopped\": null,\n  \"_embedded\": {\n    \"grids\": [\n      {\n        \"_links\": {\n          \"self\": {\n            \"href\": \"/api/grids/hg8ZjZcifgsuQvDfcnBONw\"\n          }\n        },\n        \"uuid\": \"hg8ZjZcifgsuQvDfcnBONw\",\n        \"batch_id\": \"1VVGD5LBVvuatWEJ9SB8aA\",\n        \"name\": \"jubilant-peak-production-hg8ZjZcifgsuQvDfcnBONw\",\n        \"region\": \"us-west-2\",\n        \"origin\": \"US West (Oregon)\",\n        \"instance_quantity\": 1,\n        \"instance_type\": \"m4.xlarge\",\n        \"infrastructure\": \"demand\",\n        \"stop_after\": 60,\n        \"status\": \"starting\",\n        \"nodes\": []\n      }\n    ],\n    \"files\": [\n      {\n        \"name\": \"lRFFUcXvSIp7pHftfnC7x8\",\n        \"href\": \"...\"\n      }\n    ],\n    \"archives\": []\n  }\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"55681be3952dca0d0019c525","ref":"","in":"body","required":true,"desc":"type of tool to use, jmeter, gatling, java-selenium-chrome or java-selenium-firefox","default":"","type":"string","name":"flood[tool]"},{"_id":"556819ce952dca0d0019c51b","ref":"","in":"body","required":true,"desc":"test plan to use, as a multipart upload","default":"","type":"file","name":"flood_files[]"},{"_id":"55681d036976ef0d0099c6c4","ref":"","in":"body","required":false,"desc":"name of the flood test","default":"","type":"string","name":"flood[name]"},{"_id":"55681d036976ef0d0099c6c3","ref":"","in":"body","required":false,"desc":"notes or description of the flood test","default":"","type":"string","name":"flood[notes]"},{"_id":"55681d036976ef0d0099c6c2","ref":"","in":"body","required":false,"desc":"comma separated tags associated with the flood test","default":"","type":"string","name":"flood[tag_list]"},{"_id":"55681e0e4f23660d008855a2","ref":"","in":"body","required":false,"desc":"public or private","default":"private","type":"string","name":"flood[privacy_flag]"},{"_id":"55681d036976ef0d0099c6c1","ref":"","in":"body","required":false,"desc":"number of threads to pass in to test plan","default":"","type":"int","name":"flood[threads]"},{"_id":"55681d036976ef0d0099c6c0","ref":"","in":"body","required":false,"desc":"number of seconds rampup to pass in to test plan","default":"","type":"int","name":"flood[rampup]"},{"_id":"55681d036976ef0d0099c6bf","ref":"","in":"body","required":false,"desc":"number of seconds duration to pass in to test plan","default":"","type":"int","name":"flood[duration]"},{"_id":"55681d036976ef0d0099c6be","ref":"","in":"body","required":false,"desc":"override DNS hostname resolution","default":"example.com/0.0.0.0, ...","type":"string","name":"flood[override_hosts]"},{"_id":"55681d036976ef0d0099c6bd","ref":"","in":"body","required":false,"desc":"override parameters","default":"-Dparam=value, -Jparam=value, ...","type":"string","name":"flood[override_parameters]"},{"_id":"55681d904f23660d008855a1","ref":"","in":"body","required":false,"desc":"array of grid objects to distribute flood to","default":"","type":"array_mixed","name":"flood[grids]"}],"url":"/floods"},"isReference":false,"order":3,"body":"Creates a new flood test and returns its details. This may be a long-running request.\n\nNote to windows users when using curl be sure to prepend the `flood_files[]` value with an `@` symbol if using curl. This indicates to curl the rest should be a file name to read the data from e.g. `-F \"flood_files[]=@C:/Users/tim/mytest.jmx\"`","excerpt":"Creates a new flood test and returns its details","slug":"api-create-floods","type":"endpoint","title":"/floods"}

post/floods

Creates a new flood test and returns its details

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

flood[tool]:
required
string
type of tool to use, jmeter, gatling, java-selenium-chrome or java-selenium-firefox
flood_files:
required
file
test plan to use, as a multipart upload
flood[name]:
string
name of the flood test
flood[notes]:
string
notes or description of the flood test
flood[tag_list]:
string
comma separated tags associated with the flood test
flood[privacy_flag]:
stringprivate
public or private
flood[threads]:
integer
number of threads to pass in to test plan
flood[rampup]:
integer
number of seconds rampup to pass in to test plan
flood[duration]:
integer
number of seconds duration to pass in to test plan
flood[override_hosts]:
stringexample.com/0.0.0.0, ...
override DNS hostname resolution
flood[override_parameters]:
string-Dparam=value, -Jparam=value, ...
override parameters
flood[grids]:
array of mixed
array of grid objects to distribute flood to

Examples


Result Format


Documentation

Creates a new flood test and returns its details. This may be a long-running request. Note to windows users when using curl be sure to prepend the `flood_files[]` value with an `@` symbol if using curl. This indicates to curl the rest should be a file name to read the data from e.g. `-F "flood_files[]=@C:/Users/tim/mytest.jmx"`

User Information

Try It Out

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