Environments

Partially update environment

Changed on

Partially update an environment object. Specify the fields to update in the payload.

patch/environment/{environment_id}

Request

  • Base URL
    https://api.braintrust.dev
  • Auth
    • HTTP bearer
    • or none

Path parameters

environment_idstring uuid required

Request body

namestring nullable

Name of the environment

slugstring nullable

A url-friendly, unique identifier for the environment within an organization

descriptionstring nullable

Textual description of the environment

Response

Updated environment

idstring uuid required

Unique identifier for the environment

org_idstring uuid required

Unique identifier for the organization that the environment belongs under

namestring required

Name of the environment

slugstring required

A url-friendly, unique identifier for the environment within an organization

descriptionstring nullable

Textual description of the environment

createdstring date-time nullable

Date of environment creation

deleted_atstring date-time nullable

Date of environment deletion, or null if the environment is still active

Changes