Weidmüller Operations API

openapi: 3.2.0
info:
  title: Weidmueller Operations API
  version: 1.5.0-next
  contact:
    name: Weidmüller
  license:
    name: MIT
    identifier: MIT
  description: 'Operations tagged operations across 2 of this provider''s published API definitions: administration-openapi.yaml, weidmueller-administration-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /u-os-adm/api/v1
tags:
- name: Operations
  description: API for u-OS long running operations
paths:
  /operations/{operation_id}:
    get:
      tags:
      - Operations
      summary: Get the status of a long running operation by its ID
      description: The operation ID can only be retained at the time it is created.
      operationId: get_operation
      parameters:
      - name: operation_id
        in: path
        description: ID of the operation
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Status of the long running operation
          headers:
            Location:
              schema:
                type: string
              description: URL of the created resource as result of the long running operation. This is only the case when the process has been completed and a resource has been created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationState'
        default:
          description: Common HTTP Error codes may be thrown by this method, such as 400, 401, 403, 404, 412, 422 or 500. See body for detailed error info.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/HttpErrorPayload'
      security:
      - OAuth2: []
    servers:
    - url: /u-os-adm/api/v1
components:
  schemas:
    OperationState:
      oneOf:
      - $ref: '#/components/schemas/OperationStatePending'
      - $ref: '#/components/schemas/OperationStateCompleted'
      - $ref: '#/components/schemas/OperationStateFailed'
      description: Represents the entire state of a long-running operation.
      examples:
      - created_at: 2026-08-31 12:57:46.627169+00:00
        status: PENDING
      discriminator:
        propertyName: status
        mapping:
          COMPLETED: '#/components/schemas/OperationStateCompleted'
          FAILED: '#/components/schemas/OperationStateFailed'
          PENDING: '#/components/schemas/OperationStatePending'
    HttpErrorPayload:
      type: object
      description: 'Common error payload structure for HTTP responses.


        Based on [RFC 9457](https://datatracker.ietf.org/doc/html/rfc9457)'
      required:
      - type
      - title
      - status
      properties:
        detail:
          type:
          - string
          - 'null'
          description: Optional details about the error
          example: 'Low Level OS Error #1234'
        instance:
          type:
          - string
          - 'null'
          format: uri-reference
          description: A human-readable explanation specific to this occurrence of the problem
          example: null
        status:
          type: integer
          format: int32
          description: The HTTP status code generated by the origin server for this occurrence of the problem
          example: 500
          maximum: 599
          minimum: 100
        title:
          type: string
          description: Human-readable error message.
          example: Something went wrong in the backend.
        type:
          type: string
          format: uri-reference
          description: 'A URI reference that identifies the problem type


            The last part of the URI is always a `ErrorId`'
          example: /u-os-adm/api/v1/errors/set-security-settings
    OperationStatePending:
      type: object
      required:
      - status
      - created_at
      properties:
        created_at:
          type: string
          format: date-time
        status:
          type: string
          enum:
          - PENDING
    OperationStateFailed:
      type: object
      required:
      - status
      - created_at
      - failed_at
      properties:
        created_at:
          type: string
          format: date-time
        failed_at:
          type: string
          format: date-time
        resource_url:
          type: string
          format: url
        status:
          type: string
          enum:
          - FAILED
    OperationStateCompleted:
      type: object
      required:
      - status
      - created_at
      - completed_at
      properties:
        completed_at:
          type: string
          format: date-time
        created_at:
          type: string
          format: date-time
        resource_id:
          type: string
        resource_url:
          type: string
          format: url
        status:
          type: string
          enum:
          - COMPLETED
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: /oauth2/token
          scopes:
            u-os-adm.firewall.readonly: Read access for firewall endpoints
            u-os-adm.firewall.readwrite: Read and write access for firewall endpoints
            u-os-adm.logging.readonly: Read access for logging endpoints
            u-os-adm.network.readonly: Read access for network endpoints
            u-os-adm.network.readwrite: Read and write access for network endpoints
            u-os-adm.realtime.readonly: Read access for realtime endpoints
            u-os-adm.realtime.readwrite: Read and write access for realtime endpoints
            u-os-adm.recovery.readwrite: Read and write access for recovery endpoints
            u-os-adm.security.readonly: Read access for security endpoints
            u-os-adm.security.readwrite: Read and write access for security endpoints
            u-os-adm.serial-interfaces.readonly: Read access for serial interface configuration endpoints
            u-os-adm.serial-interfaces.readwrite: Read and write access for serial interface configuration endpoints
            u-os-adm.syslog.readonly: Read access for syslog endpoints
            u-os-adm.syslog.readwrite: Read and write access for syslog endpoints
            u-os-adm.system.readonly: Read access for system endpoints
            u-os-adm.system.readwrite: Read and write access for system endpoints
            u-os-adm.time.readonly: Read access for time settings endpoints
            u-os-adm.time.readwrite: Read and write access for time settings endpoints
            u-os-adm.update.readonly: Read access for update endpoints
            u-os-adm.update.readwrite: Read and write access for update endpoints
      description: The HTTP API uses the OAuth2 client credentials flow.
x-refined-from:
- administration-openapi.yaml
- weidmueller-administration-openapi.yml