Create a logging environment

POST

/api/logging/environments

curl --request POST \
  --url https://gateway.example.com/api/logging/environments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "enabled": true, "schemaId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "schemaMode": "loose", "retentionDays": 30, "rateLimitRequestsPerWindow": 1, "rateLimitEventsPerWindow": 1, "fieldSchema": [] }'

• Your Gateway instance

Authorizations

• bearerAuth

Request Body^required

JSON request body

Media typeapplication/json

object

name

required

string

>= 1 characters <= 255 characters

description

string | null

<= 10000 characters

enabled

boolean

default: true

schemaId

string | null format: uuid

schemaMode

string

default: reject

Allowed values: loose strip reject

retentionDays

integer

default: 30 >= 1 <= 365

rateLimitRequestsPerWindow

integer | null

> 0

rateLimitEventsPerWindow

integer | null

> 0

fieldSchema

Array<object>

default: <= 128 items

object

key

required

string

>= 1 characters <= 100 characters /^[A-Za-z_][A-Za-z0-9_.-]*$/

location

required

string

Allowed values: label field

type

required

string

Allowed values: string number boolean datetime json

required

boolean

description

string

<= 1000 characters

Responses

201

Created

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",
    "environmentId": "production",
    "timestamp": "2024-01-01T12:00:00.000Z",
    "message": "Request completed",
    "level": "info"
  }
}

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

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

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

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

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

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

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"
}