PixieBrix

PixieBrix Pipelines API

The pipelines API from PixieBrix — 2 operation(s) for pipelines.

GitHub OpenAPI

Operations 2

GET /api/pipelines/ List package promotion pipelines #
POST /api/pipelines/{id}/promote/ Promote package promotion pipeline #

Documentation

📖
Documentation
https://docs.pixiebrix.com/developer-api
📖
APIReference
https://app.pixiebrix.com/api/docs/
📖
GettingStarted
https://docs.pixiebrix.com/developer-api/making-an-api-request
📖
Authentication
https://artifacts.apis.io/pixiebrix/authentication/pixiebrix-authentication.yml
📖
RateLimits
https://artifacts.apis.io/pixiebrix/rate-limits/pixiebrix-rate-limits.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/pixiebrix/openapi/pixiebrix-pipelines-api-openapi.yml

Other Resources

🔗
Conventions
https://artifacts.apis.io/pixiebrix/conventions/pixiebrix-conventions.yml
🔗
ErrorCatalog
https://artifacts.apis.io/pixiebrix/errors/pixiebrix-problem-types.yml
🔗
DataModel
https://artifacts.apis.io/pixiebrix/data-model/pixiebrix-data-model.yml

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/pixiebrix:pixiebrix-pipelines-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

pixiebrix-pipelines-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: PixieBrix Pipelines API
  version: 1.0.0
  description: PixieBrix admin and package registry API
  contact:
    name: PixieBrix Support
    email: support@pixiebrix.com
servers:
- url: https://app.pixiebrix.com
tags:
- name: Pipelines
paths:
  /api/pipelines/:
    get:
      operationId: listPackagePromotionPipelines
      description: Return the package promotion pipelines you administer, each linking a source package to a target package so versions can be copied between them.
      parameters: []
      responses:
        '200':
          content:
            application/json; version=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PackagePromotionPipeline'
            application/vnd.pixiebrix.api+json; version=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PackagePromotionPipeline'
          description: ''
      tags:
      - Pipelines
      summary: List package promotion pipelines
      x-summary-source: derived
  /api/pipelines/{id}/promote/:
    post:
      operationId: promotePackagePromotionPipeline
      description: Copy a specified version of the pipeline's source package to its target package, publishing it as a new version with the provided commit message.
      parameters:
      - name: id
        in: path
        required: true
        description: ''
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackagePromotionPipeline'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PackagePromotionPipeline'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PackagePromotionPipeline'
      responses:
        '201':
          content:
            application/json; version=1.0:
              schema:
                $ref: '#/components/schemas/PackagePromotionPipeline'
            application/vnd.pixiebrix.api+json; version=1.0:
              schema:
                $ref: '#/components/schemas/PackagePromotionPipeline'
          description: ''
      tags:
      - Pipelines
      summary: Promote package promotion pipeline
      x-summary-source: derived
components:
  schemas:
    PackagePromotionPipeline:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          description: Surrogate primary key
        name:
          type: string
          description: Used to visually identify the promotion pipeline. Must be formatted as the collection and name parts of the target and source package registry ids, e.g. foo/bar
          pattern: ^((?<collection>[a-z0-9-~][a-z0-9-._~]*)/)?(?<name>[a-z0-9-~][a-z0-9-._~]*)$
          maxLength: 255
        source:
          type: object
          properties:
            id:
              type: string
              format: uuid
              readOnly: true
              description: Surrogate primary key
            name:
              type: string
              readOnly: true
            kind:
              type: string
            version:
              type: string
              readOnly: true
            share_dependencies:
              type: boolean
              writeOnly: true
              default: false
            config:
              type: string
            public:
              type: boolean
              default: false
            organizations:
              type: array
              items:
                type: string
            owner_organization:
              type: string
              readOnly: true
            message:
              type: string
            updated_at:
              type: string
              format: date-time
              readOnly: true
            verbose_name:
              type:
              - string
              - 'null'
              description: Human-readable name
              maxLength: 128
            is_locked:
              type: boolean
              readOnly: true
            lock_owner:
              type: object
              properties:
                user:
                  type: object
                  properties:
                    id:
                      type: string
                      format: uuid
                      readOnly: true
                    email:
                      type: string
                      format: email
                      maxLength: 254
                created_at:
                  type: string
                  format: date-time
                  readOnly: true
              required:
              - user
              readOnly: true
          required:
          - kind
          - config
        target:
          type: object
          properties:
            id:
              type: string
              format: uuid
              readOnly: true
              description: Surrogate primary key
            name:
              type: string
              readOnly: true
            kind:
              type: string
            version:
              type: string
              readOnly: true
            share_dependencies:
              type: boolean
              writeOnly: true
              default: false
            config:
              type: string
            public:
              type: boolean
              default: false
            organizations:
              type: array
              items:
                type: string
            owner_organization:
              type: string
              readOnly: true
            message:
              type: string
            updated_at:
              type: string
              format: date-time
              readOnly: true
            verbose_name:
              type:
              - string
              - 'null'
              description: Human-readable name
              maxLength: 128
            is_locked:
              type: boolean
              readOnly: true
            lock_owner:
              type: object
              properties:
                user:
                  type: object
                  properties:
                    id:
                      type: string
                      format: uuid
                      readOnly: true
                    email:
                      type: string
                      format: email
                      maxLength: 254
                created_at:
                  type: string
                  format: date-time
                  readOnly: true
              required:
              - user
              readOnly: true
          required:
          - kind
          - config
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
      - name
      - source
      - target
x-provenance:
  method: harvested
  publisher: PixieBrix
  source: https://app.pixiebrix.com/api/openapi/
  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)