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

# Get an SLO



## OpenAPI

````yaml api-reference/openapi.json GET /slos/{id}
openapi: 3.1.0
info:
  title: Observer API
  version: 1.2.0
  description: >-
    Public API for Observer: read services, metrics, SLOs and SLA statements;
    manage incidents, maintenance windows, manual metric status, config as code
    and Observer Agents. Bearer-auth via API keys (obs_pub_…), scoped per key.
    RFC 7807 problem-detail errors. Cursor pagination. Rate limits are per
    organization. Every date-time value is RFC 3339 in UTC with millisecond
    precision (`2026-01-31T12:00:00.000Z`).
servers:
  - url: https://use.observer/api/v1
security:
  - bearerAuth: []
paths:
  /slos/{id}:
    get:
      tags:
        - slos
      summary: Get SLO by id or key, with latest burn event
      operationId: getSlo
      parameters:
        - name: id
          in: path
          required: true
          description: >-
            The SLO's id, or its key in config documents (its config_key, or the
            key config export gives one made in the console).
          schema:
            type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SloDetail'
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-RateLimit-Daily-Limit:
              $ref: '#/components/headers/X-RateLimit-Daily-Limit'
            X-RateLimit-Daily-Remaining:
              $ref: '#/components/headers/X-RateLimit-Daily-Remaining'
            X-RateLimit-Daily-Reset:
              $ref: '#/components/headers/X-RateLimit-Daily-Reset'
        '401':
          description: >-
            `unauthenticated`: no bearer token was sent, or the key is invalid
            or revoked. `detail` distinguishes the two.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: >-
            `forbidden`: the key does not carry the scope this endpoint
            requires. `plan_does_not_permit_api`: the organization's plan does
            not include the public API.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '404':
          description: >-
            `not_found`: no SLO with that id is available to this key. One owned
            by another organization, or an id that is not a valid UUID, returns
            the same response, so a 404 does not confirm that the id is unused.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: >-
            `rate_limited`: the organization's per-minute or daily request limit
            is used up (`limit.window` says which). Limits are per organization,
            shared by every key. The response carries `Retry-After` and
            `retry_after`, in seconds.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          headers:
            Retry-After:
              $ref: '#/components/headers/Retry-After'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-RateLimit-Daily-Limit:
              $ref: '#/components/headers/X-RateLimit-Daily-Limit'
            X-RateLimit-Daily-Remaining:
              $ref: '#/components/headers/X-RateLimit-Daily-Remaining'
            X-RateLimit-Daily-Reset:
              $ref: '#/components/headers/X-RateLimit-Daily-Reset'
        '500':
          description: '`internal_error`: an unhandled server error. Safe to retry.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      security:
        - bearerAuth:
            - read:slos
components:
  schemas:
    SloDetail:
      allOf:
        - type: object
          required:
            - id
            - name
            - service_id
            - metric_def_id
            - target_pct
            - window_days
            - public
            - created_at
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
            service_id:
              type: string
              format: uuid
            metric_def_id:
              type: string
              format: uuid
            target_pct:
              type:
                - string
                - number
            window_days:
              type: integer
            public:
              type: boolean
            unknown_policy:
              type: string
              enum:
                - down
                - exclude
                - up
              description: >-
                How unobserved periods count toward the budget: down (silence
                counts against the SLA, default), exclude (silence drops from
                the calculation; monitoring coverage is disclosed on reporting
                surfaces), up (silence counts as up).
            maintenance_policy:
              type: string
              enum:
                - exclude
                - count
              description: >-
                What published, scheduled maintenance on the SLO's service does
                to the error budget: exclude (samples inside the window leave
                the calculation, so maintenance pauses the budget and never
                opens a burn event; default) or count (maintenance burns budget
                like any other sample).
            error_budget_remaining_pct:
              type:
                - string
                - number
                - 'null'
            last_evaluated_at:
              type:
                - string
                - 'null'
              format: date-time
            created_at:
              type: string
              format: date-time
            config_key:
              type:
                - string
                - 'null'
              description: >-
                The SLO's key in config documents (null for one made in the
                console and never applied from config). Per-key DELETE takes
                this.
            managed_by:
              type: string
              enum:
                - config
                - console
              description: >-
                config: owned by config apply (prune and per-key delete may
                remove it). console: made in the console; config apply adopts it
                when a document names it.
            suspended:
              type: boolean
              description: >-
                true while the SLO is suspended because the organization is over
                its plan's limit (after a 7-day grace). Nothing is deleted; it
                is read-only until the person chooses it as active in Billing or
                upgrades. Writes return 403 `item_suspended_plan`.
            suspended_at:
              type:
                - string
                - 'null'
              format: date-time
              description: When the suspension started.
        - type: object
          properties:
            latest_burn_event:
              type:
                - object
                - 'null'
              properties:
                id:
                  type: string
                  format: uuid
                started_at:
                  type: string
                  format: date-time
                ended_at:
                  type:
                    - string
                    - 'null'
                  format: date-time
                error_budget_burned_pct:
                  type:
                    - string
                    - number
                    - 'null'
                  description: >-
                    The event's PEAK overspend: the largest |budget left|
                    (percent of the error budget, once negative) seen while the
                    event was open, never the latest value. The share of the
                    budget used is 100 + this. 0 when the event opened at
                    exactly 0 and never went below. 9999.9999 is the evaluator's
                    clamp (over 10,000% used).
            updated_at:
              type: string
              format: date-time
            key:
              type: string
              description: >-
                The SLO's key in config documents: its config_key, or the key
                config export gives a console SLO. PUT /slos/{key} takes it.
            service:
              type: string
              description: >-
                The key of the SLO's service (its config_key, or the key config
                export gives a console service).
            metric:
              type: string
              description: >-
                The key of the metric the SLO measures (its config_key, or the
                key config export gives a console metric).
    Problem:
      type: object
      required:
        - type
        - title
        - status
      example:
        type: https://docs.use.observer/api/getting-started/errors#forbidden
        title: forbidden
        status: 403
        detail: 'missing scope: write:incidents'
      properties:
        type:
          type: string
          format: uri
          description: Errors reference URI with the title token as the fragment.
          example: https://docs.use.observer/api/getting-started/errors#forbidden
        title:
          type: string
          description: Stable error token. Branch on this, not on detail.
        status:
          type: integer
        detail:
          type: string
          description: Human-readable explanation. Wording may change.
        retry_after:
          type: integer
          description: >-
            429 only: seconds until the exhausted window resets (mirrors
            Retry-After).
        limit:
          type: object
          description: '429 only: which organization limit was hit.'
          properties:
            scope:
              type: string
              enum:
                - organization
            window:
              type: string
              enum:
                - minute
                - day
            max:
              type: integer
            plan:
              type: string
        errors:
          type: array
          description: >-
            Validation failures (config_invalid, invalid_customer_targeting):
            one entry per problem.
          items:
            type: object
            properties:
              path:
                type: string
              message:
                type: string
        warnings:
          type: array
          description: >-
            config_invalid only: the same non-fatal warnings a successful apply
            returns.
          items:
            type: object
            properties:
              path:
                type: string
              message:
                type: string
        unknown_customers:
          type: array
          description: >-
            unknown_customers only: the submitted values that matched no
            customer in your organization.
          items:
            type: string
        unknown_services:
          type: array
          description: >-
            unknown_services only: the submitted `affected_services` values that
            matched no service in your organization.
          items: {}
        referenced_by:
          type: object
          description: >-
            in_use only: what depends on the object (slos, pages: lists of { id,
            config_key, name }; subscribers: a count).
        quota:
          type: object
          description: >-
            quota_exceeded / feature_locked on a create, item_suspended_plan on
            a write to a suspended item: the plan limit involved.
          properties:
            capability:
              type: string
            used:
              type:
                - integer
                - 'null'
            cap:
              type:
                - integer
                - 'null'
            plan:
              type:
                - string
                - 'null'
        upgrade:
          type: object
          description: >-
            Plan-limit problems only, when a higher plan lifts the limit: the
            smallest such plan and the pricing page.
          properties:
            plan:
              type: string
            label:
              type: string
            url:
              type: string
              format: uri
  headers:
    X-RateLimit-Limit:
      description: Requests allowed per minute for the organization.
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests left in the current minute.
      schema:
        type: integer
    X-RateLimit-Reset:
      description: Seconds until the per-minute window resets.
      schema:
        type: integer
    X-RateLimit-Daily-Limit:
      description: Requests allowed per UTC day for the organization.
      schema:
        type: integer
    X-RateLimit-Daily-Remaining:
      description: Requests left today (UTC).
      schema:
        type: integer
    X-RateLimit-Daily-Reset:
      description: Seconds until the daily quota resets (UTC midnight).
      schema:
        type: integer
    Retry-After:
      description: '429 only: seconds to wait before retrying.'
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: obs_pub_
      description: >-
        An organization API key (obs_pub_…) sent as `Authorization: Bearer
        <key>`. Each key carries scopes; an endpoint lists the scope it needs.
        `read:change_events` is reserved: keys can carry it, but no endpoint
        needs it yet.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.