Sign in

v1

latestOpenAPI 3.1.02026-07-26157321426.3 KB

Creates a chain environment

Creates a chain environment. Returns the resulting environment.

post/v1/chains/{chain_id}/environments

Request body

namestring required

Name of the environment

Example request

{
  "name": "staging",
  "promotion_settings": {
    "redeploy_on_promotion": true,
    "rolling_deploy": true,
    "rolling_deploy_config": {
      "max_surge_percent": 25,
      "max_unavailable_percent": 10,
      "stabilization_time_seconds": 300
    },
    "ramp_up_while_promoting": true,
    "ramp_up_duration_seconds": 600
  },
  "chainlet_settings": [
    {
      "autoscaling_settings": {
        "autoscaling_window": 800,
        "concurrency_target": 4,
        "max_replica": 3,
        "max_scale_down_rate": null,
        "min_replica": 2,
        "scale_down_delay": 63,
        "target_in_flight_tokens": null,
        "target_utilization_percentage": null
      },
      "chainlet_name": "HelloWorld",
      "instance_type_id": "2x8"
    },
    {
      "autoscaling_settings": {
        "autoscaling_window": null,
        "concurrency_target": null,
        "max_replica": 3,
        "max_scale_down_rate": null,
        "min_replica": 3,
        "scale_down_delay": null,
        "target_in_flight_tokens": null,
        "target_utilization_percentage": null
      },
      "chainlet_name": "RandInt",
      "instance_type_id": "A10Gx8x32"
    }
  ]
}

Response

namestring required

Name of the environment

created_atstring date-time required

Time the environment was created in ISO 8601 format

chain_idstring required

Unique identifier of the chain

Example response

{
  "promotion_settings": {
    "redeploy_on_promotion": true,
    "rolling_deploy": true,
    "rolling_deploy_config": {
      "max_surge_percent": 25,
      "max_unavailable_percent": 10,
      "stabilization_time_seconds": 300
    },
    "ramp_up_while_promoting": true,
    "ramp_up_duration_seconds": 600
  }
}