openapi: 3.2.0
info:
  title: Qliksense Automation Connections API
  version: ''
  description: 'Operations tagged automation-connections across 2 of this provider''s published API definitions: qliksense-automation-connections.json, qliksense-workflows-automation-connections.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{tenant}.{region}.qlikcloud.com
  variables:
    region:
      default: us
      description: The region the tenant is hosted in
    tenant:
      default: your-tenant
      description: Name of the tenant that will be called
tags:
- name: automation-connections
paths:
  /api/v1/automation-connections:
    get:
      tags:
      - automation-connections
      summary: List automation connections
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationConnectionsList'
          description: OK Response
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      parameters:
      - in: query
        name: cursor
        schema:
          type: string
          example: eyJpZCI6NDI4OTQ1LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9
        required: false
        description: Pagination cursor returned from a previous request.
      - in: query
        name: filter
        schema:
          type: string
          example: name eq "My Automation Connection" and connectorId eq "0d87347d-27c0-11ea-921c-022e6b5ea1e2" and ownerId eq "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy" and spaceId eq "5f0f78b239ff4f0001234567"
        required: false
        description: 'Filters the result based on the specified criteria: name, connectorId, ownerId, or spaceId.'
      - in: query
        name: limit
        schema:
          type: integer
          default: 100
          example: 50
          maximum: 200
          minimum: 1
        required: false
        description: The number of automation connections to retrieve.
      - in: query
        name: listAll
        schema:
          type: boolean
          default: false
        required: false
        description: When true, list all connections. Restricted to tenant admins and analytics admins.
      - in: query
        name: sort
        schema:
          enum:
          - id
          - name
          - createdAt
          - updatedAt
          - +id
          - +name
          - +createdAt
          - +updatedAt
          - -id
          - -name
          - -createdAt
          - -updatedAt
          type: string
          default: id
          example: -name
        required: false
        description: The field to sort by, with +- prefix indicating sort order. (`?sort=-name` => sort on the `name` field using descending order).
      description: Retrieves a list of automation connections the requesting user has access to.
      operationId: getAutomationConnections
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-replaced-by:
      - namespace: workflows
        uniqueIdentifier: GET:/workflows/automation-connections
      x-qlik-tier:
        tier: '1'
        limit: 1000
    post:
      tags:
      - automation-connections
      summary: Create an automation connection
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationConnectionDetailObject'
          description: Created
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      description: Creates a new connection object from an automation connector.
      operationId: createAutomationConnection
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutomationConnectionCreationObject'
        required: true
        description: The automation object to create.
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-replaced-by:
      - namespace: workflows
        uniqueIdentifier: POST:/workflows/automation-connections
      x-qlik-tier:
        tier: '2'
        limit: 100
    servers:
    - url: https://{tenant}.{region}.qlikcloud.com
      variables:
        region:
          default: us
          description: The region the tenant is hosted in
        tenant:
          default: your-tenant
          description: Name of the tenant that will be called
  /api/v1/automation-connections/{id}:
    get:
      tags:
      - automation-connections
      summary: Get an automation connection
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationConnectionDetailObject'
          description: OK Response
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      parameters:
      - in: path
        name: id
        schema:
          type: string
          example: d6321ebd-d9e8-48fe-9d86-97dbd473bf60
        required: true
        description: The unique identifier for the automation connection.
      description: Returns details about the specified automation connection.
      operationId: getAutomationConnection
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-replaced-by:
      - namespace: workflows
        uniqueIdentifier: GET:/workflows/automation-connections/{id}
      x-qlik-tier:
        tier: '1'
        limit: 1000
    put:
      tags:
      - automation-connections
      summary: Update an automation connection
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationConnectionDetailObject'
          description: OK Response
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      parameters:
      - in: path
        name: id
        schema:
          type: string
          example: 00000000-0000-0000-0000-000000000000
        required: true
        description: The unique identifier for the automation connection.
      description: Updates the specified properties of an automation connection.
      operationId: updateAutomationConnection
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutomationConnectionPutRequestObject'
        required: true
        description: The automation connection object to update.
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-replaced-by:
      - namespace: workflows
        uniqueIdentifier: PUT:/workflows/automation-connections/{id}
      x-qlik-tier:
        tier: '2'
        limit: 100
    delete:
      tags:
      - automation-connections
      summary: Delete an automation connection
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      parameters:
      - in: path
        name: id
        schema:
          type: string
          example: 00000000-0000-0000-0000-000000000000
        required: true
        description: The unique identifier for the automation connection.
      - in: query
        name: forced
        schema:
          type: boolean
          default: false
        required: false
        description: When true, the automation connection will be deleted regardless of its usage by any automations.
      description: Deletes the specified automation connection.
      operationId: deleteAutomationConnection
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-replaced-by:
      - namespace: workflows
        uniqueIdentifier: DELETE:/workflows/automation-connections/{id}
      x-qlik-tier:
        tier: '2'
        limit: 100
    servers:
    - url: https://{tenant}.{region}.qlikcloud.com
      variables:
        region:
          default: us
          description: The region the tenant is hosted in
        tenant:
          default: your-tenant
          description: Name of the tenant that will be called
  /api/v1/automation-connections/{id}/actions/change-owner:
    post:
      tags:
      - automation-connections
      summary: Change automation connection owner
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      parameters:
      - in: path
        name: id
        schema:
          type: string
          example: 00000000-0000-0000-0000-000000000000
        required: true
        description: The unique identifier for the automation connection.
      description: Changes the owner of an automation connection by specifying a new owner.
      operationId: automationConnectionChangeOwner
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutomationConnectionChangeOwnerObject'
        required: true
        description: The new owner of the automation connection.
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-replaced-by:
      - namespace: workflows
        uniqueIdentifier: POST:/workflows/automation-connections/{id}/actions/change-owner
      x-qlik-tier:
        tier: '2'
        limit: 100
    servers:
    - url: https://{tenant}.{region}.qlikcloud.com
      variables:
        region:
          default: us
          description: The region the tenant is hosted in
        tenant:
          default: your-tenant
          description: Name of the tenant that will be called
  /api/v1/automation-connections/{id}/actions/change-space:
    post:
      tags:
      - automation-connections
      summary: Change automation connection space
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      parameters:
      - in: path
        name: id
        schema:
          type: string
          example: 00000000-0000-0000-0000-000000000000
        required: true
        description: The unique identifier for the automation connection.
      description: Changes the space of an automation connection by specifying a new space.
      operationId: automationConnectionChangeSpace
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutomationConnectionChangeSpaceObject'
        required: true
        description: The new space of the automation connection.
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-replaced-by:
      - namespace: workflows
        uniqueIdentifier: POST:/workflows/automation-connections/{id}/actions/change-space
      x-qlik-tier:
        tier: '2'
        limit: 100
    servers:
    - url: https://{tenant}.{region}.qlikcloud.com
      variables:
        region:
          default: us
          description: The region the tenant is hosted in
        tenant:
          default: your-tenant
          description: Name of the tenant that will be called
  /api/v1/automation-connections/{id}/actions/check:
    post:
      tags:
      - automation-connections
      summary: Check automation connection
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationConnectionCheckObject'
          description: OK Response
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      parameters:
      - in: path
        name: id
        schema:
          type: string
          example: 00000000-0000-0000-0000-000000000000
        required: true
        description: The unique identifier for the automation connection.
      description: Tries to validate and checks the connection status of an automation connection.
      operationId: checkAutomationConnection
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-replaced-by:
      - namespace: workflows
        uniqueIdentifier: POST:/workflows/automation-connections/{id}/actions/check
      x-qlik-tier:
        tier: '2'
        limit: 100
    servers:
    - url: https://{tenant}.{region}.qlikcloud.com
      variables:
        region:
          default: us
          description: The region the tenant is hosted in
        tenant:
          default: your-tenant
          description: Name of the tenant that will be called
  /api/workflows/automation-connections:
    get:
      tags:
      - automation-connections
      summary: List automation connections
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationConnectionsList'
          description: OK Response
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      parameters:
      - in: query
        name: cursor
        schema:
          type: string
          example: eyJpZCI6NDI4OTQ1LCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9
        required: false
        description: Pagination cursor returned from a previous request.
      - in: query
        name: filter
        schema:
          type: string
          example: name eq "My Automation Connection" and connectorId eq "0d87347d-27c0-11ea-921c-022e6b5ea1e2" and ownerId eq "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy" and spaceId eq "5f0f78b239ff4f0001234567"
        required: false
        description: 'Filters the result based on the specified criteria: name, connectorId, ownerId, or spaceId.'
      - in: query
        name: limit
        schema:
          type: integer
          default: 100
          example: 50
          maximum: 200
          minimum: 1
        required: false
        description: The number of automation connections to retrieve.
      - in: query
        name: listAll
        schema:
          type: boolean
          default: false
        required: false
        description: When true, list all connections. Restricted to tenant admins and analytics admins.
      - in: query
        name: sort
        schema:
          enum:
          - id
          - name
          - createdAt
          - updatedAt
          - +id
          - +name
          - +createdAt
          - +updatedAt
          - -id
          - -name
          - -createdAt
          - -updatedAt
          type: string
          default: id
          example: -name
        required: false
        description: The field to sort by, with +- prefix indicating sort order. (`?sort=-name` => sort on the `name` field using descending order).
      description: Retrieves a list of automation connections the requesting user has access to.
      operationId: getApiWorkflowsAutomationConnections
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-replaces:
      - namespace: ''
        uniqueIdentifier: GET:/v1/automation-connections
      x-qlik-tier:
        tier: '1'
        limit: 1000
      x-operation-id-source: normalized
      x-operation-id-original: getAutomationConnections
    post:
      tags:
      - automation-connections
      summary: Create an automation connection
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationConnectionDetailObject'
          description: Created
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      description: Creates a new connection object from an automation connector.
      operationId: postApiWorkflowsAutomationConnections
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutomationConnectionCreationObject'
        required: true
        description: The automation object to create.
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-replaces:
      - namespace: ''
        uniqueIdentifier: POST:/v1/automation-connections
      x-qlik-tier:
        tier: '2'
        limit: 100
      x-operation-id-source: normalized
      x-operation-id-original: createAutomationConnection
    servers:
    - url: https://{tenant}.{region}.qlikcloud.com
      variables:
        region:
          default: us
          description: The region the tenant is hosted in
        tenant:
          default: your-tenant
          description: Name of the tenant that will be called
  /api/workflows/automation-connections/{id}:
    get:
      tags:
      - automation-connections
      summary: Get an automation connection
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationConnectionDetailObject'
          description: OK Response
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      parameters:
      - in: path
        name: id
        schema:
          type: string
          example: d6321ebd-d9e8-48fe-9d86-97dbd473bf60
        required: true
        description: The unique identifier for the automation connection.
      description: Returns details about the specified automation connection.
      operationId: getApiWorkflowsAutomationConnectionsById
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-replaces:
      - namespace: ''
        uniqueIdentifier: GET:/v1/automation-connections/{id}
      x-qlik-tier:
        tier: '1'
        limit: 1000
      x-operation-id-source: normalized
      x-operation-id-original: getAutomationConnection
    put:
      tags:
      - automation-connections
      summary: Update an automation connection
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationConnectionDetailObject'
          description: OK Response
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      parameters:
      - in: path
        name: id
        schema:
          type: string
          example: 00000000-0000-0000-0000-000000000000
          readOnly: true
        required: true
        description: The unique identifier for the automation connection.
      description: Updates the specified properties of an automation connection.
      operationId: putApiWorkflowsAutomationConnectionsById
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutomationConnectionPutRequestObject'
        required: true
        description: The automation connection object to update.
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-replaces:
      - namespace: ''
        uniqueIdentifier: PUT:/v1/automation-connections/{id}
      x-qlik-tier:
        tier: '2'
        limit: 100
      x-operation-id-source: normalized
      x-operation-id-original: updateAutomationConnection
    delete:
      tags:
      - automation-connections
      summary: Delete an automation connection
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      parameters:
      - in: path
        name: id
        schema:
          type: string
          example: 00000000-0000-0000-0000-000000000000
        required: true
        description: The unique identifier for the automation connection.
      - in: query
        name: forced
        schema:
          type: boolean
          default: false
        required: false
        description: When true, the automation connection will be deleted regardless of its usage by any automations.
      description: Deletes the specified automation connection.
      operationId: deleteApiWorkflowsAutomationConnectionsById
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-replaces:
      - namespace: ''
        uniqueIdentifier: DELETE:/v1/automation-connections/{id}
      x-qlik-tier:
        tier: '2'
        limit: 100
      x-operation-id-source: normalized
      x-operation-id-original: deleteAutomationConnection
    servers:
    - url: https://{tenant}.{region}.qlikcloud.com
      variables:
        region:
          default: us
          description: The region the tenant is hosted in
        tenant:
          default: your-tenant
          description: Name of the tenant that will be called
  /api/workflows/automation-connections/{id}/actions/change-owner:
    post:
      tags:
      - automation-connections
      summary: Change automation connection owner
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      parameters:
      - in: path
        name: id
        schema:
          type: string
          example: 00000000-0000-0000-0000-000000000000
        required: true
        description: The unique identifier for the automation connection.
      description: Changes the owner of an automation connection by specifying a new owner.
      operationId: postApiWorkflowsAutomationConnectionsByIdActionsChangeOwner
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutomationConnectionChangeOwnerObject'
        required: true
        description: The new owner of the automation connection.
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-replaces:
      - namespace: ''
        uniqueIdentifier: POST:/v1/automation-connections/{id}/actions/change-owner
      x-qlik-tier:
        tier: '2'
        limit: 100
      x-operation-id-source: normalized
      x-operation-id-original: automationConnectionChangeOwner
    servers:
    - url: https://{tenant}.{region}.qlikcloud.com
      variables:
        region:
          default: us
          description: The region the tenant is hosted in
        tenant:
          default: your-tenant
          description: Name of the tenant that will be called
  /api/workflows/automation-connections/{id}/actions/change-space:
    post:
      tags:
      - automation-connections
      summary: Change automation connection space
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      parameters:
      - in: path
        name: id
        schema:
          type: string
          example: 00000000-0000-0000-0000-000000000000
        required: true
        description: The unique identifier for the automation connection.
      description: Changes the space of an automation connection by specifying a new space.
      operationId: postApiWorkflowsAutomationConnectionsByIdActionsChangeSpace
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutomationConnectionChangeSpaceObject_2'
        required: true
        description: The new space of the automation connection.
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-replaces:
      - namespace: ''
        uniqueIdentifier: POST:/v1/automation-connections/{id}/actions/change-space
      x-qlik-tier:
        tier: '2'
        limit: 100
      x-operation-id-source: normalized
      x-operation-id-original: automationConnectionChangeSpace
    servers:
    - url: https://{tenant}.{region}.qlikcloud.com
      variables:
        region:
          default: us
          description: The region the tenant is hosted in
        tenant:
          default: your-tenant
          description: Name of the tenant that will be called
  /api/workflows/automation-connections/{id}/actions/check:
    post:
      tags:
      - automation-connections
      summary: Check automation connection
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationConnectionCheckObject'
          description: OK Response
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      parameters:
      - in: path
        name: id
        schema:
          type: string
          example: 00000000-0000-0000-0000-000000000000
        required: true
        description: The unique identifier for the automation connection.
      description: Tries to validate and checks the connection status of an automation connection.
      operationId: postApiWorkflowsAutomationConnectionsByIdActionsCheck
      x-qlik-visibility: public
      x-qlik-stability: stable
      x-qlik-deprecated: false
      x-qlik-replaces:
      - namespace: ''
        uniqueIdentifier: POST:/v1/automation-connections/{id}/actions/check
      x-qlik-tier:
        tier: '2'
        limit: 100
      x-operation-id-source: normalized
      x-operation-id-original: checkAutomationConnection
    servers:
    - url: https://{tenant}.{region}.qlikcloud.com
      variables:
        region:
          default: us
          description: The region the tenant is hosted in
        tenant:
          default: your-tenant
          description: Name of the tenant that will be called
components:
  responses:
    BadRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Bad Request
    NotFound:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Not found
    InternalServerError:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Internal Server Error
    Unauthorized:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Unauthorized
    Forbidden:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Forbidden
    ServiceUnavailable:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Service Unavailable
    Conflict:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      description: Conflict with the current state of the resource
  schemas:
    AutomationConnectionsList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AutomationConnectionsListObject'
        links:
          $ref: '#/components/schemas/Links'
    Error:
      type: object
      required:
      - code
      - title
      properties:
        code:
          type: string
          description: The unique code for the error
        title:
          type: string
          description: A summary of what went wrong
        detail:
          type: string
          description: May be used to provide additional details
    AutomationConnectionCreationObject:
      type: object
      required:
      - connectorId
      properties:
        name:
          type: string
          example: connection
          description: The name of the created automation connection.
        params:
          type: array
          items:
            $ref: '#/components/schemas/AutomationConnectionParamCreateObject'
        spaceId:
          type: string
          example: 5f0f78b239ff4f0001234567
          description: The unique identifier of the space in which the automation connection is created.
        connectorId:
          type: string
          example: 3004e850-1985-11ee-b6df-8d800b305320
          description: The unique identifier of the connector from which the automation connection is created.
    AutomationConnectionChangeOwnerObject:
      type: object
      properties:
        userId:
          type: string
          example: sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy
          description: The unique identifier of the new owner.
    AutomationConnectionParamObject:
      type: object
      properties:
        id:
          type: string
          example: 39a90780-8874-11ee-b16c-89512345678
          description: The unique identifier of the automation connection parameter.
        meta:
          type: array
          items: {}
          description: The metadata of the automation connection parameter.
        name:
          type: string
          example: region
          description: The name of the automation connection parameter.
        order:
          type: integer
          example: 1
          description: The order that the automation connection configuration fields should be displayed in.
        value:
          type: string
          description: The value of the automation connection parameter.
        fieldType:
          type: string
          example: enum
          description: The field type of the automation connection parameter.
        isOptional:
          type: boolean
          example: 'false'
          description: When true, the parameter is optional.
        exampleValue:
          type: string
          description: The example value of the automation connection parameter.
        paramOptions:
          type: array
          items:
            $ref: '#/components/schemas/AutomationConnectionParamOptionObject'
        documentation:
          type: string
          description: The documentation of the automation connection parameter.
    AutomationConnectionDetailObject:
      type: object
      properties:
        id:
          type: string
          example: e0e720d0-4947-11ec-a1d2-9559fa35801d
          description: The unique identifier of the automation connection.
        name:
          type: string
          example: connection
          description: The name of the automation connection.
        error:
          type: object
          description: This contains the error message if a connection is being created with an issue.
        params:
          type: array
          items:
            $ref: '#/components/schemas/AutomationConnectionParamObject'
        ownerId:
          type: string
          example: sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy
          description: The unique identifier of the owner of the automation connection.
        spaceId:
          type: string
          example: 5f0f78b239ff4f0001234567
          description: The space ID of the automation connection.
        redirect:
          type: string
          description: The redirect of the OAuth account.
        createdAt:
          type: string
          format: date-time
          example: '2021-12-23T12:28:21.000000Z'
          description: The timestamp when the automation connection was created.
        updatedAt:
          type: string
          format: date-time
          example: '2021-12-23T12:28:21.000000Z'
          description: The timestamp when the automation connection was updated.
        connectorId:
          type: string
          example: e0e720d0-4947-11ec-a1d2-9559fa35801d
          description: The unique identifier of the automation connector.
        isConnected:
          type: boolean
          example: true
          description: The connection status of the automation connection. When true, the automation connection is connected.
        oauthAccountName:
          type: string
          example: oauth
          description: The name of the OAuth account associated with the automation connection.
    PaginationLink:
      properties:
        href:
          type:
          - string
          - 'null'
          description: The URL to a resource request
    AutomationConnectionParamPutObject:
      type: object
      properties:
        id:
          type: string
          example: 39a90780-8874-11ee-b16c-89512345678
          description: The unique identifier of the automation connection parameter option.
        value:
          type: string
          description: The value of the automation connection parameter option.
    Links:
      properties:
        next:
          $ref: '#/components/schemas/PaginationLink'
        prev:
          $ref: '#/components/schemas/PaginationLink'
    ErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        traceId:
          type: string
          description: A way to trace the source of the error.
    AutomationConnectionCheckObject:
      type: object
      properties:
        connected:
          type: boolean
          description: The connection status of the automation connection. When true, the automation connection is connected.
        is_connected:
          type: boolean
          description: The connection status of the automation connection. When true, the automation connection is connected.
    AutomationConnectionChangeSpaceObject:
      type: object
      properties:
        spaceId:
          type: string
          example: 5f0f78b239ff4f0001234567
          description: The unique identifier of the new space.
    AutomationConnectionsListObject:
      type: object
      properties:
        id:
          type: string
          example: e0e720d0-4947-11ec-a1d2-9559fa35801d
          description: The unique identifier of an automation connection.
        name:
          type: string
          example: auto conn
          description: The name of an automation connection.
          x-qlik-filterable: true
        ownerId:
          type: string
          example: sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy
          description: The unique identifier of the owner of the automation connection.
          x-qlik-filterable: true
        spaceId:
          type: string
          example: 5f0f78b239ff4f0001234567
          description: The space ID of the automation connection.
          x-qlik-filterable: true
        createdAt:
          type: string
          format: date-time
          example: '2021-12-23T12:28:21.000000Z'
          description: The timestamp when the automation connection is created.
        updatedAt:
          type: string
          format: date-time
          example: '2021-12-23T12:28:21.000000Z'
          description: The timestamp when the automation connection is updated.
        connectorId:
          type: string
          example: e0e720d0-4947-11ec-a1d2-9559fa35801d
          description: The unique identifier of the connector the automation connection is created from.
          x-qlik-filterable: true
        isConnected:
          type: boolean
          example: true
          description: Returns true if the automtion connection is connected.
    AutomationConnectionParamOptionObject:
      type: object
      properties:
        id:
          type: string
          example: 39a90780-8874-11ee-b16c-89512345678
          description: The unique identifier of the automation connection parameter option.
        value:
          type: string
          description: The value of the automation connection parameter option.
    AutomationConnectionPutRequestObject:
      type: object
      properties:
        name:
          type: string
          example: connection
          description: The new name of the automation connection to be renamed to.
        params:
          type: array
          items:
            $ref: '#/components/schemas/AutomationConnectionParamPutObject'
    AutomationConnectionParamCreateObject:
      type: object
      properties:
        name:
          type: string
          example: username
          description: The name of the automation connection parameter.
        value:
          type: string
          description: The value of the automation connection parameter option.
    AutomationConnectionParamPutObject_2:
      type: object
      properties:
        id:
          type: string
          example: 39a90780-8874-11ee-b16c-89512345678
          description: The unique identifier of the automation connection parameter option.
        value:
          type: string
          example: '100'
          description: The value of the automation connection parameter option.
    AutomationConnectionChangeSpaceObject_2:
      type: object
      properties:
        spaceId:
          type: string
          example: 5f0f78b239ff4f0001234567
          description: The unique identifier of the new space. Leave empty to move to the owner's personal space.
    AutomationConnectionParamCreateObject_2:
      type: object
      properties:
        name:
          type: string
          example: username
          description: The name of the automation connection parameter.
        value:
          type: string
          example: example-username
          description: The value of the automation connection parameter option.
x-refined-from:
- qliksense-automation-connections.json
- qliksense-workflows-automation-connections.json