FruxonDocs
ApiEnvironments

Update an environment

Updates an environment's enrichable metadata — display name, description, and logo. The slug is immutable and cannot be changed. Partial update: fields omitted (null) are left unchanged; send an empty string to clear a value.

PUT
/v1/tenants/{tenant}/environments/{environment}

Authorization

Bearer
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

environment*string

The environment identifier

tenant*string

The tenant identifier

Request Body

The fields to apply

displayName?string|null

Human-readable name for the environment (e.g., "Acme Corp Production"). Nullable so the partial-update payload can leave it untouched.

Lengthlength <= 256
description?string|null

Free-text description providing additional context about the environment. Nullable so the partial-update payload can leave it untouched.

Lengthlength <= 2048
logoFileId?string|null

Identifier of an uploaded file used as the environment's logo. Nullable so the partial-update payload can leave it untouched.

Lengthlength <= 512
[key: string]?never

Response Body

curl -X PUT "https://api.fruxon.com/v1/tenants/string/environments/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "00000000-0000-0000-0000-000000000000",
  "slug": "string",
  "displayName": "string",
  "description": "string",
  "logoFileId": "string",
  "createdAt": 0,
  "modifiedAt": 0
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}