Alloy Automation

Alloy Automation Installations API

The Installations API from Alloy Automation — 6 operation(s) for installations.

GitHub OpenAPI

Operations 6

GET /installations/{installationId} Get Installation #
DELETE /installations/{installationId}/ Delete an Installation #
PUT /installations/{installationId}/activate Activate Installation #
PUT /installations/{installationId}/deactivate Deactivate Installation #
PUT /installations/{installationId}/upgrade Upgrade Installation #
GET /installations Get All Installations #

Documentation

📖
APIReference
https://docs.runalloy.com/reference/embedded/get-a-user
📖
APIReference
https://docs.runalloy.com/reference/embedded/generate-jwt-token/
📖
APIReference
https://docs.runalloy.com/reference/get-credential-metadata
📖
Documentation
https://docs.runalloy.com/connectivity-api/quick-start
📖
Documentation
https://docs.runalloy.com/embedded/passthrough-api
📖
Documentation
https://docs.runalloy.com/unified-api/bigcommerce-collection/
📖
APIReference
https://docs.runalloy.com/reference/unified-api/create-account-1/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/alloy-automation/refs/heads/main/openapi/alloy-automation-installations-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/alloy-automation/refs/heads/main/collections/alloy-automation.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/alloy-automation/refs/heads/main/collections/alloy-automation.opencollection.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/alloy-automation:alloy-automation-installations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

alloy-automation-installations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Embedded 2025-09 Installations API
  version: '5.0'
servers:
- url: https://production.runalloy.com
tags:
- name: Installations
paths:
  /installations/{installationId}:
    get:
      summary: Get Installation
      description: Retrieves details for a specific installation.
      operationId: getInstallation
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
          default: bearer YOUR_API_KEY
      - $ref: '#/components/parameters/xApiVersion'
      - name: installationId
        in: path
        required: true
        description: The ID of the installation.
        schema:
          type: string
          example: 6630f0f971184ae724f2d930
      responses:
        '200':
          description: Successful response with installation details.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      installationId:
                        type: string
                        example: 6630f0f971184ae724f2d930
                      integrationId:
                        type: string
                        example: 662f950e454784bc5e7caa37
                      userId:
                        type: string
                        example: 6622cd2e506ac293a3e60b00
                      formData:
                        type: array
                        items:
                          type: object
                        example: []
                      credentialIds:
                        type: object
                        additionalProperties:
                          type: string
                        example:
                          shopifyApi: 66263e318dca4463fe1b480f
                      workflowIds:
                        type: array
                        items:
                          type: string
                        example:
                        - 662fa657454784bc5e7cd5ea
                      enabled:
                        type: boolean
                        example: false
                    required:
                    - installationId
                    - integrationId
                    - userId
                    - formData
                    - credentialIds
                    - workflowIds
                    - enabled
                required:
                - data
              examples:
                Result:
                  value:
                    data:
                      installationId: 6630f0f971184ae724f2d930
                      integrationId: 662f950e454784bc5e7caa37
                      userId: 6622cd2e506ac293a3e60b00
                      formData: []
                      credentialIds:
                        shopifyApi: 66263e318dca4463fe1b480f
                      workflowIds:
                      - 662fa657454784bc5e7cd5ea
                      enabled: false
      tags:
      - Installations
  /installations/{installationId}/:
    delete:
      summary: Delete an Installation
      description: Deletes a specific installation by its ID.
      operationId: deleteInstallation
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
          default: bearer YOUR_API_KEY
      - $ref: '#/components/parameters/xApiVersion'
      - name: installationId
        in: path
        required: true
        description: The ID of the installation.
        schema:
          type: string
          example: 6630f0f971184ae724f2d930
      responses:
        '200':
          description: Successful response after installation deletion.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                required:
                - success
              examples:
                Result:
                  value:
                    success: true
      tags:
      - Installations
  /installations/{installationId}/activate:
    put:
      summary: Activate Installation
      description: Activates a specific installation.
      operationId: activateInstallation
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
          default: bearer YOUR_API_KEY
      - $ref: '#/components/parameters/xApiVersion'
      - name: installationId
        in: path
        required: true
        description: The ID of the installation.
        schema:
          type: string
          example: 6630f0f971184ae724f2d930
      responses:
        '200':
          description: Successful activation response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
      tags:
      - Installations
  /installations/{installationId}/deactivate:
    put:
      summary: Deactivate Installation
      description: Deactivates a specific installation.
      operationId: deactivateInstallation
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
          default: bearer YOUR_API_KEY
      - $ref: '#/components/parameters/xApiVersion'
      - name: installationId
        in: path
        required: true
        description: The ID of the installation.
        schema:
          type: string
          example: 6630f0f971184ae724f2d930
      responses:
        '200':
          description: Successful deactivation response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
      tags:
      - Installations
  /installations/{installationId}/upgrade:
    put:
      summary: Upgrade Installation
      description: Upgrades a specific installation.
      operationId: upgradeInstallation
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
          default: bearer YOUR_API_KEY
      - $ref: '#/components/parameters/xApiVersion'
      - name: installationId
        in: path
        required: true
        description: The ID of the installation.
        schema:
          type: string
          example: 6630f0f971184ae724f2d930
      responses:
        '200':
          description: Successful upgrade response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
      tags:
      - Installations
  /installations:
    get:
      summary: Get All Installations
      description: Retrieves all installations available in the Alloy Embedded account.
      operationId: getAllInstallations
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
          default: bearer YOUR_API_KEY
      - $ref: '#/components/parameters/xApiVersion'
      responses:
        '200':
          description: Successful response with a list of installations.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        installationId:
                          type: string
                          example: 6631155371184ae724f2d949
                        integrationId:
                          type: string
                          example: 662f950e454784bc5e7caa37
                        userId:
                          type: string
                          example: 6622cd2e506ac293a3e60b00
                        formData:
                          type: array
                          items:
                            type: object
                            properties:
                              workflowId:
                                type: string
                                example: 66310999b37a737ba5107d5a
                              app:
                                type: string
                                example: accountVariables
                              blockId:
                                type: string
                                example: f7c4304a-b3d8-4088-8ca3-adeb3ddf2ce4
                              fields:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    name:
                                      type: string
                                      example: variables[0].value
                                    displayName:
                                      type: string
                                      example: Value
                                    type:
                                      type: string
                                      example: string
                                    required:
                                      type: boolean
                                      example: true
                                  required:
                                  - name
                                  - displayName
                                  - type
                                  - required
                            required:
                            - workflowId
                            - app
                            - blockId
                            - fields
                          example: []
                        credentialIds:
                          type: object
                          additionalProperties:
                            type: string
                          example:
                            shopifyApi: 66263e318dca4463fe1b480f
                        workflowIds:
                          type: array
                          items:
                            type: string
                          example:
                          - 662fa657454784bc5e7cd5ea
                        installedAt:
                          type: string
                          format: date-time
                          example: '2024-04-30T16:00:05.041Z'
                        enabled:
                          type: boolean
                          example: false
                      required:
                      - installationId
                      - integrationId
                      - userId
                      - formData
                      - credentialIds
                      - workflowIds
                      - installedAt
                      - enabled
                required:
                - data
              examples:
                Result:
                  value:
                    data:
                    - installationId: 6631155371184ae724f2d949
                      integrationId: 662f950e454784bc5e7caa37
                      userId: 6622cd2e506ac293a3e60b00
                      formData: []
                      credentialIds:
                        shopifyApi: 66263e318dca4463fe1b480f
                      workflowIds:
                      - 662fa657454784bc5e7cd5ea
                      installedAt: '2024-04-30T16:00:05.041Z'
                      enabled: false
                    - installationId: 66322c61182c8c5270980ed3
                      integrationId: 66310993b37a737ba5107d1e
                      userId: 6622cd2e506ac293a3e60b00
                      formData:
                      - workflowId: 66310999b37a737ba5107d5a
                        app: accountVariables
                        blockId: f7c4304a-b3d8-4088-8ca3-adeb3ddf2ce4
                        fields:
                        - name: variables[0].value
                          displayName: Value
                          type: string
                          required: true
                      credentialIds:
                        shopifyApi: 66263e318dca4463fe1b480f
                      workflowIds:
                      - 66310999b37a737ba5107d5a
                      installedAt: '2024-05-01T11:50:14.043Z'
                      enabled: false
      tags:
      - Installations
components:
  parameters:
    xApiVersion:
      name: x-api-version
      in: header
      required: true
      description: The version of the API to use. The current API version is **2025-09**.
      schema:
        type: string
        default: 2025-09
  securitySchemes:
    sec0:
      type: apiKey
      in: header
      name: Authorization
      x-bearer-format: bearer
x-readme:
  headers: []
  explorer-enabled: true
  proxy-enabled: true
x-readme-fauxas: true
x-provenance:
  method: harvested
  publisher: Alloy Automation
  source: https://docs.runalloy.com/openapi/2025-09/embedded/embedded.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)