PixieBrix

PixieBrix Deployments API

The deployments API from PixieBrix — 19 operation(s) for deployments.

GitHub OpenAPI

Operations 30

GET /api/deployments/ List user heartbeats #
POST /api/deployments/ Telemetry list user heartbeat #
GET /api/deployments/dependencies/ Retrieve deployment dependencies batch #
GET /api/deployments/{id}/ Retrieve deployment detail #
PUT /api/deployments/{id}/ Update deployment detail #
PATCH /api/deployments/{id}/ Partial update deployment detail #
DELETE /api/deployments/{id}/ Destroy deployment detail #
GET /api/deployments/{deployment_pk}/dependencies/ Retrieve deployment dependencies #
GET /api/deployments/{deployment_pk}/reports/ List deployment report metadata #
GET /api/deployments/{deployment_pk}/reports/{id}/ Retrieve deployment report #
GET /api/deployments/{deployment_pk}/reports/{report_pk}/jobs/{id}/ Retrieve deployment report job #
GET /api/deployments/{deployment_pk}/users/ List active deployment groups #
GET /api/deployments/{deployment_pk}/errors/ List deployment errors #
DELETE /api/deployments/{deployment_pk}/errors/ Destroy deployment errors #
GET /api/deployments/{deployment_pk}/groups/ List deployment permissions #
POST /api/deployments/{deployment_pk}/groups/ Create deployment permission #
GET /api/deployments/{deployment_pk}/managers/ List deployment manager permissions #
POST /api/deployments/{deployment_pk}/managers/ Create deployment manager permission #
GET /api/deployments/{deployment_pk}/contacts/ List deployment alert emails #
POST /api/deployments/{deployment_pk}/contacts/ Create deployment alert email #
GET /api/deployments/{deployment_pk}/contacts/{id}/ Retrieve deployment alert email #
PUT /api/deployments/{deployment_pk}/contacts/{id}/ Update deployment alert email #
PATCH /api/deployments/{deployment_pk}/contacts/{id}/ Partial update deployment alert email #
DELETE /api/deployments/{deployment_pk}/contacts/{id}/ Destroy deployment alert email #
POST /api/deployments/{deployment_pk}/messages/ Create deployment message #
POST /api/deployments/{deployment_pk}/reports/{report_pk}/jobs/ Create deployment report job #
POST /api/deployments/{deployment_pk}/alerts/ Create deployment alert #
PUT /api/deployments/{deployment_pk}/my-bindings/ Update user deployment bindings #
DELETE /api/deployments/{deployment_pk}/groups/{id}/ Destroy deployment permission #
DELETE /api/deployments/{deployment_pk}/managers/{id}/ Destroy deployment manager permission #

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://raw.githubusercontent.com/api-evangelist/pixiebrix/refs/heads/main/authentication/pixiebrix-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/pixiebrix/refs/heads/main/rate-limits/pixiebrix-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/pixiebrix/refs/heads/main/openapi/pixiebrix-deployments-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/pixiebrix/refs/heads/main/conventions/pixiebrix-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/pixiebrix/refs/heads/main/errors/pixiebrix-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/pixiebrix/refs/heads/main/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-deployments-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-deployments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: PixieBrix Deployments 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:


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