Create a new data plane

Creates a new data plane object. Persists the rendered data plane spec, and returns 202 with the data plane in status=requested. Requires BYOC enabled org and org admin. The cloud of the control plane selects the AWS, the Azure, or the GCP request. For AWS, the control plane uses the organization’s assigned external ID to assume the AWS role. Configure that ID in the role’s trust policy before creating a data plane. For Azure, the control plane uses the Entra tenant and the resource group in the request. For GCP, the control plane impersonates the provisioner service account in the request. That service account must be in the request’s project, and its description must be the organization’s assigned external ID.

POST /orgs/current/data-planes

Error

A valid request URL is required to generate request examples

202

{
  "api_url": "<string>",
  "created_at": "<string>",
  "firewall": {
    "allow_http": true,
    "allowed_cidrs": {},
    "allowed_domains": [
      "<string>"
    ]
  },
  "fleet_oidc": {
    "audience": "<string>",
    "email_claim": "<string>",
    "groups_claim": "<string>",
    "is_enabled": true,
    "issuer_url": "<string>",
    "provider": "<string>",
    "subject_claim": "<string>",
    "tenant_claim": "<string>",
    "tenant_mappings": {}
  },
  "id": "<string>",
  "maintenance_window": "<string>",
  "name": "<string>",
  "provisioning_settings": {
    "additional_tags": {},
    "azure_entra_tenant_id": "<string>",
    "byovpc": {
      "private_app_subnet_ids": [
        "<string>"
      ],
      "private_db_subnet_ids": [
        "<string>"
      ],
      "public_subnet_ids": [
        "<string>"
      ],
      "vpc_id": "<string>"
    },
    "cloud": "AWS",
    "gcp_project_id": "<string>",
    "is_byoiam_enabled": true,
    "is_eks_api_privatelink_disabled": true,
    "is_gcp_byoiam_enabled": true,
    "is_public_load_balancer": true,
    "provisioner_service_account": "<string>",
    "resource_group_id": "<string>",
    "role_arn": "<string>",
    "trace_storage": "CLICKHOUSE",
    "vpc_cidr": "<string>"
  },
  "region": "<string>",
  "status": "requested",
  "status_updated_at": "<string>",
  "ttl": {
    "enabled": true,
    "long_days": 123,
    "short_days": 123
  },
  "workspaces": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ]
}

Authorizations

API KeyOrganization IDBearer Auth

X-API-Key · string · header · required

Body

application/json

Option 1

Option 2

Option 3

name · string · required

region · string · required

role_arn · string · required

additional_tags · object[]

Maximum array length: 40

Show child attributes

byoiam_enabled · boolean

Use customer-managed IAM roles created by the LangSmith BYOIAM Terraform module.

byovpc · object

Show child attributes

eks_api_privatelink_disabled · boolean

Use a public EKS API endpoint restricted to LangSmith control-plane egress IPs instead of creating a managed PrivateLink endpoint service. Defaults to false.

public_load_balancer · boolean

trace_storage · enum<string>

TraceStorage selects the run and trace store. Defaults to CLICKHOUSE.

Available options: CLICKHOUSE, SMITHDB

vpc_cidr · string

VPCCIDR is used only when LangSmith creates the VPC.

Response

202

application/json

Data plane requested

api_url · string

created_at · string

firewall · object

Show child attributes

fleet_oidc · object

Show child attributes

id · string

maintenance_window · string

name · string

provisioning_settings · object

Show child attributes

region · string

status · enum<string>

Available options: requested, provisioning, provisioning_failed, active, updating, inactive, deprovisioning, deleted, revoked

status_updated_at · string

ttl · object

Show child attributes

workspaces · object[]

Show child attributes