Unkey · Schema

V2DeployCreateDeploymentRequestBody

Create a deployment from a pre-built Docker image

API KeysRate LimitingAuthenticationDeveloper PlatformAccess ControlIdentityAnalytics

Properties

Name	Type	Description
project	string	Project slug
app	string	App slug within the project
keyspaceId	string	Optional keyspace ID for authentication context
branch	string	Git branch name
environmentSlug	string	Environment slug (e.g., "production", "staging")
dockerImage	string	Docker image reference to deploy
gitCommit	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/V2DeployCreateDeploymentRequestBody",
  "title": "V2DeployCreateDeploymentRequestBody",
  "type": "object",
  "required": [
    "project",
    "app",
    "branch",
    "environmentSlug",
    "dockerImage"
  ],
  "properties": {
    "project": {
      "type": "string",
      "minLength": 1,
      "description": "Project slug",
      "example": "my-project"
    },
    "app": {
      "type": "string",
      "minLength": 1,
      "description": "App slug within the project",
      "example": "default"
    },
    "keyspaceId": {
      "type": "string",
      "description": "Optional keyspace ID for authentication context",
      "example": "key_abc123"
    },
    "branch": {
      "type": "string",
      "minLength": 1,
      "description": "Git branch name",
      "example": "main"
    },
    "environmentSlug": {
      "type": "string",
      "minLength": 1,
      "description": "Environment slug (e.g., \"production\", \"staging\")",
      "example": "production"
    },
    "dockerImage": {
      "type": "string",
      "minLength": 1,
      "description": "Docker image reference to deploy",
      "example": "ghcr.io/user/app:v1.0.0"
    },
    "gitCommit": {
      "$ref": "#/components/schemas/V2DeployGitCommit"
    }
  },
  "description": "Create a deployment from a pre-built Docker image"
}