ilert Service Outages API

openapi: 3.2.0
info:
  title: ilert REST Alert Actions Service Outages API
  description: "# Introduction\nThe ilert API is a [RESTful](https://en.wikipedia.org/wiki/Representational_state_transfer) API and provides programmatic access to entities in ilert and lets you easily integrate ilert with 3rd party tools. If you are looking to develop an inbound integration (e.g. for a monitoring tool), please use our [Events API](#tag/events). \n\nThe API supports the JSON content type for requests and responses. The response content type is requested via the HTTP Accept header (`application/json`). All resources are accessible via https and are located at `api.ilert.com/api`. \n\n You may download ilert's latest [OpenAPI.json {...} here](https://api.ilert.com/api-docs/openapi.json).\n\n If you are looking for a classic Swagger-UI view you may also open [this link](https://api.ilert.com/api-docs/swagger-ui). \n\n ## Authentication\nThe REST API accepts bearer API tokens. Each user may create API keys using the ilert web application. Note: Make sure to send the `Bearer ` prefix e.g. `Bearer APIKEY` when sending api key requests. By default, access to all resources (using any method) requires the client to be authenticated.\n\n ## Team Context\n When using API tokens, the currently selected team context of the user will not be taken into account, i.e. list results will always return all entities to which the user has a view permission. When using basic auth credentials the currently selected team context of the user will be used to filter resource results. The context may be overwritten for API key calls using the `team-context` HTTP header. Specifying `0` for ALL teams, `-1` for MY teams or a specific team id e.g. `team-context=901` to fetch results for a certain team.  \n\n ## Errors\nilert uses HTTP response codes to indicate success or failure of an API request. Codes in the 2xx range indicate success, codes in the 4xx range indicate a client error (e.g. a missing required parameter) and codes in the 5xx range indicate an error with ilert's servers. In case of an error, the response body contains the following information:\n\n Attribute     | Description \n ------------- | ------------- \n status  | the corresponsing HTTP status code  \n message  | a human readable description of the error \n code  | error code, used to identify error type  \n\n ## API Versioning\nChanges to our API are always backwards-compatible. To get more information about our API versioning and historical changes, please <a href='https://docs.ilert.com/rest-api/api-version-history' target='_blank'>take a look here</a>."
  version: v2.2026.5-r.3
  x-logo:
    url: ./ilert-logo-spaced.png
    backgroundColor: '#fafafa'
    altText: ilert documentation logo
servers:
- url: /api
security:
- apiKey: []
tags:
- name: Service Outages
paths:
  /service-outages:
    get:
      tags:
      - Service Outages
      summary: Get the outages (including applied overrides) of a specific service
      parameters:
      - name: service
        in: query
        description: the id of the service for which the outages should be fetched
        schema:
          type: number
      - name: from
        in: query
        description: from date, ISO-UTC e.g. 2021-05-25T21:24:56.771Z
        schema:
          type: string
          format: date-time
      - name: until
        in: query
        description: until date, ISO-UTC e.g. 2021-05-26T21:24:56.771Z
        schema:
          type: string
          format: date-time
      - name: ignore-overrides
        in: query
        description: if the outages should not take overrides into account, default is false
        schema:
          type: boolean
      responses:
        '200':
          description: The outages of the service
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ServiceOutage'
  /service-outages/overrides:
    get:
      tags:
      - Service Outages
      summary: Get the overrides of a specific service
      parameters:
      - name: service
        in: query
        description: the id of the service for which the overrides should be fetched
        schema:
          type: number
      - name: from
        in: query
        description: from date, ISO-UTC e.g. 2021-05-25T21:24:56.771Z
        schema:
          type: string
          format: date-time
      - name: until
        in: query
        description: until date, ISO-UTC e.g. 2021-05-26T21:24:56.771Z
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: The overrides of the service
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ServiceOutageOverride'
    post:
      tags:
      - Service Outages
      summary: Override a part of a service's outage history
      requestBody:
        description: override that should be made
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceOutageOverride'
        required: true
      responses:
        '201':
          description: The added override
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceOutageOverride'
      x-codegen-request-body-name: override
  /service-outages/overrides/{id}:
    get:
      tags:
      - Service Outages
      summary: Get the specific service outage override
      parameters:
      - name: id
        in: path
        description: entity ID
        required: true
        schema:
          type: number
      responses:
        '200':
          description: The override
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceOutageOverride'
    put:
      tags:
      - Service Outages
      summary: Update an existing service outage override
      parameters:
      - name: id
        in: path
        description: entity ID
        required: true
        schema:
          type: number
      requestBody:
        description: override that should be made
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceOutageOverride'
        required: true
      responses:
        '200':
          description: The updated override
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceOutageOverride'
      x-codegen-request-body-name: override
    delete:
      tags:
      - Service Outages
      summary: Remove a service outage override
      parameters:
      - name: id
        in: path
        description: entity ID
        required: true
        schema:
          type: number
      responses:
        '204':
          description: the response
          content: {}
components:
  schemas:
    ServiceNoIncludes:
      type: object
      properties:
        id:
          type: number
        name:
          type: string
        alias:
          type: string
        status:
          $ref: '#/components/schemas/ServiceStatus'
        description:
          type: string
        oneOpenIncidentOnly:
          type: boolean
        showUptimeHistory:
          type: boolean
        teams:
          type: array
          items:
            $ref: '#/components/schemas/TeamRel'
    ServiceStatus:
      type: string
      description: the service status
      enum:
      - OPERATIONAL
      - UNDER_MAINTENANCE
      - DEGRADED
      - PARTIAL_OUTAGE
      - MAJOR_OUTAGE
    ServiceOutageOverride:
      type: object
      properties:
        id:
          type: string
        service:
          $ref: '#/components/schemas/ServiceNoIncludes'
        status:
          $ref: '#/components/schemas/ServiceStatus'
        from:
          type: string
          format: date-time
        until:
          type: string
          format: date-time
    ServiceOutage:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/ServiceStatus'
        from:
          type: string
          format: date-time
        until:
          type: string
          format: date-time
    TeamRel:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
  securitySchemes:
    apiKey:
      type: apiKey
      description: The Bearer API key of your user <a href='/api-docs/#section/Authentication'>more info</a>.
      name: Authorization
      in: header
x-original-swagger-version: '2.0'