Get Chain environment

Gets a chain environment’s details and returns the chain environment.

GET /v1/chains/{chain_id}/environments/{env_name}

cURL

cURL

curl --request GET \
--url https://api.baseten.co/v1/chains/{chain_id}/environments/{env_name} \
--header "Authorization: Bearer $BASETEN_API_KEY"

200

{
  "name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "chain_id": "<string>",
  "promotion_settings": {
    "redeploy_on_promotion": true,
    "rolling_deploy": true,
    "promotion_cleanup_strategy": "SCALE_TO_ZERO",
    "rolling_deploy_config": {
      "rolling_deploy_strategy": "REPLICA",
      "max_surge_percent": 10,
      "max_unavailable_percent": 0,
      "stabilization_time_seconds": 0,
      "replica_overhead_percent": 0
    },
    "ramp_up_while_promoting": true,
    "ramp_up_duration_seconds": 600
  },
  "chainlet_settings": [
    {
      "chainlet_name": "<string>",
      "autoscaling_settings": {
        "min_replica": 123,
        "max_replica": 123,
        "autoscaling_window": 123,
        "scale_down_delay": 123,
        "concurrency_target": 123,
        "target_utilization_percentage": 123,
        "target_in_flight_tokens": 123,
        "max_scale_down_rate": 123
      },
      "instance_type": {
        "id": "<string>",
        "name": "<string>",
        "memory_limit_mib": 123,
        "millicpu_limit": 123,
        "gpu_count": 123,
        "gpu_type": "<string>",
        "gpu_memory_limit_mib": 123
      }
    }
  ],
  "current_deployment": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "chain_id": "<string>",
    "environment": "<string>",
    "chainlets": [
      {
        "id": "<string>",
        "name": "<string>",
        "autoscaling_settings": {
          "min_replica": 123,
          "max_replica": 123,
          "autoscaling_window": 123,
          "scale_down_delay": 123,
          "concurrency_target": 123,
          "target_utilization_percentage": 123,
          "target_in_flight_tokens": 123,
          "max_scale_down_rate": 123
        },
        "instance_type_name": "<string>",
        "active_replica_count": 123
      }
    ]
  },
  "candidate_deployment": {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "chain_id": "<string>",
    "environment": "<string>",
    "chainlets": [
      {
        "id": "<string>",
        "name": "<string>",
        "autoscaling_settings": {
          "min_replica": 123,
          "max_replica": 123,
          "autoscaling_window": 123,
          "scale_down_delay": 123,
          "concurrency_target": 123,
          "target_utilization_percentage": 123,
          "target_in_flight_tokens": 123,
          "max_scale_down_rate": 123
        },
        "instance_type_name": "<string>",
        "active_replica_count": 123
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Send Authorization: Bearer <api_key>. The legacy Authorization: Api-Key <api_key> scheme is also accepted.

Path Parameters

chain_id · string · required

env_name · string · required

Response

200 - application/json

Environment for oracles.

name · string · required

Name of the environment

created_at · string<date-time> · required

Time the environment was created in ISO 8601 format

chain_id · string · required

Unique identifier of the chain

promotion_settings · PromotionSettingsV1 · object · required

Promotion settings for the environment

Show child attributes

chainlet_settings · ChainletEnvironmentSettingsV1 · object[] · required

Environment settings for the chainlets

Show child attributes

current_deployment · ChainDeploymentV1 · object | null · required

Current chain deployment of the environment

Show child attributes

candidate_deployment · ChainDeploymentV1 · object | null

Candidate chain deployment being promoted to the environment, if a promotion is in progress

Show child attributes