Aptible Operations API

openapi: 3.2.0
info:
  title: Aptible Operations API
  version: '1.0'
  description: 'Operations tagged operations across 2 of this provider''s published API definitions: aptible-cloud-openapi-original.yml, aptible-deploy-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /
- url: '{baseUrl}'
  variables:
    baseUrl:
      default: https://api.aptible.com
      description: Override for local or test environments
tags:
- name: operations
paths:
  /api/v1/organizations/{organization_id}/operations/{operation_id}:
    servers:
    - url: /
    get:
      operationId: operation_get
      parameters:
      - explode: false
        in: path
        name: operation_id
        required: true
        schema:
          format: uuid
          title: Operation Id
          type: string
        style: simple
      - explode: false
        in: path
        name: organization_id
        required: true
        schema:
          format: uuid
          title: Organization Id
          type: string
        style: simple
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationOutput'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - HTTPBearer: []
      - HTTPBearer: []
      summary: Operation Get
      tags:
      - operations
  /api/v1/operations/{operation_id}:
    servers:
    - url: /
    put:
      operationId: operation_update
      parameters:
      - explode: false
        in: path
        name: operation_id
        required: true
        schema:
          format: uuid
          title: Operation Id
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OperationUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - HTTPBearer: []
      summary: Operation Update
      tags:
      - operations
  /persistent_disks/{persistent_disk_id}/operations:
    servers:
    - url: '{baseUrl}'
      variables:
        baseUrl:
          default: https://api.aptible.com
          description: Override for local or test environments
    get:
      description: Returns a paginated list of operations for the specified persistent disk.
      operationId: ListOperationsForPersistentDisk
      parameters:
      - description: persistent_disk_id
        explode: false
        in: path
        name: persistent_disk_id
        required: true
        schema:
          type: integer
        style: simple
      - description: Current page of paginated results
        explode: true
        in: query
        name: page
        required: false
        schema:
          type: integer
        style: form
      - description: Number of results to return per page
        explode: true
        in: query
        name: per_page
        required: false
        schema:
          type: integer
        style: form
      - description: 'When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present.'
        explode: true
        in: query
        name: no_embed
        required: false
        schema:
          type: boolean
        style: form
      - description: When set to no_sensitive_extras=true, omits sensitive fields and embedded resources from the response.
        explode: false
        in: header
        name: Prefer
        required: false
        schema:
          enum:
          - no_sensitive_extras=true
          type: string
        style: simple
      responses:
        '200':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ListOperationsForPersistentDisk_200_response'
          description: successful
        default:
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response. Often a 4xx or 5xx status code
      summary: list operations
      tags:
      - operations
      security:
      - token: []
    post:
      description: Creates a new operation for the specified persistent disk.
      operationId: CreateOperationForPersistentDisk
      parameters:
      - description: persistent_disk_id
        explode: false
        in: path
        name: persistent_disk_id
        required: true
        schema:
          type: integer
        style: simple
      - description: 'When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present.'
        explode: true
        in: query
        name: no_embed
        required: false
        schema:
          type: boolean
        style: form
      - description: When set to no_sensitive_extras=true, omits sensitive fields and embedded resources from the response.
        explode: false
        in: header
        name: Prefer
        required: false
        schema:
          enum:
          - no_sensitive_extras=true
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOperationRequest'
      responses:
        '201':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/operation'
          description: successful
        default:
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response. Often a 4xx or 5xx status code
      summary: create operation
      tags:
      - operations
      security:
      - token: []
  /operations/{id}:
    servers:
    - url: '{baseUrl}'
      variables:
        baseUrl:
          default: https://api.aptible.com
          description: Override for local or test environments
    get:
      description: Returns the details of a specific operation by ID.
      operationId: GetOperation
      parameters:
      - description: id
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: integer
        style: simple
      - description: 'When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present.'
        explode: true
        in: query
        name: no_embed
        required: false
        schema:
          type: boolean
        style: form
      - description: When set to no_sensitive_extras=true, omits sensitive fields and embedded resources from the response.
        explode: false
        in: header
        name: Prefer
        required: false
        schema:
          enum:
          - no_sensitive_extras=true
          type: string
        style: simple
      responses:
        '200':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/operation'
          description: successful
        default:
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response. Often a 4xx or 5xx status code
      summary: show operation
      tags:
      - operations
      security:
      - token: []
    patch:
      description: Partially updates an operation's attributes, such as cancelling it.
      operationId: PatchOperation
      parameters:
      - description: id
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: integer
        style: simple
      - description: 'When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present.'
        explode: true
        in: query
        name: no_embed
        required: false
        schema:
          type: boolean
        style: form
      - description: When set to no_sensitive_extras=true, omits sensitive fields and embedded resources from the response.
        explode: false
        in: header
        name: Prefer
        required: false
        schema:
          enum:
          - no_sensitive_extras=true
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOperation_request'
      responses:
        '200':
          description: successful
        default:
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response. Often a 4xx or 5xx status code
      summary: update operation
      tags:
      - operations
      security:
      - token: []
    put:
      description: Updates an operation's attributes, such as cancelling it.
      operationId: UpdateOperation
      parameters:
      - description: id
        explode: false
        in: path
        name: id
        required: true
        schema:
          type: integer
        style: simple
      - description: 'When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present.'
        explode: true
        in: query
        name: no_embed
        required: false
        schema:
          type: boolean
        style: form
      - description: When set to no_sensitive_extras=true, omits sensitive fields and embedded resources from the response.
        explode: false
        in: header
        name: Prefer
        required: false
        schema:
          enum:
          - no_sensitive_extras=true
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOperation_request'
      responses:
        '200':
          description: successful
        default:
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response. Often a 4xx or 5xx status code
      summary: update operation
      tags:
      - operations
      security:
      - token: []
  /operations/{operation_id}/logs:
    servers:
    - url: '{baseUrl}'
      variables:
        baseUrl:
          default: https://api.aptible.com
          description: Override for local or test environments
    get:
      description: Returns a presigned URL for downloading the logs of a completed operation.
      operationId: GetOperationLogs
      parameters:
      - description: operation_id
        explode: false
        in: path
        name: operation_id
        required: true
        schema:
          type: integer
        style: simple
      responses:
        '200':
          content:
            text/plain:
              schema:
                type: string
          description: Presigned download URL
        default:
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response. Often a 4xx or 5xx status code
      summary: get operation logs
      tags:
      - operations
      security:
      - token: []
  /accounts/{account_id}/operations:
    servers:
    - url: '{baseUrl}'
      variables:
        baseUrl:
          default: https://api.aptible.com
          description: Override for local or test environments
    get:
      description: Returns a paginated list of operations for the specified account.
      operationId: ListOperationsForAccount
      parameters:
      - description: account_id
        explode: false
        in: path
        name: account_id
        required: true
        schema:
          type: integer
        style: simple
      - description: Current page of paginated results
        explode: true
        in: query
        name: page
        required: false
        schema:
          type: integer
        style: form
      - description: Number of results to return per page
        explode: true
        in: query
        name: per_page
        required: false
        schema:
          type: integer
        style: form
      - description: 'When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present.'
        explode: true
        in: query
        name: no_embed
        required: false
        schema:
          type: boolean
        style: form
      - description: When set to no_sensitive_extras=true, omits sensitive fields and embedded resources from the response.
        explode: false
        in: header
        name: Prefer
        required: false
        schema:
          enum:
          - no_sensitive_extras=true
          type: string
        style: simple
      responses:
        '200':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ListOperationsForPersistentDisk_200_response'
          description: successful
        default:
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response. Often a 4xx or 5xx status code
      summary: list operations
      tags:
      - operations
      security:
      - token: []
  /apps/{app_id}/operations:
    servers:
    - url: '{baseUrl}'
      variables:
        baseUrl:
          default: https://api.aptible.com
          description: Override for local or test environments
    get:
      description: Returns a paginated list of operations for the specified app.
      operationId: ListOperationsForApp
      parameters:
      - description: app_id
        explode: false
        in: path
        name: app_id
        required: true
        schema:
          type: integer
        style: simple
      - description: Current page of paginated results
        explode: true
        in: query
        name: page
        required: false
        schema:
          type: integer
        style: form
      - description: Number of results to return per page
        explode: true
        in: query
        name: per_page
        required: false
        schema:
          type: integer
        style: form
      - description: 'When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present.'
        explode: true
        in: query
        name: no_embed
        required: false
        schema:
          type: boolean
        style: form
      - description: When set to no_sensitive_extras=true, omits sensitive fields and embedded resources from the response.
        explode: false
        in: header
        name: Prefer
        required: false
        schema:
          enum:
          - no_sensitive_extras=true
          type: string
        style: simple
      responses:
        '200':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ListOperationsForPersistentDisk_200_response'
          description: successful
        default:
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response. Often a 4xx or 5xx status code
      summary: list operations
      tags:
      - operations
      security:
      - token: []
    post:
      description: Creates a new operation for the specified app.
      operationId: CreateOperationForApp
      parameters:
      - description: app_id
        explode: false
        in: path
        name: app_id
        required: true
        schema:
          type: integer
        style: simple
      - description: 'When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present.'
        explode: true
        in: query
        name: no_embed
        required: false
        schema:
          type: boolean
        style: form
      - description: When set to no_sensitive_extras=true, omits sensitive fields and embedded resources from the response.
        explode: false
        in: header
        name: Prefer
        required: false
        schema:
          enum:
          - no_sensitive_extras=true
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOperationRequest'
      responses:
        '201':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/operation'
          description: successful
        default:
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response. Often a 4xx or 5xx status code
      summary: create operation
      tags:
      - operations
      security:
      - token: []
  /ephemeral_sessions/{ephemeral_session_id}/operations:
    servers:
    - url: '{baseUrl}'
      variables:
        baseUrl:
          default: https://api.aptible.com
          description: Override for local or test environments
    get:
      description: Returns a paginated list of operations for the specified ephemeral session.
      operationId: ListOperationsForEphemeralSession
      parameters:
      - description: ephemeral_session_id
        explode: false
        in: path
        name: ephemeral_session_id
        required: true
        schema:
          type: integer
        style: simple
      - description: Current page of paginated results
        explode: true
        in: query
        name: page
        required: false
        schema:
          type: integer
        style: form
      - description: Number of results to return per page
        explode: true
        in: query
        name: per_page
        required: false
        schema:
          type: integer
        style: form
      - description: 'When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present.'
        explode: true
        in: query
        name: no_embed
        required: false
        schema:
          type: boolean
        style: form
      - description: When set to no_sensitive_extras=true, omits sensitive fields and embedded resources from the response.
        explode: false
        in: header
        name: Prefer
        required: false
        schema:
          enum:
          - no_sensitive_extras=true
          type: string
        style: simple
      responses:
        '200':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ListOperationsForPersistentDisk_200_response'
          description: successful
        default:
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response. Often a 4xx or 5xx status code
      summary: list operations
      tags:
      - operations
      security:
      - token: []
    post:
      description: Creates a new operation for the specified ephemeral session.
      operationId: CreateOperationForEphemeralSession
      parameters:
      - description: ephemeral_session_id
        explode: false
        in: path
        name: ephemeral_session_id
        required: true
        schema:
          type: integer
        style: simple
      - description: 'When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present.'
        explode: true
        in: query
        name: no_embed
        required: false
        schema:
          type: boolean
        style: form
      - description: When set to no_sensitive_extras=true, omits sensitive fields and embedded resources from the response.
        explode: false
        in: header
        name: Prefer
        required: false
        schema:
          enum:
          - no_sensitive_extras=true
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOperationRequest'
      responses:
        '201':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/operation'
          description: successful
        default:
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response. Often a 4xx or 5xx status code
      summary: create operation
      tags:
      - operations
      security:
      - token: []
  /databases/{database_id}/operations:
    servers:
    - url: '{baseUrl}'
      variables:
        baseUrl:
          default: https://api.aptible.com
          description: Override for local or test environments
    get:
      description: Returns a paginated list of operations for the specified database.
      operationId: ListOperationsForDatabase
      parameters:
      - description: database_id
        explode: false
        in: path
        name: database_id
        required: true
        schema:
          type: integer
        style: simple
      - description: Current page of paginated results
        explode: true
        in: query
        name: page
        required: false
        schema:
          type: integer
        style: form
      - description: Number of results to return per page
        explode: true
        in: query
        name: per_page
        required: false
        schema:
          type: integer
        style: form
      - description: 'When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present.'
        explode: true
        in: query
        name: no_embed
        required: false
        schema:
          type: boolean
        style: form
      - description: When set to no_sensitive_extras=true, omits sensitive fields and embedded resources from the response.
        explode: false
        in: header
        name: Prefer
        required: false
        schema:
          enum:
          - no_sensitive_extras=true
          type: string
        style: simple
      responses:
        '200':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ListOperationsForPersistentDisk_200_response'
          description: successful
        default:
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response. Often a 4xx or 5xx status code
      summary: list operations
      tags:
      - operations
      security:
      - token: []
    post:
      description: Creates a new operation for the specified database.
      operationId: CreateOperationForDatabase
      parameters:
      - description: database_id
        explode: false
        in: path
        name: database_id
        required: true
        schema:
          type: integer
        style: simple
      - description: 'When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present.'
        explode: true
        in: query
        name: no_embed
        required: false
        schema:
          type: boolean
        style: form
      - description: When set to no_sensitive_extras=true, omits sensitive fields and embedded resources from the response.
        explode: false
        in: header
        name: Prefer
        required: false
        schema:
          enum:
          - no_sensitive_extras=true
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOperationRequest'
      responses:
        '201':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/operation'
          description: successful
        default:
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response. Often a 4xx or 5xx status code
      summary: create operation
      tags:
      - operations
      security:
      - token: []
  /database_credentials/{database_credential_id}/operations:
    servers:
    - url: '{baseUrl}'
      variables:
        baseUrl:
          default: https://api.aptible.com
          description: Override for local or test environments
    get:
      description: Returns a paginated list of operations for the specified database credential.
      operationId: ListOperationsForDatabaseCredential
      parameters:
      - description: database_credential_id
        explode: false
        in: path
        name: database_credential_id
        required: true
        schema:
          type: integer
        style: simple
      - description: Current page of paginated results
        explode: true
        in: query
        name: page
        required: false
        schema:
          type: integer
        style: form
      - description: Number of results to return per page
        explode: true
        in: query
        name: per_page
        required: false
        schema:
          type: integer
        style: form
      - description: 'When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present.'
        explode: true
        in: query
        name: no_embed
        required: false
        schema:
          type: boolean
        style: form
      - description: When set to no_sensitive_extras=true, omits sensitive fields and embedded resources from the response.
        explode: false
        in: header
        name: Prefer
        required: false
        schema:
          enum:
          - no_sensitive_extras=true
          type: string
        style: simple
      responses:
        '200':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ListOperationsForPersistentDisk_200_response'
          description: successful
        default:
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response. Often a 4xx or 5xx status code
      summary: list operations
      tags:
      - operations
      security:
      - token: []
    post:
      description: Creates a new operation for the specified database credential.
      operationId: CreateOperationForDatabaseCredential
      parameters:
      - description: database_credential_id
        explode: false
        in: path
        name: database_credential_id
        required: true
        schema:
          type: integer
        style: simple
      - description: 'When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present.'
        explode: true
        in: query
        name: no_embed
        required: false
        schema:
          type: boolean
        style: form
      - description: When set to no_sensitive_extras=true, omits sensitive fields and embedded resources from the response.
        explode: false
        in: header
        name: Prefer
        required: false
        schema:
          enum:
          - no_sensitive_extras=true
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOperationRequest'
      responses:
        '201':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/operation'
          description: successful
        default:
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response. Often a 4xx or 5xx status code
      summary: create operation
      tags:
      - operations
      security:
      - token: []
  /services/{service_id}/operations:
    servers:
    - url: '{baseUrl}'
      variables:
        baseUrl:
          default: https://api.aptible.com
          description: Override for local or test environments
    get:
      description: Returns a paginated list of operations for the specified service.
      operationId: ListOperationsForService
      parameters:
      - description: service_id
        explode: false
        in: path
        name: service_id
        required: true
        schema:
          type: integer
        style: simple
      - description: Current page of paginated results
        explode: true
        in: query
        name: page
        required: false
        schema:
          type: integer
        style: form
      - description: Number of results to return per page
        explode: true
        in: query
        name: per_page
        required: false
        schema:
          type: integer
        style: form
      - description: 'When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present.'
        explode: true
        in: query
        name: no_embed
        required: false
        schema:
          type: boolean
        style: form
      - description: When set to no_sensitive_extras=true, omits sensitive fields and embedded resources from the response.
        explode: false
        in: header
        name: Prefer
        required: false
        schema:
          enum:
          - no_sensitive_extras=true
          type: string
        style: simple
      responses:
        '200':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ListOperationsForPersistentDisk_200_response'
          description: successful
        default:
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response. Often a 4xx or 5xx status code
      summary: list operations
      tags:
      - operations
      security:
      - token: []
    post:
      description: Creates a new operation for the specified service.
      operationId: CreateOperationForService
      parameters:
      - description: service_id
        explode: false
        in: path
        name: service_id
        required: true
        schema:
          type: integer
        style: simple
      - description: 'When true, omits embedded resources from the response. Also triggered when the Prefer: no_sensitive_extras=true header is present.'
        explode: true
        in: query
        name: no_embed
        required: false
        schema:
          type: boolean
        style: form
      - description: When set to no_sensitive_extras=true, omits sensitive fields and embedded resources from the response.
        explode: false
        in: header
        name: Prefer
        required: false
        schema:
          enum:
          - no_sensitive_extras=true
          type: string
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOperationRequest'
      responses:
        '201':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/operation'
          description: successful
        default:
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Error response. Often a 4xx or 5xx status code

# --- truncated at 32 KB (69 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aptible/refs/heads/main/openapi/aptible-operations-api-openapi.yml