> ## Documentation Index
> Fetch the complete documentation index at: https://docs.aiaxoniq.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GET /api/services/:service

> Requires an authenticated session or API token.



## OpenAPI

````yaml /api/openapi.json get /api/services/{service}
openapi: 3.1.0
info:
  title: aiAxonIQ API
  description: >-
    Multi-tenant observability and AI-ops platform.


    **Authentication.** Browser clients authenticate with the `oiq_token`
    HttpOnly cookie set by `POST /auth/login`; programmatic clients send
    `Authorization: Bearer <jwt>`.


    **Tenancy.** `tenantId` appears in many query strings and is always
    overwritten from the authenticated session. A request naming a tenant other
    than its own is refused with 403 rather than silently corrected.


    **Errors.** Every non-2xx response uses one shape. Branch on `error`, which
    is stable; `message` is human-readable and may be reworded.
  version: 1.0.0
  x-impl-checksum: sha256:90a4047af5fb1edf26cedbb5bb5e4e85bc0cabd0c766995de4c1f6531133d66b
  x-schema-checksum: sha256:a58dff1e0bdc2914a7dfbd79c734baf13f9860c21df929c577f8d86eda245c94
servers:
  - url: https://app.aiaxoniq.com
    description: aiAxonIQ
security:
  - sessionCookie: []
  - bearerAuth: []
tags:
  - name: Authentication
    description: Sign in, refresh a session, and manage passwords and multi-factor codes.
  - name: Onboarding
    description: The state behind the in-product Get Started checklist.
  - name: License keys
    description: Mint, list and revoke the credentials that authenticate ingest.
  - name: Users and roles
    description: >-
      Organizations, membership, the four roles, and per-account display
      preferences.
  - name: Projects
    description: >-
      The scope every other group is read through: create, list and configure a
      project, rotate its ingest key, and manage its email notifications.
  - name: Overview
    description: Cross-signal counters and the platform event feed.
  - name: Logs
    description: Query logs, list queryable fields, and read discovered log patterns.
  - name: Metrics
    description: Query metrics and browse the metric catalogue.
  - name: Traces
    description: Query traces and fetch a single trace by id.
  - name: Services
    description: The service inventory, dependency graph, endpoints and deployment markers.
  - name: Errors
    description: >-
      Grouped failures: what is breaking, how often, and across which services
      and releases.
  - name: Real User Monitoring
    description: >-
      What a real person’s browser experienced: sessions, Core Web Vitals,
      front-end errors, resource timing and session replay.
  - name: Infrastructure
    description: Hosts, processes, compute and disks.
  - name: Kubernetes
    description: Clusters, nodes, namespaces, pods and containers.
  - name: Databases
    description: Per-engine database telemetry and its time series.
  - name: Network
    description: Observed flows and network topology.
  - name: Dashboards
    description: Dashboards, panels, templates, versions and shareable snapshots.
  - name: Saved queries
    description: Saved queries and the query templates shipped with the product.
  - name: Templates
    description: >-
      The dashboard template gallery, its ranking signals, favourites and usage
      statistics.
  - name: Alerts
    description: Alert rules, evaluation history, silences and test firing.
  - name: Notification channels
    description: Reusable channel credentials shared across rules.
  - name: SLOs
    description: >-
      Service level objectives, burn rate, forecasts, error-budget policies and
      SLA reporting.
  - name: Synthetic monitoring
    description: Checks, runs, uptime, probe locations, variables and downtimes.
  - name: Security
    description: >-
      Security events, detection rules, runtime threats, secrets and
      vulnerabilities.
  - name: SIEM
    description: >-
      Security information and event management: signals, detection rules, MITRE
      ATT&CK coverage, file-integrity monitoring, threat intelligence and case
      management.
  - name: Incidents and on-call
    description: >-
      Incidents and their timeline, the escalation policies that decide who is
      paged, and the maintenance windows that suppress paging.
  - name: LLM observability
    description: Model requests, cost and latency for AI workloads.
  - name: AgentSight
    description: 'eBPF-observed AI-agent activity: agents, events, timeline and insights.'
  - name: Zero-code instrumentation
    description: >-
      The eBPF agent fleet: which hosts run it, what they discovered, and how
      recently each was heard from.
  - name: AI
    description: >-
      Anomaly detection, forecasting, natural-language query, RAG and
      suggestions.
  - name: Audit log
    description: Who changed what, and export.
  - name: Usage and billing
    description: Ingest volume against plan limits, entitlements and billing.
  - name: Prometheus-compatible query API
    description: A PromQL-compatible read API for Grafana and other Prometheus clients.
paths:
  /api/services/{service}:
    get:
      tags:
        - Services
      summary: GET /api/services/:service
      description: Requires an authenticated session or API token.
      operationId: get_api_services_byService
      parameters:
        - name: service
          in: path
          required: true
          schema:
            type: string
        - name: tenantId
          in: query
          required: false
          description: >-
            Tenant identifier. Overwritten from the authenticated session; a
            value naming a different tenant is refused with 403.
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  downstreams:
                    items:
                      additionalProperties: false
                      properties:
                        direction:
                          type: string
                        error_rate:
                          type: number
                        errors:
                          type: string
                        last_seen:
                          type: string
                        p95:
                          type: number
                        requests:
                          type: string
                        source:
                          type: string
                        target:
                          type: string
                      required:
                        - direction
                        - source
                        - target
                        - requests
                        - errors
                        - error_rate
                        - p95
                        - last_seen
                      type: object
                    type: array
                  found:
                    type: boolean
                  latencyBucketMs:
                    type: integer
                  latencySeries:
                    items:
                      additionalProperties: false
                      properties:
                        avg_latency_ms:
                          type: number
                        name:
                          type: string
                        p50_latency_ms:
                          type: number
                        p95_latency_ms:
                          type: number
                        p99_latency_ms:
                          type: number
                        t:
                          type: string
                      required:
                        - name
                        - t
                        - avg_latency_ms
                        - p50_latency_ms
                        - p95_latency_ms
                        - p99_latency_ms
                      type: object
                    type: array
                  recentDeployments:
                    items:
                      additionalProperties: false
                      properties:
                        createdAt:
                          format: date-time
                          type: string
                        deployer:
                          type:
                            - string
                            - 'null'
                        environment:
                          type:
                            - string
                            - 'null'
                        finishedAt:
                          format: date-time
                          type:
                            - string
                            - 'null'
                        gitRef:
                          type:
                            - string
                            - 'null'
                        gitSha:
                          type:
                            - string
                            - 'null'
                        id:
                          type: string
                        metadata: {}
                        notes:
                          type:
                            - string
                            - 'null'
                        service:
                          type: string
                        startedAt:
                          format: date-time
                          type: string
                        status:
                          type: string
                        tenantId:
                          type: string
                        updatedAt:
                          format: date-time
                          type: string
                        version:
                          type: string
                      required:
                        - id
                        - tenantId
                        - service
                        - version
                        - environment
                        - status
                        - deployer
                        - gitSha
                        - gitRef
                        - notes
                        - metadata
                        - startedAt
                        - finishedAt
                        - createdAt
                        - updatedAt
                      type: object
                    type: array
                  runtime:
                    additionalProperties: false
                    properties:
                      detected:
                        type: boolean
                      last_seen:
                        type: string
                      metric_count:
                        type: string
                      runtime:
                        type: string
                      sample_count:
                        type: string
                    required:
                      - detected
                    type: object
                  service:
                    additionalProperties: false
                    properties:
                      avg_latency_ms:
                        type: number
                      environment:
                        type: string
                      error_count:
                        type: string
                      error_log_count:
                        type: string
                      error_rate:
                        type: number
                      language:
                        type: string
                      last_seen:
                        type: string
                      log_count:
                        type: string
                      name:
                        type: string
                      p95_latency_ms:
                        type: number
                      p99_latency_ms:
                        type: number
                      request_count:
                        type: string
                      total_spans:
                        type: string
                      trace_count:
                        type: string
                    required:
                      - name
                      - language
                      - total_spans
                      - request_count
                      - error_count
                      - error_rate
                      - avg_latency_ms
                      - p95_latency_ms
                      - p99_latency_ms
                      - last_seen
                      - trace_count
                      - log_count
                      - error_log_count
                      - environment
                    type:
                      - object
                      - 'null'
                  topEndpoints:
                    items:
                      additionalProperties: false
                      properties:
                        avg_latency_ms:
                          type: number
                        error_count:
                          type: string
                        error_rate:
                          type: number
                        last_seen:
                          type: string
                        method:
                          type: string
                        p95_latency_ms:
                          type: number
                        p99_latency_ms:
                          type: number
                        request_count:
                          type: string
                        route:
                          type: string
                        service_name:
                          type: string
                      required:
                        - service_name
                        - route
                        - method
                        - request_count
                        - error_count
                        - error_rate
                        - avg_latency_ms
                        - p95_latency_ms
                        - p99_latency_ms
                        - last_seen
                      type: object
                    type: array
                  upstreams:
                    items:
                      additionalProperties: false
                      properties:
                        direction:
                          type: string
                        error_rate:
                          type: number
                        errors:
                          type: string
                        last_seen:
                          type: string
                        p95:
                          type: number
                        requests:
                          type: string
                        source:
                          type: string
                        target:
                          type: string
                      required:
                        - direction
                        - source
                        - target
                        - requests
                        - errors
                        - error_rate
                        - p95
                        - last_seen
                      type: object
                    type: array
                  versions:
                    items:
                      additionalProperties: false
                      properties:
                        environment:
                          type: string
                        error_count:
                          type: string
                        first_seen:
                          type: string
                        last_seen:
                          type: string
                        metric_count:
                          type: string
                        service_name:
                          type: string
                        service_version:
                          type: string
                        span_count:
                          type: string
                      required:
                        - service_name
                        - service_version
                        - environment
                        - metric_count
                        - span_count
                        - error_count
                        - first_seen
                        - last_seen
                      type: object
                    type: array
                required:
                  - found
                  - service
                  - latencySeries
                  - latencyBucketMs
                  - upstreams
                  - downstreams
                  - topEndpoints
                  - versions
                  - recentDeployments
                  - runtime
                type: object
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - sessionCookie: []
        - bearerAuth: []
components:
  schemas:
    ApiError:
      type: object
      required:
        - error
        - message
        - requestId
      properties:
        error:
          type: string
          description: Stable machine-readable code. Branch on this.
        message:
          type: string
          description: Human-readable. May be reworded without notice.
        requestId:
          type: string
          description: Correlates with the server log line.
        details:
          type: array
          description: Field-level detail. Present only for VALIDATION_FAILED.
          items:
            type: object
            required:
              - path
              - message
            properties:
              path:
                type: string
              message:
                type: string
  securitySchemes:
    sessionCookie:
      type: apiKey
      in: cookie
      name: oiq_token
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````