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 role API

The role API from SigNoz — 3 operation(s) for role.

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

Tagged areas include Role. 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 7 operations across 3 paths, and defines 10 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}.

7 operations 3 paths 10 schemas 1 DELETE3 GET2 PATCH1 POST

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 role 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 7

Across 3 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 2 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

role 7
GET
/api/v1/roles
List roles
ListRoles → 200401403500
POST
/api/v1/roles
Create role
CreateRole body → 201400401403409451500501
DELETE
/api/v1/roles/{id}
Delete role
DeleteRole 1 param → 204401403404451500501
GET
/api/v1/roles/{id}
Get role
GetRole 1 param → 200401403500
PATCH
/api/v1/roles/{id}
Patch role
PatchRole 1 param body → 204401403404451500501
GET
/api/v1/roles/{id}/relations/{relation}/objects
Get objects for a role by relation
GetObjects 2 params → 200401403404451500501
PATCH
/api/v1/roles/{id}/relations/{relation}/objects
Patch objects for a role by relation
PatchObjects 2 params body → 204400401403404451500501

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are AuthtypesRole (7 properties), ErrorsJSON (4 properties), AuthtypesPostableRole (2 properties), AuthtypesResource (2 properties). Each schema is shown below with its type and property counts.

RenderErrorResponse
object
2 properties 2 required
AuthtypesPatchableObjects
object
2 properties 2 required
ErrorsResponseerroradditional
object
1 property
TypesIdentifiable
object
1 property 1 required
ErrorsJSON
object
4 properties 2 required
AuthtypesGettableObjects
object
2 properties 2 required
AuthtypesPatchableRole
object
1 property 1 required
AuthtypesResource
object
2 properties 2 required
AuthtypesPostableRole
object
2 properties 1 required
AuthtypesRole
object
7 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

signoz-role-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 role 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.