Aloft Maintenance Schedules (Beta) API

openapi: 3.0.0
info:
  title: Aloft API V1 Accounts Maintenance Schedules (Beta) API
  contact:
    email: support@aloft.ai
  version: 1.0.0
  description: Accounts
tags:
- name: Maintenance Schedules (Beta)
  description: Maintenance Schedules (Beta)
paths:
  /v1/account/{account_id}/schedules:
    get:
      tags:
      - Maintenance Schedules (Beta)
      summary: Get all schedules
      description: Get all schedules
      operationId: 05aeaa481f3aca80af46d1ec5165252d
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#components/schemas/model_id'
      - name: order_by
        in: query
        description: The field to order the data by
        schema:
          type: string
          enum:
          - name
      - name: order
        in: query
        schema:
          $ref: '#components/schemas/order_direction'
      - name: appends[]
        in: query
        description: Array of appendable resource names
        schema:
          type: array
          items:
            type: string
            enum:
            - schedule_targets
            - target_count
      - name: page
        in: query
        schema:
          type: integer
      - name: page_length
        in: query
        schema:
          type: integer
      responses:
        '403':
          description: Access Denied
        '401':
          description: Unauthorized
        '200':
          description: Successful operation
          content:
            application/json: {}
            application/csv: {}
      security:
      - Aloft Token: []
    post:
      tags:
      - Maintenance Schedules (Beta)
      summary: Create a schedule
      description: Create a schedule
      operationId: df0472a7ae9f877ff2fdd575c7c6a4dd
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#components/schemas/model_id'
      - name: appends[]
        in: query
        description: Array of appendable resource names
        schema:
          type: array
          items:
            type: string
            enum:
            - schedule_targets
            - target_count
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#components/schemas/schedule'
      responses:
        '403':
          description: Access Denied
        '401':
          description: Unauthorized
        '422':
          description: Unprocessable Content
        '201':
          description: Successful operation
      security:
      - Aloft Token: []
  /v1/account/{account_id}/schedules/{schedule_id}:
    get:
      tags:
      - Maintenance Schedules (Beta)
      summary: Get single schedule
      description: Get single schedule
      operationId: 853ef80659c51278133963b40b203bb7
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#components/schemas/model_id'
      - name: schedule_id
        in: path
        description: Schedule ID
        required: true
        schema:
          type: integer
      - name: appends[]
        in: query
        description: Array of appendable resource names
        schema:
          type: array
          items:
            type: string
            enum:
            - schedule_targets
            - target_count
      responses:
        '403':
          description: Access Denied
        '401':
          description: Unauthorized
        '200':
          description: Successful operation
          content:
            application/json: {}
            application/csv: {}
      security:
      - Aloft Token: []
    put:
      tags:
      - Maintenance Schedules (Beta)
      summary: Update a schedules
      description: Update a schedules
      operationId: f75a2f7b399dd25267a41aa9f86acd73
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#components/schemas/model_id'
      - name: appends[]
        in: query
        description: Array of appendable resource names
        schema:
          type: array
          items:
            type: string
            enum:
            - schedule_targets
      - name: schedule_id
        in: path
        description: Schedule ID
        required: true
        schema:
          type: integer
      - name: appends[]
        in: query
        description: Array of appendable resource names
        schema:
          type: array
          items:
            type: string
            enum:
            - schedule_targets
            - target_count
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#components/schemas/schedule'
      responses:
        '403':
          description: Access Denied
        '401':
          description: Unauthorized
        '422':
          description: Unprocessable Content
        '200':
          description: Successful operation
      security:
      - Aloft Token: []
    delete:
      tags:
      - Maintenance Schedules (Beta)
      summary: Delete a schedule
      description: Delete a schedule
      operationId: f9fea0091c95ca935eaaa1cf824f7e8c
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#components/schemas/model_id'
      - name: schedule_id
        in: path
        description: Schedule ID
        required: true
        schema:
          type: integer
      responses:
        '403':
          description: Access Denied
        '401':
          description: Unauthorized
        '204':
          description: Successful operation
      security:
      - Aloft Token: []
components:
  securitySchemes:
    Aloft Token:
      type: http
      name: Aloft Token
      in: header
      scheme: bearer