How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
PixieBrix

PixieBrix Deployments API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

PixieBrix Deployments API is one of 31 APIs that PixieBrix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Deployment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 30 operations across 19 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://app.pixiebrix.com.

30 operations 19 paths 14 schemas 5 DELETE13 GET2 PATCH7 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://app.pixiebrix.com/api/
Contact
PixieBrix Support
Resource Areas
1

Paths & Operations 30

Across 19 paths, the API surfaces 30 operations — 5 DELETE, 13 GET, 2 PATCH, 7 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

deployments 30
GET
/api/deployments/
View for individual users to report/retrieve available deployments.
listUserHeartbeats 3 params → 200
POST
/api/deployments/
Record which deployments the user has installed, and return list of available deployments.
telemetryListUserHeartbeat 1 param body → 201
GET
/api/deployments/dependencies/
Batched transitive dependencies for deployments (heartbeat registry eviction).
retrieveDeploymentDependenciesBatch 1 param → 200
GET
/api/deployments/{id}/
View for admins to get/update/delete a single deployment.
retrieveDeploymentDetail 1 param → 200
PUT
/api/deployments/{id}/
View for admins to get/update/delete a single deployment.
updateDeploymentDetail 1 param body → 200
PATCH
/api/deployments/{id}/
View for admins to get/update/delete a single deployment.
partialUpdateDeploymentDetail 1 param body → 200
DELETE
/api/deployments/{id}/
View for admins to get/update/delete a single deployment.
destroyDeploymentDetail 1 param → 204
GET
/api/deployments/{deployment_pk}/dependencies/
Return the dependency tree for a single deployment, rooted at the deployment and including its package's transitive package dependencies and any attached databases.
retrieveDeploymentDependencies 1 param → 200
GET
/api/deployments/{deployment_pk}/reports/
Return the metadata for the reports configured on a deployment.
listDeploymentReportMetadata 1 param → 200
GET
/api/deployments/{deployment_pk}/reports/{id}/
Return a single deployment report including the telemetry data from its most recent successful generation run.
retrieveDeploymentReport 2 params → 200
GET
/api/deployments/{deployment_pk}/reports/{report_pk}/jobs/{id}/
Return the status and result of a single report-generation job for a deployment report.
retrieveDeploymentReportJob 3 params → 200
GET
/api/deployments/{deployment_pk}/users/
Return the users who currently have a deployment active, each with their latest installed mod and extension versions and the version history they have run.
listActiveDeploymentGroups 1 param → 200
GET
/api/deployments/{deployment_pk}/errors/
Return recent error telemetry for a single deployment, grouped by error.
listDeploymentErrors 1 param → 200
DELETE
/api/deployments/{deployment_pk}/errors/
Delete all error telemetry recorded for a single deployment, returning no content.
destroyDeploymentErrors 1 param → 204
GET
/api/deployments/{deployment_pk}/groups/
Return the groups granted permission to a deployment.
listDeploymentPermissions 3 params → 200
POST
/api/deployments/{deployment_pk}/groups/
Grant a group permission to a deployment so its members receive the deployment.
createDeploymentPermission 1 param body → 201
GET
/api/deployments/{deployment_pk}/managers/
Return the groups granted manager permission over a deployment.
listDeploymentManagerPermissions 3 params → 200
POST
/api/deployments/{deployment_pk}/managers/
Grant a group manager permission over a deployment.
createDeploymentManagerPermission 1 param body → 201
GET
/api/deployments/{deployment_pk}/contacts/
Return the alert-notification contact emails configured for a deployment.
listDeploymentAlertEmails 1 param → 200
POST
/api/deployments/{deployment_pk}/contacts/
Add an alert-notification contact email to a deployment.
createDeploymentAlertEmail 1 param body → 201
GET
/api/deployments/{deployment_pk}/contacts/{id}/
Return a single alert-notification contact email for a deployment.
retrieveDeploymentAlertEmail 2 params → 200
PUT
/api/deployments/{deployment_pk}/contacts/{id}/
Replace an existing alert-notification contact email for a deployment.
updateDeploymentAlertEmail 2 params body → 200
PATCH
/api/deployments/{deployment_pk}/contacts/{id}/
Partially update an existing alert-notification contact email for a deployment.
partialUpdateDeploymentAlertEmail 2 params body → 200
DELETE
/api/deployments/{deployment_pk}/contacts/{id}/
Remove an alert-notification contact email from a deployment.
destroyDeploymentAlertEmail 2 params → 204
POST
/api/deployments/{deployment_pk}/messages/
Send an email message about a deployment to a specified recipient on behalf of the current user.
createDeploymentMessage 1 param body → 201
POST
/api/deployments/{deployment_pk}/reports/{report_pk}/jobs/
Start a background job to generate a deployment report's telemetry data, returning the new job or redirecting to one already in progress.
createDeploymentReportJob 2 params body → 201
POST
/api/deployments/{deployment_pk}/alerts/
Send an alert email about a deployment to its configured error-notification contacts.
createDeploymentAlert 1 param body → 201
PUT
/api/deployments/{deployment_pk}/my-bindings/
View for end-users to upsert their personal deployment auth bindings.
updateUserDeploymentBindings 1 param body → 200
DELETE
/api/deployments/{deployment_pk}/groups/{id}/
Revoke a group's permission to a deployment.
destroyDeploymentPermission 2 params → 204
DELETE
/api/deployments/{deployment_pk}/managers/{id}/
Revoke a group's manager permission over a deployment.
destroyDeploymentManagerPermission 2 params → 204

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Deployment (14 properties), ErrorItemGroup (13 properties), DeploymentDetail (13 properties), DependencyTree (5 properties). Each schema is shown below with its type and property counts.

DeploymentAlertEmail
object
4 properties 1 required
DeploymentDetail
object
13 properties 4 required
DeploymentMessage
object
3 properties 3 required
DeploymentManagerPermission
object
4 properties 1 required
DeploymentPermission
object
4 properties 1 required
ActiveDeploymentGroup
object
4 properties 4 required
DependencyTree
object
5 properties 5 required
ErrorItemGroup
object
13 properties 10 required
DeploymentReportMetadata
object
3 properties 3 required
Deployment
object
14 properties 3 required
Job
object
2 properties 1 required
DeploymentReport
object
4 properties 4 required
DeploymentTelemetry
object
4 properties 2 required
DeploymentDependenciesBatch
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pixiebrix-deployments-api-openapi.yml Raw ↑

Other APIs PixieBrix publishes across the network.

PixieBrix Activity API
AE Profile APIs.io
PixieBrix Audit API
AE Profile APIs.io
PixieBrix Bricks API
AE Profile APIs.io
PixieBrix Campaigns API
AE Profile APIs.io
PixieBrix Config API
AE Profile APIs.io
PixieBrix Control Rooms API
AE Profile APIs.io
PixieBrix Copilot API
AE Profile APIs.io
PixieBrix Databases API
AE Profile APIs.io
PixieBrix Events API
AE Profile APIs.io
PixieBrix Groups API
AE Profile APIs.io
PixieBrix Health API
AE Profile APIs.io
PixieBrix Identify API
AE Profile APIs.io
#Deployment
← Back to P APIs
API Details
ID
pixiebrix:pixiebrix-deployments-api
Base URL
https://app.pixiebrix.com/api/
Docs
https://docs.pixiebrix.com/developer-api
Provider
PixieBrix
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=pixiebrix-deployments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/pixiebrix-deployments-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of PixieBrix Deployments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.