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-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:
- name: Deployments
paths:
  /api/deployments/:
    get:
      operationId: listUserHeartbeats
      description: View for individual users to report/retrieve available deployments.
      parameters:
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: platforms
        required: false
        in: query
        description: Comma-separated or repeated platform names. Defaults to 'webextension'.
        schema:
          type: string
          default: webextension
      responses:
        '200':
          content:
            application/json; version=1.1:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Deployment'
            application/vnd.pixiebrix.api+json; version=1.1:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Deployment'
          description: ''
          headers:
            Link:
              schema:
                type: string
              example: '<https://app.pixiebrix.com/deployments/>; rel="first", <https://app.pixiebrix.com/deployments/?page=3>; rel="prev", <https://app.pixiebrix.com/deployments/?page=5>; rel="next", <https://app.pixiebrix.com/deployments/?page=11>; rel="last"'
              description: See https://datatracker.ietf.org/doc/html/rfc8288 for more information.
      tags:
      - Deployments
      summary: List user heartbeats
      x-summary-source: derived
    post:
      operationId: telemetryListUserHeartbeat
      description: Record which deployments the user has installed, and return list of available deployments.
      parameters:
      - name: platforms
        required: false
        in: query
        description: Comma-separated or repeated platform names. Defaults to 'webextension'.
        schema:
          type: string
          default: webextension
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentTelemetry'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DeploymentTelemetry'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DeploymentTelemetry'
      responses:
        '201':
          content:
            application/json; version=1.1:
              schema:
                $ref: '#/components/schemas/Deployment'
            application/vnd.pixiebrix.api+json; version=1.1:
              schema:
                $ref: '#/components/schemas/Deployment'
          description: ''
      tags:
      - Deployments
      summary: Telemetry list user heartbeat
      x-summary-source: derived
  /api/deployments/dependencies/:
    get:
      operationId: retrieveDeploymentDependenciesBatch
      description: Batched transitive dependencies for deployments (heartbeat registry eviction).
      parameters:
      - name: ids
        in: query
        required: true
        description: Comma-separated deployment UUIDs (at least one valid UUID required). Deployments the caller cannot see are skipped. The response is a single merged list of dependencies across all requested deployments that are visible, deduplicated by (package id, version).
        schema:
          type: string
      responses:
        '200':
          content:
            application/json; version=1.0:
              schema:
                $ref: '#/components/schemas/DeploymentDependenciesBatch'
            application/vnd.pixiebrix.api+json; version=1.0:
              schema:
                $ref: '#/components/schemas/DeploymentDependenciesBatch'
          description: ''
      tags:
      - Deployments
      summary: Retrieve deployment dependencies batch
      x-summary-source: derived
  /api/deployments/{id}/:
    get:
      operationId: retrieveDeploymentDetail
      description: View for admins to get/update/delete a single deployment.
      parameters:
      - name: id
        in: path
        required: true
        description: ''
        schema:
          type: string
      responses:
        '200':
          content:
            application/json; version=1.0:
              schema:
                $ref: '#/components/schemas/DeploymentDetail'
            application/vnd.pixiebrix.api+json; version=1.0:
              schema:
                $ref: '#/components/schemas/DeploymentDetail'
          description: ''
      tags:
      - Deployments
      summary: Retrieve deployment detail
      x-summary-source: derived
    put:
      operationId: updateDeploymentDetail
      description: View for admins to get/update/delete a single deployment.
      parameters:
      - name: id
        in: path
        required: true
        description: ''
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentDetail'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DeploymentDetail'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DeploymentDetail'
      responses:
        '200':
          content:
            application/json; version=1.0:
              schema:
                $ref: '#/components/schemas/DeploymentDetail'
            application/vnd.pixiebrix.api+json; version=1.0:
              schema:
                $ref: '#/components/schemas/DeploymentDetail'
          description: ''
      tags:
      - Deployments
      summary: Update deployment detail
      x-summary-source: derived
    patch:
      operationId: partialUpdateDeploymentDetail
      description: View for admins to get/update/delete a single deployment.
      parameters:
      - name: id
        in: path
        required: true
        description: ''
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentDetail'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DeploymentDetail'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DeploymentDetail'
      responses:
        '200':
          content:
            application/json; version=1.0:
              schema:
                $ref: '#/components/schemas/DeploymentDetail'
            application/vnd.pixiebrix.api+json; version=1.0:
              schema:
                $ref: '#/components/schemas/DeploymentDetail'
          description: ''
      tags:
      - Deployments
      summary: Partial update deployment detail
      x-summary-source: derived
    delete:
      operationId: destroyDeploymentDetail
      description: View for admins to get/update/delete a single deployment.
      parameters:
      - name: id
        in: path
        required: true
        description: ''
        schema:
          type: string
      responses:
        '204':
          description: ''
      tags:
      - Deployments
      summary: Destroy deployment detail
      x-summary-source: derived
  /api/deployments/{deployment_pk}/dependencies/:
    get:
      operationId: retrieveDeploymentDependencies
      description: Return the dependency tree for a single deployment, rooted at the deployment and including its package's transitive package dependencies and any attached databases.
      parameters:
      - name: deployment_pk
        in: path
        required: true
        description: ''
        schema:
          type: string
      responses:
        '200':
          content:
            application/json; version=1.0:
              schema:
                $ref: '#/components/schemas/DependencyTree'
            application/vnd.pixiebrix.api+json; version=1.0:
              schema:
                $ref: '#/components/schemas/DependencyTree'
          description: ''
      tags:
      - Deployments
      summary: Retrieve deployment dependencies
      x-summary-source: derived
  /api/deployments/{deployment_pk}/reports/:
    get:
      operationId: listDeploymentReportMetadata
      description: Return the metadata for the reports configured on a deployment.
      parameters:
      - name: deployment_pk
        in: path
        required: true
        description: ''
        schema:
          type: string
      responses:
        '200':
          content:
            application/json; version=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DeploymentReportMetadata'
            text/csv; version=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DeploymentReportMetadata'
          description: ''
      tags:
      - Deployments
      summary: List deployment report metadata
      x-summary-source: derived
  /api/deployments/{deployment_pk}/reports/{id}/:
    get:
      operationId: retrieveDeploymentReport
      description: Return a single deployment report including the telemetry data from its most recent successful generation run.
      parameters:
      - name: deployment_pk
        in: path
        required: true
        description: ''
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: ''
        schema:
          type: string
      responses:
        '200':
          content:
            application/json; version=1.0:
              schema:
                $ref: '#/components/schemas/DeploymentReport'
            text/csv; version=1.0:
              schema:
                $ref: '#/components/schemas/DeploymentReport'
          description: ''
      tags:
      - Deployments
      summary: Retrieve deployment report
      x-summary-source: derived
  /api/deployments/{deployment_pk}/reports/{report_pk}/jobs/{id}/:
    get:
      operationId: retrieveDeploymentReportJob
      description: Return the status and result of a single report-generation job for a deployment report.
      parameters:
      - name: deployment_pk
        in: path
        required: true
        description: ''
        schema:
          type: string
      - name: report_pk
        in: path
        required: true
        description: ''
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: ''
        schema:
          type: string
      responses:
        '200':
          content:
            application/json; version=1.0:
              schema:
                $ref: '#/components/schemas/Job'
            application/vnd.pixiebrix.api+json; version=1.0:
              schema:
                $ref: '#/components/schemas/Job'
          description: ''
      tags:
      - Deployments
      summary: Retrieve deployment report job
      x-summary-source: derived
  /api/deployments/{deployment_pk}/users/:
    get:
      operationId: listActiveDeploymentGroups
      description: 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.
      parameters:
      - name: deployment_pk
        in: path
        required: true
        description: ''
        schema:
          type: string
      responses:
        '200':
          content:
            application/json; version=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ActiveDeploymentGroup'
            application/vnd.pixiebrix.api+json; version=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ActiveDeploymentGroup'
          description: ''
      tags:
      - Deployments
      summary: List active deployment groups
      x-summary-source: derived
  /api/deployments/{deployment_pk}/errors/:
    get:
      operationId: listDeploymentErrors
      description: Return recent error telemetry for a single deployment, grouped by error.
      parameters:
      - name: deployment_pk
        in: path
        required: true
        description: ''
        schema:
          type: string
      responses:
        '200':
          content:
            application/json; version=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorItemGroup'
            application/vnd.pixiebrix.api+json; version=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ErrorItemGroup'
          description: ''
      tags:
      - Deployments
      summary: List deployment errors
      x-summary-source: derived
    delete:
      operationId: destroyDeploymentErrors
      description: Delete all error telemetry recorded for a single deployment, returning no content.
      parameters:
      - name: deployment_pk
        in: path
        required: true
        description: ''
        schema:
          type: string
      responses:
        '204':
          description: ''
      tags:
      - Deployments
      summary: Destroy deployment errors
      x-summary-source: derived
  /api/deployments/{deployment_pk}/groups/:
    get:
      operationId: listDeploymentPermissions
      description: Return the groups granted permission to a deployment.
      parameters:
      - name: deployment_pk
        in: path
        required: true
        description: ''
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json; version=2.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DeploymentPermission'
            application/vnd.pixiebrix.api+json; version=2.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DeploymentPermission'
          description: ''
          headers:
            Link:
              schema:
                type: string
              example: '<https://app.pixiebrix.com/deployments/{deployment_pk}/groups/>; rel="first", <https://app.pixiebrix.com/deployments/{deployment_pk}/groups/?page=3>; rel="prev", <https://app.pixiebrix.com/deployments/{deployment_pk}/groups/?page=5>; rel="next", <https://app.pixiebrix.com/deployments/{deployment_pk}/groups/?page=11>; rel="last"'
              description: See https://datatracker.ietf.org/doc/html/rfc8288 for more information.
      tags:
      - Deployments
      summary: List deployment permissions
      x-summary-source: derived
    post:
      operationId: createDeploymentPermission
      description: Grant a group permission to a deployment so its members receive the deployment.
      parameters:
      - name: deployment_pk
        in: path
        required: true
        description: ''
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentPermission'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DeploymentPermission'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DeploymentPermission'
      responses:
        '201':
          content:
            application/json; version=2.0:
              schema:
                $ref: '#/components/schemas/DeploymentPermission'
            application/vnd.pixiebrix.api+json; version=2.0:
              schema:
                $ref: '#/components/schemas/DeploymentPermission'
          description: ''
      tags:
      - Deployments
      summary: Create deployment permission
      x-summary-source: derived
  /api/deployments/{deployment_pk}/managers/:
    get:
      operationId: listDeploymentManagerPermissions
      description: Return the groups granted manager permission over a deployment.
      parameters:
      - name: deployment_pk
        in: path
        required: true
        description: ''
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json; version=2.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DeploymentManagerPermission'
            application/vnd.pixiebrix.api+json; version=2.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DeploymentManagerPermission'
          description: ''
          headers:
            Link:
              schema:
                type: string
              example: '<https://app.pixiebrix.com/deployments/{deployment_pk}/managers/>; rel="first", <https://app.pixiebrix.com/deployments/{deployment_pk}/managers/?page=3>; rel="prev", <https://app.pixiebrix.com/deployments/{deployment_pk}/managers/?page=5>; rel="next", <https://app.pixiebrix.com/deployments/{deployment_pk}/managers/?page=11>; rel="last"'
              description: See https://datatracker.ietf.org/doc/html/rfc8288 for more information.
      tags:
      - Deployments
      summary: List deployment manager permissions
      x-summary-source: derived
    post:
      operationId: createDeploymentManagerPermission
      description: Grant a group manager permission over a deployment.
      parameters:
      - name: deployment_pk
        in: path
        required: true
        description: ''
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentManagerPermission'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DeploymentManagerPermission'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DeploymentManagerPermission'
      responses:
        '201':
          content:
            application/json; version=2.0:
              schema:
                $ref: '#/components/schemas/DeploymentManagerPermission'
            application/vnd.pixiebrix.api+json; version=2.0:
              schema:
                $ref: '#/components/schemas/DeploymentManagerPermission'
          description: ''
      tags:
      - Deployments
      summary: Create deployment manager permission
      x-summary-source: derived
  /api/deployments/{deployment_pk}/contacts/:
    get:
      operationId: listDeploymentAlertEmails
      description: Return the alert-notification contact emails configured for a deployment.
      parameters:
      - name: deployment_pk
        in: path
        required: true
        description: ''
        schema:
          type: string
      responses:
        '200':
          content:
            application/json; version=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DeploymentAlertEmail'
            application/vnd.pixiebrix.api+json; version=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DeploymentAlertEmail'
          description: ''
      tags:
      - Deployments
      summary: List deployment alert emails
      x-summary-source: derived
    post:
      operationId: createDeploymentAlertEmail
      description: Add an alert-notification contact email to a deployment.
      parameters:
      - name: deployment_pk
        in: path
        required: true
        description: ''
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentAlertEmail'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DeploymentAlertEmail'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DeploymentAlertEmail'
      responses:
        '201':
          content:
            application/json; version=1.0:
              schema:
                $ref: '#/components/schemas/DeploymentAlertEmail'
            application/vnd.pixiebrix.api+json; version=1.0:
              schema:
                $ref: '#/components/schemas/DeploymentAlertEmail'
          description: ''
      tags:
      - Deployments
      summary: Create deployment alert email
      x-summary-source: derived
  /api/deployments/{deployment_pk}/contacts/{id}/:
    get:
      operationId: retrieveDeploymentAlertEmail
      description: Return a single alert-notification contact email for a deployment.
      parameters:
      - name: deployment_pk
        in: path
        required: true
        description: ''
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: ''
        schema:
          type: string
      responses:
        '200':
          content:
            application/json; version=1.0:
              schema:
                $ref: '#/components/schemas/DeploymentAlertEmail'
            application/vnd.pixiebrix.api+json; version=1.0:
              schema:
                $ref: '#/components/schemas/DeploymentAlertEmail'
          description: ''
      tags:
      - Deployments
      summary: Retrieve deployment alert email
      x-summary-source: derived
    put:
      operationId: updateDeploymentAlertEmail
      description: Replace an existing alert-notification contact email for a deployment.
      parameters:
      - name: deployment_pk
        in: path
        required: true
        description: ''
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: ''
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentAlertEmail'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DeploymentAlertEmail'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DeploymentAlertEmail'
      responses:
        '200':
          content:
            application/json; version=1.0:
              schema:
                $ref: '#/components/schemas/DeploymentAlertEmail'
            application/vnd.pixiebrix.api+json; version=1.0:
              schema:
                $ref: '#/components/schemas/DeploymentAlertEmail'
          description: ''
      tags:
      - Deployments
      summary: Update deployment alert email
      x-summary-source: derived
    patch:
      operationId: partialUpdateDeploymentAlertEmail
      description: Partially update an existing alert-notification contact email for a deployment.
      parameters:
      - name: deployment_pk
        in: path
        required: true
        description: ''
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: ''
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentAlertEmail'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DeploymentAlertEmail'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DeploymentAlertEmail'
      responses:
        '200':
          content:
            application/json; version=1.0:
              schema:
                $ref: '#/components/schemas/DeploymentAlertEmail'
            application/vnd.pixiebrix.api+json; version=1.0:
              schema:
                $ref: '#/components/schemas/DeploymentAlertEmail'
          description: ''
      tags:
      - Deployments
      summary: Partial update deployment alert email
      x-summary-source: derived
    delete:
      operationId: destroyDeploymentAlertEmail
      description: Remove an alert-notification contact email from a deployment.
      parameters:
      - name: deployment_pk
        in: path
        required: true
        description: ''
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: ''
        schema:
          type: string
      responses:
        '204':
          description: ''
      tags:
      - Deployments
      summary: Destroy deployment alert email
      x-summary-source: derived
  /api/deployments/{deployment_pk}/messages/:
    post:
      operationId: createDeploymentMessage
      description: Send an email message about a deployment to a specified recipient on behalf of the current user.
      parameters:
      - name: deployment_pk
        in: path
        required: true
        description: ''
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentMessage'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DeploymentMessage'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DeploymentMessage'
      responses:
        '201':
          content:
            application/json; version=1.0:
              schema:
                $ref: '#/components/schemas/DeploymentMessage'
            application/vnd.pixiebrix.api+json; version=1.0:
              schema:
                $ref: '#/components/schemas/DeploymentMessage'
          description: ''
      tags:
      - Deployments
      summary: Create deployment message
      x-summary-source: derived
  /api/deployments/{deployment_pk}/reports/{report_pk}/jobs/:
    post:
      operationId: createDeploymentReportJob
      description: Start a background job to generate a deployment report's telemetry data, returning the new job or redirecting to one already in progress.
      parameters:
      - name: deployment_pk
        in: path
        required: true
        description: ''
        schema:
          type: string
      - name: report_pk
        in: path
        required: true
        description: ''
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Job'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Job'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Job'
      responses:
        '201':
          content:
            application/json; version=1.0:
              schema:
                $ref: '#/components/schemas/Job'
            application/vnd.pixiebrix.api+json; version=1.0:
              schema:
                $ref: '#/components/schemas/Job'
          description: ''
      tags:
      - Deployments
      summary: Create deployment report job
      x-summary-source: derived
  /api/deployments/{deployment_pk}/alerts/:
    post:
      operationId: createDeploymentAlert
      description: Send an alert email about a deployment to its configured error-notification contacts.
      parameters:
      - name: deployment_pk
        in: path
        required: true
        description: ''
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema: {}
          application/x-www-form-urlencoded:
            schema: {}
          multipart/form-data:
            schema: {}
      responses:
        '201':
          content:
            application/json; version=1.0:
              schema: {}
            application/vnd.pixiebrix.api+json; version=1.0:
              schema: {}
          description: ''
      tags:
      - Deployments
      summary: Create deployment alert
      x-summary-source: derived
  /api/deployments/{deployment_pk}/my-bindings/:
    put:
      operationId: updateUserDeploymentBindings
      description: View for end-users to upsert their personal deployment auth bindings.
      parameters:
      - name: deployment_pk
        in: path
        required: true
        description: ''
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema: {}
          application/x-www-form-urlencoded:
            schema: {}
          multipart/form-data:
            schema: {}
      responses:
        '200':
          content:
            application/json; version=1.0:
              schema: {}
            application/vnd.pixiebrix.api+json; version=1.0:
              schema: {}
          description: ''
      tags:
      - Deployments
      summary: Update user deployment bindings
      x-summary-source: derived
  /api/deployments/{deployment_pk}/groups/{id}/:
    delete:
      operationId: destroyDeploymentPermission
      description: Revoke a group's permission to a deployment.
      parameters:
      - name: deployment_pk
        in: path
        required: true
        description: ''
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: ''
        schema:
          type: string
      responses:
        '204':
          description: ''
      tags:
      - Deployments
      summary: Destroy deployment permission
      x-summary-source: derived
  /api/deployments/{deployment_pk}/managers/{id}/:
    delete:
      operationId: destroyDeploymentManagerPermission
      description: Revoke a group's manager permission over a deployment.
      parameters:
      - name: deployment_pk
        in: path
        required: true
        description: ''
        schema:
          type: string
      - name: id
        in: path
        required: true
        description: ''
        schema:
          type: string
      responses:
        '204':
          description: ''
      tags:
      - Deployments
      summary: Destroy deployment manager permission
      x-summary-source: derived
components:
  schemas:
    DeploymentReport:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The id of the report
        name:
          type: string
          description: The name of the report
        timestamp:
          type: string
          format: date-time
          description: Report generation timestamp
        data:
          type: array
          items:
            type: object
            properties:
              email:
                type: string
                format: email
              timestamp:
                type: string
                format: date
              event_name:
                type: string
              event_label:
                type: string
              value:
                type: integer
            required:
            - email
            - timestamp
            - event_name
            - event_label
            - value
      required:
      - id
      - name
      - timestamp
      - data
    DeploymentReportMetadata:
      type: object
      properties:
        id:


# --- 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