Skip to main content
PATCH
/
environments
/
{id}
Update environment
curl --request PATCH \
  --url https://api.verial.ai/environments/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
{
  "id": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.verial.ai/llms.txt

Use this file to discover all available pages before exploring further.

Update an environment’s name, description, or simulator configuration.

Authorizations

​
Authorization
string
header
required

API key passed as a Bearer token.

Path Parameters

​
id
string
required

Environment ID

Body

application/json
​
name
string
Required string length: 1 - 200
​
description
string | null
Maximum string length: 1000

Response

Successful response

​
id
string<date-time>
required
​
name
string
required
​
description
string | null
required
​
created_at
string<date-time>
required