Acronis Agent Updates API

Agent update configuration and execution

OpenAPI Specification

acronis-agent-updates-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Acronis Account Management Activities Agent Updates API
  description: The Acronis Account Management API provides endpoints for managing tenants, users, OAuth clients, applications, licensing (offering items), usage reporting, infrastructure, and branding within the Acronis Cyber Protect Cloud platform.
  version: '2.0'
  contact:
    name: Acronis Developer Portal
    url: https://developer.acronis.com
  x-generated-from: documentation
  x-last-validated: '2026-04-19'
servers:
- url: https://{datacenter}.acronis.com/api/2
  description: Acronis Cloud API - Account Management
  variables:
    datacenter:
      default: eu2-cloud
      description: Acronis datacenter region (e.g., us-cloud, eu2-cloud, au-cloud)
security:
- bearerAuth: []
tags:
- name: Agent Updates
  description: Agent update configuration and execution
paths:
  /agents/update:force:
    post:
      operationId: forceAgentUpdate
      summary: Acronis Force Agent Update
      description: Launch a forced agent update bypassing maintenance windows for specified agents.
      tags:
      - Agent Updates
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - agent_ids
              properties:
                agent_ids:
                  type: array
                  items:
                    type: string
                  description: List of agent IDs to force update
      responses:
        '200':
          description: Update initiated
          content:
            application/json:
              schema:
                type: object
                properties:
                  task_id:
                    type: string
                    description: Task ID tracking the update operation
        '400':
          $ref: '#/components/responses/BadRequest'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /agent_update_settings:
    get:
      operationId: getAgentUpdateSettings
      summary: Acronis Get Agent Update Settings
      description: Fetch update configuration settings for agents or tenants.
      tags:
      - Agent Updates
      parameters:
      - name: tenant_id
        in: query
        schema:
          type: string
          format: uuid
        description: Tenant UUID to scope settings
      responses:
        '200':
          description: Agent update settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentUpdateSettings'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: updateAgentUpdateSettings
      summary: Acronis Update Agent Update Settings
      description: Store or update agent update configuration settings including maintenance windows.
      tags:
      - Agent Updates
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentUpdateSettings'
      responses:
        '200':
          description: Settings updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentUpdateSettings'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    MaintenanceWindow:
      type: object
      description: Time window for restricting automatic updates
      properties:
        time_from:
          type: string
          description: Start time in HH:MM format (UTC)
          example: 02:00
        time_to:
          type: string
          description: End time in HH:MM format (UTC)
          example: 06:00
        days_of_week:
          type: array
          items:
            type: string
            enum:
            - MONDAY
            - TUESDAY
            - WEDNESDAY
            - THURSDAY
            - FRIDAY
            - SATURDAY
            - SUNDAY
          description: Days when maintenance window applies
    Error:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
    AgentUpdateSettings:
      type: object
      description: Configuration for automatic agent updates
      properties:
        update_channel:
          type: string
          enum:
          - CURRENT
          - STABLE
          description: Update channel to use
          example: STABLE
        automatic:
          type: boolean
          description: Whether updates should be applied automatically
          example: true
        maintenance_window:
          $ref: '#/components/schemas/MaintenanceWindow'
  responses:
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth2 bearer token obtained from /idp/token
    basicAuth:
      type: http
      scheme: basic
      description: Base64-encoded client_id:client_secret