Skip to content
OpfieldOpfieldOpfield

Update runtime environment settings

PATCH
/api/settings/environment
curl --request PATCH \
  --url https://gateway.example.com/api/settings/environment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "rateLimits": { "windowMs": 1, "maxRequests": 1, "authMaxRequests": 1, "authLoginMaxRequests": 1, "authCallbackMaxRequests": 1, "publicStatusMaxRequests": 1, "publicWebhookMaxRequests": 1, "pkiMaxRequests": 1, "streamMaxRequests": 1, "aiWebSocketMaxRequests": 1, "inferenceMaxRequests": 1 }, "loggingIngest": { "maxBodyBytes": 1, "maxBatchSize": 1, "maxMessageBytes": 1, "maxLabels": 1, "maxFields": 1, "maxKeyLength": 1, "maxValueBytes": 1, "maxJsonDepth": 1, "rateLimitWindowSeconds": 1, "globalRequestsPerWindow": 1, "globalEventsPerWindow": 1, "tokenRequestsPerWindow": 1, "tokenEventsPerWindow": 1 }, "requestLimits": { "requestBodyMaxBytes": 1, "oauthBodyMaxBytes": 1, "inferenceHttpBodyMaxBytes": 1, "inferenceWebSocketMaxPayloadBytes": 1, "inferenceMaxConcurrentRequestsPerToken": 1, "inferenceConcurrencyLeaseSeconds": 1 }, "sessions": { "expirySeconds": 1 }, "pkiDefaults": { "crlValidityHours": 1, "expiryWarningDays": 1, "expiryCriticalDays": 1 } }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”

JSON request body

Media typeapplication/json
object
rateLimits
object
windowMs
integer
>= 1000 <= 3600000
maxRequests
integer
>= 1 <= 1000000
authMaxRequests
integer
>= 1 <= 1000000
authLoginMaxRequests
integer
>= 1 <= 1000000
authCallbackMaxRequests
integer
>= 1 <= 1000000
publicStatusMaxRequests
integer
>= 1 <= 1000000
publicWebhookMaxRequests
integer
>= 1 <= 1000000
pkiMaxRequests
integer
>= 1 <= 1000000
streamMaxRequests
integer
>= 1 <= 1000000
aiWebSocketMaxRequests
integer
>= 1 <= 1000000
inferenceMaxRequests
integer
>= 1 <= 1000000
loggingIngest
object
maxBodyBytes
integer
>= 1024 <= 268435456
maxBatchSize
integer
>= 1 <= 10000
maxMessageBytes
integer
>= 256 <= 4194304
maxLabels
integer
>= 1 <= 1024
maxFields
integer
>= 1 <= 1024
maxKeyLength
integer
>= 1 <= 1024
maxValueBytes
integer
>= 256 <= 4194304
maxJsonDepth
integer
>= 1 <= 32
rateLimitWindowSeconds
integer
>= 1 <= 3600
globalRequestsPerWindow
integer
>= 1 <= 10000000
globalEventsPerWindow
integer
>= 1 <= 100000000
tokenRequestsPerWindow
integer
>= 1 <= 10000000
tokenEventsPerWindow
integer
>= 1 <= 100000000
requestLimits
object
requestBodyMaxBytes
integer
>= 65536 <= 33554432
oauthBodyMaxBytes
integer
>= 8192 <= 1048576
inferenceHttpBodyMaxBytes
integer
>= 1048576 <= 2147483648
inferenceWebSocketMaxPayloadBytes
integer
>= 1048576 <= 536870912
inferenceMaxConcurrentRequestsPerToken
integer
>= 1 <= 128
inferenceConcurrencyLeaseSeconds
integer
>= 30 <= 2400
sessions
object
expirySeconds
integer
>= 300 <= 31536000
pkiDefaults
object
crlValidityHours
integer
>= 1 <= 720
expiryWarningDays
integer
>= 1 <= 3650
expiryCriticalDays
integer
>= 1 <= 3650
Examplegenerated
{
  "rateLimits": {
    "windowMs": 1,
    "maxRequests": 1,
    "authMaxRequests": 1,
    "authLoginMaxRequests": 1,
    "authCallbackMaxRequests": 1,
    "publicStatusMaxRequests": 1,
    "publicWebhookMaxRequests": 1,
    "pkiMaxRequests": 1,
    "streamMaxRequests": 1,
    "aiWebSocketMaxRequests": 1,
    "inferenceMaxRequests": 1
  },
  "loggingIngest": {
    "maxBodyBytes": 1,
    "maxBatchSize": 1,
    "maxMessageBytes": 1,
    "maxLabels": 1,
    "maxFields": 1,
    "maxKeyLength": 1,
    "maxValueBytes": 1,
    "maxJsonDepth": 1,
    "rateLimitWindowSeconds": 1,
    "globalRequestsPerWindow": 1,
    "globalEventsPerWindow": 1,
    "tokenRequestsPerWindow": 1,
    "tokenEventsPerWindow": 1
  },
  "requestLimits": {
    "requestBodyMaxBytes": 1,
    "oauthBodyMaxBytes": 1,
    "inferenceHttpBodyMaxBytes": 1,
    "inferenceWebSocketMaxPayloadBytes": 1,
    "inferenceMaxConcurrentRequestsPerToken": 1,
    "inferenceConcurrencyLeaseSeconds": 1
  },
  "sessions": {
    "expirySeconds": 1
  },
  "pkiDefaults": {
    "crlValidityHours": 1,
    "expiryWarningDays": 1,
    "expiryCriticalDays": 1
  }
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful response

Media typeapplication/json
object
data
required

Resource object. Exact fields depend on the endpoint.

object
id
string
name
string
key
additional properties
Example
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Example resource",
    "createdAt": "2024-01-01T12:00:00.000Z",
    "updatedAt": "2024-01-01T12:30:00.000Z"
  }
}

400

Section titled “400”

Bad request

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "details": [
    {
      "path": [
        "name"
      ],
      "message": "Required"
    }
  ]
}

401

Section titled “401”

Authentication required

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
  "code": "UNAUTHORIZED",
  "message": "Authentication required"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
  "code": "FORBIDDEN",
  "message": "Insufficient permissions"
}

404

Section titled “404”

Not found

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
  "code": "NOT_FOUND",
  "message": "Resource not found"
}

409

Section titled “409”

Conflict

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
  "code": "CONFLICT",
  "message": "Resource already exists"
}

422

Section titled “422”

Unprocessable entity

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
  "code": "UNPROCESSABLE_ENTITY",
  "message": "Request could not be processed"
}

500

Section titled “500”

Internal server error

Media typeapplication/json
object
code
required

Error code

string
message
required

Human-readable error message

string
details

Additional error details

Example
{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error"
}