Inngest

Inngest Environments API

Manage production and branch environments for an account.

Documentation GitHub OpenAPI

Business capability

Environment Management BC-4210.20

Operations 3

GET /envs List environments #

POST /envs Create environment #

PATCH /envs/{id} Update environment #

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/inngest:inngest-environments-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

openapi: 3.2.0
info:
  description: The v2 API delivers a significantly improved developer experience with consistent design patterns and enhanced functionality.
  title: Inngest REST API v2 Environments API
  version: 2.0.0
servers:
- description: Production server
  url: https://api.inngest.com/v2
- description: Development server
  url: http://localhost:8288/api/v2
tags:
- description: Create and manage environments
  name: Environments
paths:
  /envs:
    get:
      description: List of all custom environments.
      operationId: V2_FetchAccountEnvs
      parameters:
      - description: Pagination cursor from previous response
        in: query
        name: cursor
        schema:
          type: string
      - description: 'Number of environments to return per page (min: 1, max: 250)'
        in: query
        name: limit
        schema:
          default: '50'
          format: int32
          type: integer
      responses:
        '200':
          content:
            application/json:
              examples:
                default:
                  value:
                    data:
                    - createdAt: '2024-01-10T09:15:00Z'
                      id: a1b2c3d4-e5f6-4789-abc1-234567890def
                      name: production
                      type: PRODUCTION
                    - createdAt: '2024-01-12T11:30:00Z'
                      id: b2c3d4e5-f6a7-4890-bcd2-34567890abef
                      name: staging
                      type: TEST
                    metadata:
                      cachedUntil: null
                      fetchedAt: '2024-01-20T14:22:33Z'
                    page:
                      hasMore: false
                      limit: 50
              schema:
                $ref: '#/components/schemas/v2FetchAccountEnvsResponse'
          description: List of account environments
        '400':
          content:
            application/json:
              examples:
                default:
                  value:
                    errors:
                    - code: missing_field
                      message: Environment name is required
              schema:
                $ref: '#/components/schemas/v2ErrorResponse'
          description: Bad Request - invalid query parameters
        '401':
          content:
            application/json:
              examples:
                default:
                  value: Authentication failed
              schema:
                $ref: '#/components/schemas/v2ErrorResponse'
          description: Unauthorized - authentication required
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2ErrorResponse'
          description: Forbidden - insufficient permissions
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2ErrorResponse'
          description: Not Found - account not found
        '500':
          content:
            application/json:
              examples:
                default:
                  value:
                    errors:
                    - code: internal_error
                      message: Something went wrong
              schema:
                $ref: '#/components/schemas/v2ErrorResponse'
          description: Internal Server Error
      security:
      - BearerAuth: []
      summary: List environments
      tags:
      - Environments
    post:
      description: Create custom environment
      operationId: V2_CreateEnv
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v2CreateEnvRequest'
        required: true
        x-originalParamName: body
      responses:
        '201':
          content:
            application/json:
              examples:
                default:
                  value:
                    data:
                      createdAt: '2024-01-20T14:22:33Z'
                      id: c3d4e5f6-a7b8-4901-cde3-4567890bcfa0
                      name: development
                      type: BRANCH
                    metadata:
                      cachedUntil: null
                      fetchedAt: '2024-01-20T14:22:33Z'
              schema:
                $ref: '#/components/schemas/v2CreateEnvResponse'
          description: Env successfully created
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2ErrorResponse'
          description: Bad Request - invalid input data
        '401':
          content:
            application/json:
              examples:
                default:
                  value: Authentication failed
              schema:
                $ref: '#/components/schemas/v2ErrorResponse'
          description: Unauthorized - authentication required
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2ErrorResponse'
          description: Forbidden - Insufficient permissions
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2ErrorResponse'
          description: Conflict - account already exists
        '500':
          content:
            application/json:
              examples:
                default:
                  value:
                    errors:
                    - code: internal_error
                      message: Something went wrong
              schema:
                $ref: '#/components/schemas/v2ErrorResponse'
          description: Internal Server Error
      security:
      - BearerAuth: []
      summary: Create environment
      tags:
      - Environments
  /envs/{id}:
    patch:
      description: Partially updates an environment. Only the provided fields will be modified.
      operationId: V2_PatchEnv
      parameters:
      - description: The ID of the environment to update
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V2PatchEnvBody'
        required: true
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2PatchEnvsResponse'
          description: Environment successfully updated
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2ErrorResponse'
          description: Bad Request - invalid input data
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2ErrorResponse'
          description: Unauthorized - authentication required
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2ErrorResponse'
          description: Forbidden - insufficient permissions
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2ErrorResponse'
          description: Not Found - environment not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2ErrorResponse'
          description: Unprocessable Entity - business logic validation failed
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2ErrorResponse'
          description: Internal Server Error
      security:
      - BearerAuth: []
      summary: Update environment
      tags:
      - Environments
components:
  schemas:
    v2PatchEnvsResponse:
      properties:
        data:
          $ref: '#/components/schemas/v2Env'
        metadata:
          $ref: '#/components/schemas/v2ResponseMetadata'
      type: object
    v2ErrorResponse:
      properties:
        errors:
          items:
            $ref: '#/components/schemas/v2Error'
          type: array
      type: object
    v2ResponseMetadata:
      properties:
        cachedUntil:
          format: date-time
          type: string
        fetchedAt:
          format: date-time
          type: string
        timeRange:
          $ref: '#/components/schemas/v2TimeRange'
      type: object
    v2Error:
      properties:
        code:
          type: string
        message:
          type: string
      type: object
    v2Page:
      properties:
        cursor:
          type: string
        hasMore:
          type: boolean
        limit:
          format: int32
          type: integer
      type: object
    v2TimeRange:
      properties:
        from:
          format: date-time
          type: string
        until:
          format: date-time
          type: string
      type: object
    v2FetchAccountEnvsResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/v2Env'
          type: array
        metadata:
          $ref: '#/components/schemas/v2ResponseMetadata'
        page:
          $ref: '#/components/schemas/v2Page'
      type: object
    v2Env:
      properties:
        createdAt:
          format: date-time
          type: string
        id:
          type: string
        isArchived:
          type: boolean
        name:
          type: string
        type:
          $ref: '#/components/schemas/v2EnvType'
      type: object
    v2EnvType:
      default: PRODUCTION
      enum:
      - PRODUCTION
      - TEST
      - BRANCH
      type: string
    v2CreateEnvRequest:
      properties:
        id:
          type: string
        name:
          type: string
      type: object
    v2CreateEnvResponse:
      properties:
        data:
          $ref: '#/components/schemas/v2Env'
        metadata:
          $ref: '#/components/schemas/v2ResponseMetadata'
      type: object
    V2PatchEnvBody:
      properties:
        isArchived:
          description: Updates the archived status of the environment. Set to true to archive the environment or false to unarchive it.
          type: boolean
      type: object
  securitySchemes:
    BearerAuth:
      description: 'Bearer token authentication. Format: `Bearer {key}`'
      in: header
      name: Authorization
      type: apiKey
x-provenance:
  method: harvested
  publisher: Inngest
  source: https://api-docs.inngest.com/api-specs/v2.json
  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)

Inngest Environments API

Operations 3

Documentation

Specifications

Schemas & Data

Other Resources