SigNoz

opencollection: 1.0.0
info:
  name: SigNoz
items:
- info:
    name: alerts
    type: folder
  items:
  - info:
      name: Get alerts
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/alerts
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint returns alerts for the organization
- info:
    name: authz
    type: folder
  items:
  - info:
      name: Check permissions
      type: http
    http:
      method: POST
      url: https://{host}:{port}{base_path}/api/v1/authz/check
      body:
        type: json
        data: '{}'
    docs: Checks if the authenticated user has permissions for given transactions
  - info:
      name: Get resources
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/authz/resources
    docs: Gets all the available resources
- info:
    name: channels
    type: folder
  items:
  - info:
      name: List notification channels
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/channels
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint lists all notification channels for the organization
  - info:
      name: Create notification channel
      type: http
    http:
      method: POST
      url: https://{host}:{port}{base_path}/api/v1/channels
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint creates a notification channel
  - info:
      name: Get notification channel by ID
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/channels/:id
      params:
      - name: id
        value: ''
        type: path
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint returns a notification channel by ID
  - info:
      name: Update notification channel
      type: http
    http:
      method: PUT
      url: https://{host}:{port}{base_path}/api/v1/channels/:id
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint updates a notification channel by ID
  - info:
      name: Delete notification channel
      type: http
    http:
      method: DELETE
      url: https://{host}:{port}{base_path}/api/v1/channels/:id
      params:
      - name: id
        value: ''
        type: path
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint deletes a notification channel by ID
  - info:
      name: Test notification channel
      type: http
    http:
      method: POST
      url: https://{host}:{port}{base_path}/api/v1/channels/test
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint tests a notification channel by sending a test notification
  - info:
      name: Test notification channel (deprecated)
      type: http
    http:
      method: POST
      url: https://{host}:{port}{base_path}/api/v1/testChannel
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: 'Deprecated: use /api/v1/channels/test instead'
- info:
    name: cloudintegration
    type: folder
  items:
  - info:
      name: Agent check-in
      type: http
    http:
      method: POST
      url: https://{host}:{port}{base_path}/api/v1/cloud-integrations/:cloud_provider/agent-check-in
      params:
      - name: cloud_provider
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: '[Deprecated] This endpoint is called by the deployed agent to check in'
  - info:
      name: List accounts
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/cloud_integrations/:cloud_provider/accounts
      params:
      - name: cloud_provider
        value: ''
        type: path
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint lists the accounts for the specified cloud provider
  - info:
      name: Create account
      type: http
    http:
      method: POST
      url: https://{host}:{port}{base_path}/api/v1/cloud_integrations/:cloud_provider/accounts
      params:
      - name: cloud_provider
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint creates a new cloud integration account for the specified cloud provider
  - info:
      name: Get account
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/cloud_integrations/:cloud_provider/accounts/:id
      params:
      - name: cloud_provider
        value: ''
        type: path
      - name: id
        value: ''
        type: path
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint gets an account for the specified cloud provider
  - info:
      name: Update account
      type: http
    http:
      method: PUT
      url: https://{host}:{port}{base_path}/api/v1/cloud_integrations/:cloud_provider/accounts/:id
      params:
      - name: cloud_provider
        value: ''
        type: path
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint updates an account for the specified cloud provider
  - info:
      name: Disconnect account
      type: http
    http:
      method: DELETE
      url: https://{host}:{port}{base_path}/api/v1/cloud_integrations/:cloud_provider/accounts/:id
      params:
      - name: cloud_provider
        value: ''
        type: path
      - name: id
        value: ''
        type: path
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint disconnects an account for the specified cloud provider
  - info:
      name: Update service
      type: http
    http:
      method: PUT
      url: https://{host}:{port}{base_path}/api/v1/cloud_integrations/:cloud_provider/accounts/:id/services/:service_id
      params:
      - name: cloud_provider
        value: ''
        type: path
      - name: id
        value: ''
        type: path
      - name: service_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint updates a service for the specified cloud provider
  - info:
      name: Agent check-in
      type: http
    http:
      method: POST
      url: https://{host}:{port}{base_path}/api/v1/cloud_integrations/:cloud_provider/accounts/check_in
      params:
      - name: cloud_provider
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint is called by the deployed agent to check in
  - info:
      name: Get connection credentials
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/cloud_integrations/:cloud_provider/credentials
      params:
      - name: cloud_provider
        value: ''
        type: path
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint retrieves the connection credentials required for integration
  - info:
      name: List services metadata
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/cloud_integrations/:cloud_provider/services
      params:
      - name: cloud_integration_id
        value: ''
        type: query
      - name: cloud_provider
        value: ''
        type: path
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint lists the services metadata for the specified cloud provider
  - info:
      name: Get service
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/cloud_integrations/:cloud_provider/services/:service_id
      params:
      - name: cloud_integration_id
        value: ''
        type: query
      - name: cloud_provider
        value: ''
        type: path
      - name: service_id
        value: ''
        type: path
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint gets a service for the specified cloud provider
- info:
    name: sessions
    type: folder
  items:
  - info:
      name: Create session by google callback
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/complete/google
    docs: This endpoint creates a session for a user using google callback
  - info:
      name: Create session by oidc callback
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/complete/oidc
    docs: This endpoint creates a session for a user using oidc callback
  - info:
      name: Create session by saml callback
      type: http
    http:
      method: POST
      url: https://{host}:{port}{base_path}/api/v1/complete/saml
      params:
      - name: RelayState
        value: ''
        type: query
      - name: SAMLResponse
        value: ''
        type: query
      body:
        type: form-urlencoded
        data:
        - name: RelayState
          value: ''
        - name: SAMLResponse
          value: ''
    docs: This endpoint creates a session for a user using saml callback
  - info:
      name: Delete session
      type: http
    http:
      method: DELETE
      url: https://{host}:{port}{base_path}/api/v2/sessions
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: This endpoint deletes the session
  - info:
      name: Get session context
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v2/sessions/context
    docs: This endpoint returns the context for the session
  - info:
      name: Create session by email and password
      type: http
    http:
      method: POST
      url: https://{host}:{port}{base_path}/api/v2/sessions/email_password
      body:
        type: json
        data: '{}'
    docs: This endpoint creates a session for a user using email and password.
  - info:
      name: Rotate session
      type: http
    http:
      method: POST
      url: https://{host}:{port}{base_path}/api/v2/sessions/rotate
      body:
        type: json
        data: '{}'
    docs: This endpoint rotates the session
- info:
    name: dashboard
    type: folder
  items:
  - info:
      name: Get public dashboard
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/dashboards/:id/public
      params:
      - name: id
        value: ''
        type: path
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint returns public sharing config for a dashboard
  - info:
      name: Create public dashboard
      type: http
    http:
      method: POST
      url: https://{host}:{port}{base_path}/api/v1/dashboards/:id/public
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint creates public sharing config and enables public sharing of the dashboard
  - info:
      name: Update public dashboard
      type: http
    http:
      method: PUT
      url: https://{host}:{port}{base_path}/api/v1/dashboards/:id/public
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint updates the public sharing config for a dashboard
  - info:
      name: Delete public dashboard
      type: http
    http:
      method: DELETE
      url: https://{host}:{port}{base_path}/api/v1/dashboards/:id/public
      params:
      - name: id
        value: ''
        type: path
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint deletes the public sharing config and disables the public sharing of a dashboard
  - info:
      name: Get public dashboard data
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/public/dashboards/:id
      params:
      - name: id
        value: ''
        type: path
    docs: This endpoint returns the sanitized dashboard data for public access
  - info:
      name: Get query range result
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/public/dashboards/:id/widgets/:idx/query_range
      params:
      - name: id
        value: ''
        type: path
      - name: idx
        value: ''
        type: path
    docs: This endpoint return query range results for a widget of public dashboard
- info:
    name: authdomains
    type: folder
  items:
  - info:
      name: List all auth domains
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/domains
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint lists all auth domains
  - info:
      name: Create auth domain
      type: http
    http:
      method: POST
      url: https://{host}:{port}{base_path}/api/v1/domains
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint creates an auth domain
  - info:
      name: Update auth domain
      type: http
    http:
      method: PUT
      url: https://{host}:{port}{base_path}/api/v1/domains/:id
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint updates an auth domain
  - info:
      name: Delete auth domain
      type: http
    http:
      method: DELETE
      url: https://{host}:{port}{base_path}/api/v1/domains/:id
      params:
      - name: id
        value: ''
        type: path
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint deletes an auth domain
- info:
    name: downtimeschedules
    type: folder
  items:
  - info:
      name: List downtime schedules
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/downtime_schedules
      params:
      - name: active
        value: ''
        type: query
      - name: recurring
        value: ''
        type: query
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint lists all planned maintenance / downtime schedules
  - info:
      name: Create downtime schedule
      type: http
    http:
      method: POST
      url: https://{host}:{port}{base_path}/api/v1/downtime_schedules
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint creates a new planned maintenance / downtime schedule
  - info:
      name: Get downtime schedule by ID
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/downtime_schedules/:id
      params:
      - name: id
        value: ''
        type: path
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint returns a downtime schedule by ID
  - info:
      name: Update downtime schedule
      type: http
    http:
      method: PUT
      url: https://{host}:{port}{base_path}/api/v1/downtime_schedules/:id
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint updates a downtime schedule by ID
  - info:
      name: Delete downtime schedule
      type: http
    http:
      method: DELETE
      url: https://{host}:{port}{base_path}/api/v1/downtime_schedules/:id
      params:
      - name: id
        value: ''
        type: path
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint deletes a downtime schedule by ID
- info:
    name: logs
    type: folder
  items:
  - info:
      name: Export raw data
      type: http
    http:
      method: POST
      url: https://{host}:{port}{base_path}/api/v1/export_raw_data
      params:
      - name: format
        value: ''
        type: query
        description: The output format for the export.
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoints allows complex query exporting raw data for traces and logs
  - info:
      name: Promote and index paths
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/logs/promote_paths
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoints promotes and indexes paths
  - info:
      name: Promote and index paths
      type: http
    http:
      method: POST
      url: https://{host}:{port}{base_path}/api/v1/logs/promote_paths
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoints promotes and indexes paths
- info:
    name: fields
    type: folder
  items:
  - info:
      name: Get field keys
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/fields/keys
      params:
      - name: signal
        value: ''
        type: query
      - name: source
        value: ''
        type: query
      - name: limit
        value: ''
        type: query
      - name: startUnixMilli
        value: ''
        type: query
      - name: endUnixMilli
        value: ''
        type: query
      - name: fieldContext
        value: ''
        type: query
      - name: fieldDataType
        value: ''
        type: query
      - name: metricName
        value: ''
        type: query
      - name: metricNamespace
        value: ''
        type: query
      - name: searchText
        value: ''
        type: query
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint returns field keys
  - info:
      name: Get field values
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/fields/values
      params:
      - name: signal
        value: ''
        type: query
      - name: source
        value: ''
        type: query
      - name: limit
        value: ''
        type: query
      - name: startUnixMilli
        value: ''
        type: query
      - name: endUnixMilli
        value: ''
        type: query
      - name: fieldContext
        value: ''
        type: query
      - name: fieldDataType
        value: ''
        type: query
      - name: metricName
        value: ''
        type: query
      - name: metricNamespace
        value: ''
        type: query
      - name: searchText
        value: ''
        type: query
      - name: name
        value: ''
        type: query
      - name: existingQuery
        value: ''
        type: query
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint returns field values
- info:
    name: users
    type: folder
  items:
  - info:
      name: Get reset password token
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/getResetPasswordToken/:id
      params:
      - name: id
        value: ''
        type: path
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint returns the reset password token by id
  - info:
      name: Create invite
      type: http
    http:
      method: POST
      url: https://{host}:{port}{base_path}/api/v1/invite
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint creates an invite for a user
  - info:
      name: Create bulk invite
      type: http
    http:
      method: POST
      url: https://{host}:{port}{base_path}/api/v1/invite/bulk
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint creates a bulk invite for a user
  - info:
      name: Reset password
      type: http
    http:
      method: POST
      url: https://{host}:{port}{base_path}/api/v1/resetPassword
      body:
        type: json
        data: '{}'
    docs: This endpoint resets the password by token
  - info:
      name: List users
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/user
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint lists all users
  - info:
      name: Get user
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/user/:id
      params:
      - name: id
        value: ''
        type: path
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint returns the user by id
  - info:
      name: Update user
      type: http
    http:
      method: PUT
      url: https://{host}:{port}{base_path}/api/v1/user/:id
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint updates the user by id
  - info:
      name: Delete user
      type: http
    http:
      method: DELETE
      url: https://{host}:{port}{base_path}/api/v1/user/:id
      params:
      - name: id
        value: ''
        type: path
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint deletes the user by id
  - info:
      name: Get my user
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/user/me
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: This endpoint returns the user I belong to
  - info:
      name: Forgot password
      type: http
    http:
      method: POST
      url: https://{host}:{port}{base_path}/api/v2/factor_password/forgot
      body:
        type: json
        data: '{}'
    docs: This endpoint initiates the forgot password flow by sending a reset password email
  - info:
      name: Get users by role id
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v2/roles/:id/users
      params:
      - name: id
        value: ''
        type: path
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint returns the users having the role by role id
  - info:
      name: List users v2
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v2/users
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint lists all users for the organization
  - info:
      name: Get user by user id
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v2/users/:id
      params:
      - name: id
        value: ''
        type: path
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint returns the user by id
  - info:
      name: Update user v2
      type: http
    http:
      method: PUT
      url: https://{host}:{port}{base_path}/api/v2/users/:id
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint updates the user by id
  - info:
      name: Get reset password token for a user
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v2/users/:id/reset_password_tokens
      params:
      - name: id
        value: ''
        type: path
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint returns the existing reset password token for a user.
  - info:
      name: Create or regenerate reset password token for a user
      type: http
    http:
      method: PUT
      url: https://{host}:{port}{base_path}/api/v2/users/:id/reset_password_tokens
      params:
      - name: id
        value: ''
        type: path
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint creates or regenerates a reset password token for a user. If a valid token exists, it is returned.
      If expired, a new one is created.
  - info:
      name: Get user roles
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v2/users/:id/roles
      params:
      - name: id
        value: ''
        type: path
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint returns the user roles by user id
  - info:
      name: Set user roles
      type: http
    http:
      method: POST
      url: https://{host}:{port}{base_path}/api/v2/users/:id/roles
      params:
      - name: id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint assigns the role to the user roles by user id
  - info:
      name: Remove a role from user
      type: http
    http:
      method: DELETE
      url: https://{host}:{port}{base_path}/api/v2/users/:id/roles/:roleId
      params:
      - name: id
        value: ''
        type: path
      - name: roleId
        value: ''
        type: path
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint removes a role from the user by user id and role id
  - info:
      name: Get my user v2
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v2/users/me
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: This endpoint returns the user I belong to
  - info:
      name: Update my user v2
      type: http
    http:
      method: PUT
      url: https://{host}:{port}{base_path}/api/v2/users/me
      body:
        type: json
        data: '{}'
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: This endpoint updates the user I belong to
  - info:
      name: Updates my password
      type: http
    http:
      method: PUT
      url: https://{host}:{port}{base_path}/api/v2/users/me/factor_password
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint updates the password of the user I belong to
- info:
    name: global
    type: folder
  items:
  - info:
      name: Get global config
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/global/config
    docs: This endpoint returns global config
- info:
    name: llmpricingrules
    type: folder
  items:
  - info:
      name: List pricing rules
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/llm_pricing_rules
      params:
      - name: offset
        value: ''
        type: query
      - name: limit
        value: ''
        type: query
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: Returns all LLM pricing rules for the authenticated org, with pagination.
  - info:
      name: Create or update pricing rules
      type: http
    http:
      method: PUT
      url: https://{host}:{port}{base_path}/api/v1/llm_pricing_rules
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: Single write endpoint used by both the user and the Zeus sync job. Per-rule match is by id, then sourceId, then
      insert. Override rows (is_override=true) are fully preserved when the request does not provide isOverride; only synced_at
      is stamped.
  - info:
      name: Get a pricing rule
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/llm_pricing_rules/:id
      params:
      - name: id
        value: ''
        type: path
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: Returns a single LLM pricing rule by ID.
  - info:
      name: Delete a pricing rule
      type: http
    http:
      method: DELETE
      url: https://{host}:{port}{base_path}/api/v1/llm_pricing_rules/:id
      params:
      - name: id
        value: ''
        type: path
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: Hard-deletes a pricing rule. If auto-synced, it will be recreated on the next sync cycle.
- info:
    name: preferences
    type: folder
  items:
  - info:
      name: List org preferences
      type: http
    http:
      method: GET
      url: https://{host}:{port}{base_path}/api/v1/org/preferences
      auth:
        type: apikey
        key: SigNoz-Api-Key
        value: '{{SigNoz-Api-Key}}'
        placement: header
    docs: This endpoint li

# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/signoz/refs/heads/main/apis.yml