Skip to content
Olivares AI docs

Read saved and effective tracing settings (superadmin)

GET
/v1/system/tracing
 
curl --request GET \
  --url https://example.com/v1/system/tracing \
  --header 'Authorization: Bearer <token>'

Reads saved tracing choices, the running node’s effective configuration and the names of environment overrides. Requires system administration. Override credential values are never returned.

Authorizations

Section titled “ Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

OK

Media type application/json
object
effective
required
object
enabled
required
boolean
endpoint
required

Collector host or HTTP(S) URL without credentials, query or fragment.

string
<= 4096 characters
genai_compat
required
boolean
insecure
required
boolean
protocol
required
string
Allowed values: grpc http/protobuf
sample_ratio
required
number
<= 1
service_name
required
string
>= 1 characters <= 256 characters
overrides
required

Names of environment overrides; never their credential values.

Array<string>
settings
required
object
enabled
required
boolean
endpoint
required

Collector host or HTTP(S) URL without credentials, query or fragment.

string
<= 4096 characters
genai_compat
required
boolean
insecure
required
boolean
protocol
required
string
Allowed values: grpc http/protobuf
sample_ratio
required
number
<= 1
service_name
required
string
>= 1 characters <= 256 characters
Example 
{
  "effective": {
    "protocol": "grpc"
  },
  "settings": {
    "protocol": "grpc"
  }
}

400

Section titled “ 400 ”

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

401

Section titled “ 401 ”

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

403

Section titled “ 403 ”

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

404

Section titled “ 404 ”

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

409

Section titled “ 409 ”

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

429

Section titled “ 429 ”

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

503

Section titled “ 503 ”

Tracing settings or collector configuration unavailable

Media type application/json
object
error
required
object
code
required
string
message
required
string
module

With code module_not_enabled: the namespace of the module this node does not run.

string
Example generated 
{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}