POST-grids
Definition
Creates a new grid. This may be a long-running request.
Parameters
Parameter | Required | Type | Description |
grid[region] | true | 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[instance_quantity] | true | integer | number of grid nodes to launch |
grid[stop_after] | true | integer | stop after n minutes, greater than 0, less than or equal to 2,880 (48 hours) |
grid[infrastructure] | true | string | On Demand |
grid[aws_platform] | false | string | aws platform to use |
grid[aws_tags] | false | string | optional tags e.g. |
grid[aws_availability_zone] | false | string | optional availability zone within a region e.g. |
grid[aws_spot_price] | false | double | optional spot price for instances in decimal cents e.g. 0.48 |
grid[credential_id] | false | string | required for |
grid[azure_tenant_id] | false | string | optional for Azure based |
grid[aws_arn] | false | string | optional for AWS based |
grid[aws_vpc_identifier] | false | string | optional VPC ID e.g. |
grid[aws_vpc_subnet_public] | false | string | optional public subnet e.g. |
grid[aws_vpc_subnet_private] | false | string | optional private subnet e.g. |
grid[aws_vpc_security_groups] | false | string | optional security groups e.g. |
grid[instance_type] | true | string | instance type e.g. |
Examples
Launch on demand grid
Launch hosted grid
Result Format
Last updated