---
updatedAt: 2025-09-22T23:44:15.000Z
agentTools:
  projectIndex: https://docs.budibase.com/llms.txt
---

# Publish an application

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Budibase API",
    "description": "The public API for Budibase apps and its services.",
    "version": "3.3.0"
  },
  "servers": [
    {
      "url": "https://budibase.app/api/public/v1",
      "description": "Budibase Cloud API",
      "variables": {
        "apiKey": {
          "default": "<user API key>",
          "description": "The API key of the user to assume for API call."
        },
        "appId": {
          "default": "<App ID>",
          "description": "The ID of the app the calls will be executed within the context of, this should start with app_ (production) or app_dev (development)."
        }
      }
    }
  ],
  "components": {
    "parameters": {
      "appIdUrl": {
        "in": "path",
        "name": "appId",
        "required": true,
        "description": "The ID of the app which this request is targeting.",
        "schema": {
          "default": "{{appId}}",
          "type": "string"
        }
      }
    },
    "examples": {
      "deploymentOutput": {
        "value": {
          "data": {
            "_id": "ef12381f934b4f129675cdbb76eff3c2",
            "status": "SUCCESS",
            "appUrl": "/app-url"
          }
        }
      }
    },
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "x-budibase-api-key",
        "description": "Your individual API key, this will provide access based on the configured RBAC settings of your user."
      }
    },
    "schemas": {
      "deploymentOutput": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "_id": {
                "description": "The ID of the app.",
                "type": "string"
              },
              "status": {
                "description": "Status of the deployment, whether it succeeded or failed",
                "type": "string",
                "enum": [
                  "SUCCESS",
                  "FAILURE"
                ]
              },
              "appUrl": {
                "description": "The URL of the published app",
                "type": "string"
              }
            },
            "required": [
              "_id",
              "status",
              "appUrl"
            ]
          }
        },
        "required": [
          "data"
        ]
      }
    }
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "paths": {
    "/applications/{appId}/publish": {
      "post": {
        "deprecated": true,
        "operationId": "appPublish",
        "summary": "Publish an application",
        "tags": [
          "applications"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/appIdUrl"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the deployment object.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/deploymentOutput"
                },
                "examples": {
                  "deployment": {
                    "$ref": "#/components/examples/deploymentOutput"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```