GitHubDeployRequest
Deploy ``repo`` on a node from the console (D-GH-C6 "Deploy from GitHub"). ``repo`` is ``owner/name`` of a repository one of this account's *live* installations grants; ``name`` is the service name the daemon will use (its own DNS-label grammar); ``ref`` is a branch or tag, the repository's default branch when omitted; ``auto_deploy`` defaults **on** (daemon plan §6 Q1): a push to ``ref`` redeploys the app. "Add service": ``project_id`` + ``service`` (both or neither) deploy into an existing owned project instead of naming a new one; the machine labels the service ``
Properties
| Name | Type | Description |
|---|---|---|
| repo | string | |
| name | object | |
| ref | object | |
| auto_deploy | boolean | |
| port | object | |
| build_settings | object | |
| project_id | object | |
| service | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/nerdit-ai/json-schema/nerdit-ai-git-hub-deploy-request-schema.json",
"title": "GitHubDeployRequest",
"description": "Deploy ``repo`` on a node from the console (D-GH-C6 \"Deploy from GitHub\").\n\n``repo`` is ``owner/name`` of a repository one of this account's *live*\ninstallations grants; ``name`` is the service name the daemon will use\n(its own DNS-label grammar); ``ref`` is a branch or tag, the repository's\ndefault branch when omitted; ``auto_deploy`` defaults **on** (daemon plan\n§6 Q1): a push to ``ref`` redeploys the app.\n\n\"Add service\": ``project_id`` + ``service`` (both or neither) deploy into\nan existing owned project instead of naming a new one; the machine labels\nthe service ``<service>--<project>`` and ``name`` is not sent. A joined\nrow refuses ``auto_deploy``, so asking for it is a 422 here.",
"x-generated": "2026-11-19",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/nerdit-ai-openapi.json#/components/schemas/GitHubDeployRequest",
"properties": {
"repo": {
"type": "string",
"maxLength": 200,
"minLength": 3,
"title": "Repo"
},
"name": {
"anyOf": [
{
"type": "string",
"pattern": "^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$"
},
{
"type": "null"
}
],
"title": "Name"
},
"ref": {
"anyOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
],
"title": "Ref"
},
"auto_deploy": {
"type": "boolean",
"title": "Auto Deploy",
"default": true
},
"port": {
"anyOf": [
{
"type": "integer",
"maximum": 65535.0,
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Port"
},
"build_settings": {
"anyOf": [
{
"$ref": "#/$defs/GitHubBuildSettings"
},
{
"type": "null"
}
]
},
"project_id": {
"anyOf": [
{
"type": "string",
"maxLength": 20,
"minLength": 20,
"pattern": "^prj_[a-z2-7]{16}$"
},
{
"type": "null"
}
],
"title": "Project Id"
},
"service": {
"anyOf": [
{
"type": "string",
"maxLength": 20,
"pattern": "^(?!.*--)[a-z0-9]([a-z0-9-]{0,18}[a-z0-9])?$"
},
{
"type": "null"
}
],
"title": "Service"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"repo"
],
"$defs": {
"GitHubBuildSettings": {
"properties": {
"preset": {
"anyOf": [
{
"type": "string",
"enum": [
"node",
"nextjs",
"python",
"dockerfile"
]
},
{
"type": "null"
}
],
"title": "Preset"
},
"install": {
"anyOf": [
{
"type": "string",
"maxLength": 4096
},
{
"type": "null"
}
],
"title": "Install"
},
"build": {
"anyOf": [
{
"type": "string"
},
{
"type": "boolean",
"const": false
},
{
"type": "null"
}
],
"title": "Build"
},
"start": {
"anyOf": [
{
"type": "string",
"maxLength": 4096
},
{
"type": "null"
}
],
"title": "Start"
},
"node_version": {
"anyOf": [
{
"type": "string",
"maxLength": 32
},
{
"type": "null"
}
],
"title": "Node Version"
},
"package_manager": {
"anyOf": [
{
"type": "string",
"maxLength": 256
},
{
"type": "null"
}
],
"title": "Package Manager"
},
"subdir": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Subdir"
},
"public_env": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Public Env"
}
},
"additionalProperties": false,
"type": "object",
"title": "GitHubBuildSettings",
"description": "Explicit overrides only; null resets a field and false disables the build."
}
}
}
Work with this as data
Every JSON Schema 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 schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.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.
Call it yourself
curl for this page
curl "https://apis.io/api/v1/json-schemas/nerdit-ai-git-hub-deploy-request"
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.