{"__v":1,"_id":"556b055230922f1700ad5d21","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-31T11:09:39.688Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"Launch an on-demand grid","language":"shell","code":"curl -u ${API_TOKEN}: -X POST https://api.flood.io/grids \\\n\t-F \"grid[region]=ap-southeast-2\" \\\n  -F \"grid[infrastructure]=demand\" \\\n  -F \"grid[instance_quantity]=2\" \\\n  -F \"grid[stop_after]=60\" \\\n  -F \"grid[instance_type]=m4.xlarge\"\n"},{"code":"curl -u abc123: -X POST https://api.flood.io/grids \\\n\t-F \"grid[region]=ap-southeast-2\" \\\n  -F \"grid[infrastructure]=hosted\" \\\n  -F \"grid[aws_platform]=ec2_default_vpc\" \\\n  -F \"grid[instance_quantity]=1\" \\\n  -F \"grid[stop_after]=60\" \\\n  -F \"grid[instance_type]=m4.xlarge\" \\\n  -F \"grid[credential_id]=1\"","language":"shell","name":"Launch a hosted grid"},{"code":"curl -u abc123: -X POST https://api.flood.io/grids \\\n\t-F \"grid[region]=ap-southeast-2\" \\\n  -F \"grid[infrastructure]=hosted\" \\\n  -F \"grid[aws_platform]=ec2_default_vpc\" \\\n  -F \"grid[instance_quantity]=1\" \\\n  -F \"grid[stop_after]=60\" \\\n  -F \"grid[instance_type]=m4.xlarge\" \\\n  -F \"grid[credential_id]=1\" \\\n  -F \"grid[dry_run]=true\"","language":"shell","name":"Queue a hosted grid"}]},"method":"post","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"_links\": {\n    \"self\": {\n      \"href\": \"/api/grids/ypg1ZVWjsCiSN8mOfCdybw\"\n    }\n  },\n  \"uuid\": \"ypg1ZVWjsCiSN8mOfCdybw\",\n  \"name\": \"screeching-cavern-production-ypg1ZVWjsCiSN8mOfCdybw\",\n  \"region\": \"ap-southeast-2\",\n  \"origin\": \"Australia (Sydney)\",\n  \"instance_quantity\": 2,\n  \"instance_type\": \"m4.xlarge\",\n  \"infrastructure\": \"demand\",\n  \"stop_after\": 60,\n  \"status\": \"queued\",\n  \"nodes\": []\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"55681be3952dca0d0019c525","ref":"","in":"body","required":true,"desc":"target region to start the grid in, any value from `ap-southeast-2`, `us-east-1`, `us-west-1`, `us-west-2`, `eu-west-1`, `eu-central-1`, `ap-southeast-1`, `ap-northeast-1`, `sa-east-1`.","default":"","type":"string","name":"grid[region]"},{"_id":"556819ce952dca0d0019c51b","ref":"","in":"body","required":true,"desc":"On Demand `demand` or Host Your Own `hosted`","default":"demand","type":"string","name":"grid[infrastracture]"},{"_id":"57c4e9b0ddb1f00e00dadc85","ref":"","in":"body","required":false,"desc":"aws platform to use ec2_default_vpc, ec2_classic","default":"","type":"string","name":"grid[aws_platform]"},{"_id":"556af2789d4bb723007ca9df","ref":"","in":"body","required":true,"desc":"required for `hosted` grids","default":"","type":"string","name":"grid[credential_id]"},{"_id":"556af2789d4bb723007ca9de","ref":"","in":"body","required":true,"desc":"number of grid nodes to launch","default":"","type":"int","name":"grid[instance_quantity]"},{"_id":"556af2789d4bb723007ca9dd","ref":"","in":"body","required":true,"desc":"`m3.xlarge` or `m3.2xlarge`. Note: 10% surcharge for the larger type.","default":"","type":"string","name":"grid[instance_type]"},{"_id":"556af2a930922f1700ad5cef","ref":"","in":"body","required":true,"desc":"stop after `n` minutes. `0` minutes to run forever","default":"","type":"int","name":"grid[stop_after]"},{"_id":"556af2a930922f1700ad5cee","ref":"","in":"body","required":false,"desc":"optional spot price for instances in decimal cents e.g. `0.48`","default":"","type":"double","name":"grid[aws_spot_price]"},{"_id":"556af303ab693b1900ce16c6","ref":"","in":"body","required":false,"desc":"optional tags e.g. `key1=value, key2=value`","default":"","type":"string","name":"grid[aws_tags]"},{"_id":"556af303ab693b1900ce16c5","ref":"","in":"body","required":false,"desc":"optional availability zone within a region e.g. `us-east-1a`","default":"","type":"string","name":"grid[aws_availability_zone]"},{"_id":"556af303ab693b1900ce16c4","ref":"","in":"body","required":false,"desc":"optional VPC ID e.g. `vpc-4991ab20`","default":"","type":"string","name":"grid[aws_vpc_identifier]"},{"_id":"556af303ab693b1900ce16c3","ref":"","in":"body","required":false,"desc":"optional public subnet e.g. `subnet-4991ab21`","default":"","type":"string","name":"grid[aws_vpc_subnet_public]"},{"_id":"556af303ab693b1900ce16c2","ref":"","in":"body","required":false,"desc":"optional private subnet e.g. `subnet-4991ab22`","default":"","type":"string","name":"grid[aws_vpc_subnet_private]"},{"_id":"556af303ab693b1900ce16c1","ref":"","in":"body","required":false,"desc":"optional security groups e.g. `sg-11692834`","default":"","type":"string","name":"grid[aws_vpc_security_groups]"}],"url":"/grids"},"isReference":false,"order":10,"body":"Creates a new grid. This may be a long-running request.","excerpt":"Creates a new grid and returns its details","slug":"api-grids-create","type":"endpoint","title":"/grids"}

post/grids

Creates a new grid and returns its details

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

grid[region]:
required
string
target region to start the grid in, any value from `ap-southeast-2`, `us-east-1`, `us-west-1`, `us-west-2`, `eu-west-1`, `eu-central-1`, `ap-southeast-1`, `ap-northeast-1`, `sa-east-1`.
grid[infrastracture]:
required
stringdemand
On Demand `demand` or Host Your Own `hosted`
grid[aws_platform]:
string
aws platform to use ec2_default_vpc, ec2_classic
grid[credential_id]:
required
string
required for `hosted` grids
grid[instance_quantity]:
required
integer
number of grid nodes to launch
grid[instance_type]:
required
string
`m3.xlarge` or `m3.2xlarge`. Note: 10% surcharge for the larger type.
grid[stop_after]:
required
integer
stop after `n` minutes. `0` minutes to run forever
grid[aws_spot_price]:
double
optional spot price for instances in decimal cents e.g. `0.48`
grid[aws_tags]:
string
optional tags e.g. `key1=value, key2=value`
grid[aws_availability_zone]:
string
optional availability zone within a region e.g. `us-east-1a`
grid[aws_vpc_identifier]:
string
optional VPC ID e.g. `vpc-4991ab20`
grid[aws_vpc_subnet_public]:
string
optional public subnet e.g. `subnet-4991ab21`
grid[aws_vpc_subnet_private]:
string
optional private subnet e.g. `subnet-4991ab22`
grid[aws_vpc_security_groups]:
string
optional security groups e.g. `sg-11692834`

Examples


Result Format


Documentation

Creates a new grid. This may be a long-running request.

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