Memfault Deployments API

The Deployments API from Memfault — 2 operation(s) for deployments.

OpenAPI Specification

memfault-deployments-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Memfault Cloud REST Auth Deployments API
  description: 'The Memfault Cloud REST API ingests device telemetry and exposes management for

    organizations, projects, devices, cohorts, software, releases, deployments,

    issues, and chunk ingestion. Endpoints are split across api.memfault.com (main),

    chunks.memfault.com (chunk ingestion), files.memfault.com (large file uploads),

    and ingress.memfault.com.

    '
  version: v0
  contact:
    name: Memfault
    url: https://api-docs.memfault.com/
servers:
- url: https://api.memfault.com
  description: Main API server
- url: https://chunks.memfault.com
  description: Chunks ingestion server
- url: https://files.memfault.com
  description: Files server (large uploads)
security:
- orgAuthToken: []
- basicAuth: []
tags:
- name: Deployments
paths:
  /api/v0/organizations/{organization_slug}/projects/{project_slug}/deployments:
    parameters:
    - $ref: '#/components/parameters/OrgSlug'
    - $ref: '#/components/parameters/ProjectSlug'
    get:
      tags:
      - Deployments
      summary: List deployments
      responses:
        '200':
          description: Paginated deployments
    post:
      tags:
      - Deployments
      summary: Create a deployment
      responses:
        '201':
          description: Created
  /api/v0/organizations/{organization_slug}/projects/{project_slug}/deployments/{deployment_id}:
    parameters:
    - $ref: '#/components/parameters/OrgSlug'
    - $ref: '#/components/parameters/ProjectSlug'
    - name: deployment_id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Deployments
      summary: Get a deployment
      responses:
        '200':
          description: Deployment
    patch:
      tags:
      - Deployments
      summary: Update a deployment
      responses:
        '200':
          description: Updated
components:
  parameters:
    OrgSlug:
      name: organization_slug
      in: path
      required: true
      schema:
        type: string
    ProjectSlug:
      name: project_slug
      in: path
      required: true
      schema:
        type: string
  securitySchemes:
    orgAuthToken:
      type: http
      scheme: bearer
      bearerFormat: token
      description: 'Organization Auth Token. Use "Authorization: Bearer oat_xxx" for automation

        and full API access.

        '
    basicAuth:
      type: http
      scheme: basic
      description: 'Email + password or Email + user API key via HTTP Basic auth.

        '
    projectKey:
      type: apiKey
      in: header
      name: Memfault-Project-Key
      description: 'Memfault Project Key used by devices and ingestion endpoints (chunks,

        latest release lookup, events, coredumps).

        '