How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SigNoz preferences API

The preferences API from SigNoz — 4 operation(s) for preferences.

SigNoz preferences API is one of 29 APIs that SigNoz publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Preferences. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a GitHub repository, pricing, and a getting-started guide.

This API exposes 6 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://{host}:{port}{base_path}.

6 operations 4 paths 6 schemas 4 GET2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://{host}:{port}
Authentication
API Key, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 2

SigNoz preferences API declares 2 security schemes for authenticating requests. An API key is passed in the header as SigNoz-Api-Key (api_key). It accepts HTTP bearer tokens (Tokenizer) (tokenizer).

  • api_key — API Keys
  • tokenizer — Tokens generated by the tokenizer

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 4 GET, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

preferences 6
GET
/api/v1/org/preferences
List org preferences
ListOrgPreferences → 200401403500
GET
/api/v1/org/preferences/{name}
Get org preference
GetOrgPreference 1 param → 200400401403404500
PUT
/api/v1/org/preferences/{name}
Update org preference
UpdateOrgPreference 1 param body → 204400401403404500
GET
/api/v1/user/preferences
List user preferences
ListUserPreferences → 200401403500
GET
/api/v1/user/preferences/{name}
Get user preference
GetUserPreference 1 param → 200401403404500
PUT
/api/v1/user/preferences/{name}
Update user preference
UpdateUserPreference 1 param body → 204400401403404500

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are PreferencetypesPreference (7 properties), ErrorsJSON (4 properties), RenderErrorResponse (2 properties), PreferencetypesUpdatablePreference (1 property). Each schema is shown below with its type and property counts.

PreferencetypesPreference
object
7 properties
RenderErrorResponse
object
2 properties 2 required
ErrorsResponseerroradditional
object
1 property
ErrorsJSON
object
4 properties 2 required
PreferencetypesValue
object
PreferencetypesUpdatablePreference
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

signoz-preferences-api-openapi.yml Raw ↑

Other APIs SigNoz publishes across the network.

SigNoz alerts API
SigNoz authdomains API
SigNoz authz API
SigNoz channels API
SigNoz cloudintegration API
SigNoz dashboard API
SigNoz downtimeschedules API
SigNoz features API
SigNoz fields API
SigNoz gateway API
SigNoz global API
SigNoz health API
Where this information came from

This is an independent, third-party profile of SigNoz preferences API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.