Raw schema
{
"type": "object",
"properties": {
"projectId": {
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$",
"description": "Existing project id."
},
"teamId": {
"description": "Team id, required for an organization-scoped token.",
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$"
},
"name": {
"type": "string",
"minLength": 3,
"maxLength": 54,
"pattern": "^[a-zA-Z]((-|\\s)?[a-zA-Z0-9]+((-|\\s)[a-zA-Z0-9]+)*)?$",
"description": "New service name."
},
"repositoryUrl": {
"type": "string",
"pattern": "^https:\\/\\/github\\.com\\/[A-Za-z0-9_-]+\\/[A-Za-z0-9_.-]+$",
"description": "HTTPS GitHub repository URL from northflank_list_repositories, without a trailing slash, query or credentials."
},
"branch": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[^\\s\\x00-\\x1f\\x7f]+$",
"description": "Explicit Git branch to build."
},
"accountLogin": {
"description": "Linked GitHub account login from northflank_list_repositories; useful when multiple accounts are linked.",
"type": "string",
"minLength": 1
},
"dockerfilePath": {
"type": "string",
"pattern": "^\\/((?!\\.\\.?\\/)[a-zA-Z0-9-._]+\\/)*(?!\\.\\.?$)[a-zA-Z0-9-._]+$",
"description": "Absolute repository path to the Dockerfile, e.g. /Dockerfile or /apps/api/Dockerfile."
},
"dockerWorkDir": {
"default": "/",
"description": "Absolute repository build context; defaults to /.",
"type": "string",
"pattern": "^\\/((?!\\.\\.?\\/)[a-zA-Z0-9-._]+\\/)*(?!\\.\\.?$)[a-zA-Z0-9-._]*$"
},
"deploymentPlan": {
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$",
"description": "Explicit deployment plan ID from northflank_list_plans; charged by Northflank."
},
"buildPlan": {
"description": "Optional Northflank build plan ID; omitted uses the vendor default.",
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$"
},
"instances": {
"default": 1,
"description": "Initial running replicas, charged by Northflank.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"httpPort": {
"type": "integer",
"minimum": 1,
"maximum": 65535,
"description": "Container HTTP listen port. The application must listen on 0.0.0.0."
},
"public": {
"type": "boolean",
"description": "Explicitly choose whether the HTTP port is publicly accessible."
},
"healthCheck": {
"description": "Optional HTTP health check on the container's HTTP port.",
"type": "object",
"properties": {
"path": {
"type": "string",
"pattern": "^\\/([a-zA-Z0-9-._]+\\/)*[a-zA-Z0-9-._]*$",
"description": "HTTP health endpoint on httpPort, e.g. /health."
},
"type": {
"default": "readinessProbe",
"type": "string",
"enum": [
"readinessProbe",
"livenessProbe",
"startupProbe"
]
},
"initialDelaySeconds": {
"default": 10,
"type": "integer",
"minimum": 1,
"maximum": 1800
},
"periodSeconds": {
"default": 30,
"type": "integer",
"minimum": 10,
"maximum": 600
},
"timeoutSeconds": {
"default": 5,
"type": "integer",
"minimum": 1,
"maximum": 60
},
"failureThreshold": {
"default": 3,
"type": "integer",
"minimum": 1,
"maximum": 255
}
},
"required": [
"path"
],
"additionalProperties": false
},
"environmentSecretReferences": {
"description": "Runtime variable name -> existing inherited variable name; values are NAMES, never credentials. Source variables must already be inherited from applicable runtime secret groups. Avoid mapping a name to itself: inherited variables already exist.",
"type": "object",
"propertyNames": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
},
"additionalProperties": {
"type": "string",
"pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
}
},
"tags": {
"description": "Previously defined resource tags, including any tags required to inherit the intended secret groups.",
"type": "array",
"items": {
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$"
}
},
"stageId": {
"description": "Existing project environment/stage id for stage-scoped secret inheritance.",
"type": "string",
"minLength": 3,
"maxLength": 100,
"pattern": "^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$"
},
"confirm": {
"type": "boolean",
"const": true,
"description": "Required: user approved creating the service, its charges, public exposure and inherited-secret access."
}
},
"required": [
"projectId",
"name",
"repositoryUrl",
"branch",
"dockerfilePath",
"deploymentPlan",
"httpPort",
"public",
"confirm"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}