Skip to content

Launch a show format: HTTP API

The operator API is versioned under /api/v1. This local example is called from the trusted Manager host; a remote caller adds Authorization: Bearer … as shown in the API-token walkthrough.

Terminal window
curl --silent --show-error --fail-with-body --request POST --header 'Accept: application/json' --header 'X-Norsk-Proxy: $(cat ~/.norsk-mgr/proxy-secret)' --header 'Content-Type: application/json' --data '{"kind":"dev","devUrl":"http://127.0.0.1:7422"}' http://127.0.0.1:9333/api/v1/products
{
"product": {
"name": "e2e-fixture",
"spec": {
"kind": "dev",
"url": "http://127.0.0.1:7422"
},
"addedAt": "2026-11-21T11:13:26.379Z",
"running": true,
"manifest": {
"manifestSchemaVersion": 1,
"name": "e2e-fixture",
"version": "0.0.1",
"api": {
"basePath": "/",
"proxyPaths": [],
"openapiFragmentPath": "/openapi.json",
"healthCheckPath": "/healthz"
},
"ui": {
"sidebarEntries": [],
"dashboardWidgets": [],
"productTemplateActions": []
},
"cli": {
"subcommandTree": []
},
"targets": [
"docker-compose"
],
"components": [],
"runtime": {
"sharedWorkingDirectory": false
},
"defaultProductTemplates": []
}
},
"warnings": []
}

The build endpoint asks the registered product for an immutable launchable artifact and makes it current.

Terminal window
curl --silent --show-error --fail-with-body --request POST --header 'Accept: application/json' --header 'X-Norsk-Proxy: $(cat ~/.norsk-mgr/proxy-secret)' --header 'Content-Type: application/json' --data '{"name":"evening-news-studio","productName":"e2e-fixture","formValues":{}}' http://127.0.0.1:9333/api/v1/product-templates/build
{
"name": "evening-news-studio",
"revisionId": "d5892d1b-6381-4964-87dc-5d1566568887",
"artifactSha256": "2a48e950efea2c5d54c9cc9953f4064d9743dd34e06a23d710cf83cc3e5ef9b9",
"createdAt": "2026-11-21T11:13:26.441Z",
"manifest": {
"productTemplateSchemaVersion": 1,
"productName": "e2e-fixture",
"productVersion": "0.0.1",
"target": "docker-compose",
"generatedAt": "2026-11-21T11:13:26.435Z"
},
"parameters": [
{
"name": "INSTANCE_NAME",
"purpose": "Compose project label for this instance",
"type": "string"
}
],
"source": {
"kind": "build",
"productName": "e2e-fixture"
}
}
Terminal window
curl --silent --show-error --fail-with-body --request PUT --header 'Accept: application/json' --header 'X-Norsk-Proxy: $(cat ~/.norsk-mgr/proxy-secret)' --header 'Content-Type: application/json' --data '{"runtimes":[{"runtimeId":"main","productTemplateName":"evening-news-studio","parameters":{"INSTANCE_NAME":"${production}"}}]}' http://127.0.0.1:9333/api/v1/production-templates/evening-news
{
"runtimes": [
{
"runtimeId": "main",
"productTemplateName": "evening-news-studio",
"parameters": {
"INSTANCE_NAME": "${production}"
}
}
],
"name": "evening-news",
"createdAt": "2026-11-21T11:13:26.553Z",
"updatedAt": "2026-11-21T11:13:26.553Z",
"revision": 1
}

The pool is chosen per launch; the template remains reusable across environments.

Terminal window
curl --silent --show-error --fail-with-body --request POST --header 'Accept: application/json' --header 'X-Norsk-Proxy: $(cat ~/.norsk-mgr/proxy-secret)' --header 'Content-Type: application/json' --data '{"productionId":"evening-news-01","pool":"local"}' http://127.0.0.1:9333/api/v1/production-templates/evening-news/launch
{
"launched": [
{
"productionId": "evening-news-01",
"bundleId": "evening-news-01",
"runtimes": [
"main"
],
"launchCredential": "9dc27129981c2b7873eeae3aedf173ae44168ecd32c0ea94841abd84166cd378"
}
],
"failures": []
}
Terminal window
curl --silent --show-error --fail-with-body --request GET --header 'Accept: application/json' --header 'X-Norsk-Proxy: $(cat ~/.norsk-mgr/proxy-secret)' http://127.0.0.1:9333/api/v1/productions/evening-news-01
{
"productionId": "evening-news-01",
"pool": "local",
"jobs": [
{
"runtimeId": "main",
"requirements": {
"requiredCapacity": 1,
"requiredCapabilities": [],
"onRuntimeFailure": "avoidSpare"
},
"launch": {
"kind": "productTemplate",
"ref": {
"productName": "e2e-fixture",
"productVersion": "0.0.1",
"sha256": "2a48e950efea2c5d54c9cc9953f4064d9743dd34e06a23d710cf83cc3e5ef9b9",
"templateName": "evening-news-studio",
"source": {
"kind": "url",
"url": "http://127.0.0.1:9333/api/v1/product-templates/by-sha/2a48e950efea2c5d54c9cc9953f4064d9743dd34e06a23d710cf83cc3e5ef9b9/tar?token=…"
}
},
"parameters": {
"INSTANCE_NAME": "evening-news-01"
},
"startDateTime": "2026-11-21T11:13:26.617Z",
"tags": {
"launchCredentialSha256": "a6982832c182b74ef3f6d4666ec09db2da8ab318c26ca4106a803fbed11d99a2",
"productTemplateRevisionId": "d5892d1b-6381-4964-87dc-5d1566568887"
}
},
"startMode": "auto"
}
],
"state": "live",
"rollupState": "active",
"broken": false,
"resilienceDegraded": false,
"awaitingCapacity": false,
"onLaunch": "avoidSpare",
"identity": {
"productionTemplateId": "evening-news",
"productionTemplateRevision": "1",
"runtimeUrlBase": "/bundles/evening-news-01"
}
}
Terminal window
curl --silent --show-error --fail-with-body --request GET --header 'Accept: application/json' --header 'X-Norsk-Proxy: $(cat ~/.norsk-mgr/proxy-secret)' http://127.0.0.1:9333/api/v1/runtimes
{
"items": [
{
"job": {
"runtimeRecordId": "evening-news-01.0.main",
"state": "active",
"currentHash": "17463759",
"tags": {
"auto-manager": "true",
"productionId": "evening-news-01",
"runtimeId": "main",
"launchCredentialSha256": "a6982832c182b74ef3f6d4666ec09db2da8ab318c26ca4106a803fbed11d99a2",
"productTemplateRevisionId": "d5892d1b-6381-4964-87dc-5d1566568887",
"replicaIndex": "0"
},
"startDateTime": "2026-11-21T11:13:26.617Z",
"cloud": "aws",
"description": "",
"writeFiles": [],
"services": [],
"volumes": [],
"managerConfiguration": "",
"norskMediaVersion": "recommended",
"norskServiceParameters": {
"portMappings": [],
"environmentVariables": [],
"cpuSet": [],
"volumeMounts": [],
"bindMounts": [],
"ulimits": []
},
"shape": "",
"availabilityDomain": "",
"subnet": "",
"architecture": "",
"norskCpuList": [],
"autoPlacement": {
"$typeName": "norsk.api.manager.AutoPlacement",
"requirements": {
"$typeName": "norsk.api.manager.JobRequirements",
"requiredCapacity": 1,
"requiredCapabilities": [],
"onRuntimeFailure": 1,
"requiredHostPorts": []
}
},
"productTemplate": {
"productName": "e2e-fixture",
"productVersion": "0.0.1",
"sha256": "2a48e950efea2c5d54c9cc9953f4064d9743dd34e06a23d710cf83cc3e5ef9b9",
"templateName": "evening-news-studio",
"source": {
"kind": "url",
"url": "http://127.0.0.1:9333/api/v1/product-templates/by-sha/2a48e950efea2c5d54c9cc9953f4064d9743dd34e06a23d710cf83cc3e5ef9b9/tar?token=…"
}
},
"productTemplateParameters": {
"INSTANCE_NAME": "evening-news-01"
}
},
"history": [
{
"event": "running",
"timestamp": "2026-11-21T11:13:30.660Z",
"role": "primary",
"nodeMetadata": {
"nodeId": "cluster-ixiVlbCz9Yq6k7RE",
"tags": {
"pool": "local",
"versionSkew": "none",
"workerProtocolVersion": "2.3",
"workerVersion": "0.1.0-2026-11-21-7114c45"
},
"createdAt": "2026-11-21T11:13:23.322Z",
"providerMetadata": {
"provider": "cluster"
}
},
"runningNodeMetadata": {
"publicDnsName": "",
"privateDnsName": "127.0.0.1",
"privateIpAddress": "127.0.0.1",
"publicIpAddress": "127.0.0.1",
"providerMetadata": {
"provider": "cluster",
"instanceId": "cluster-ixiVlbCz9Yq6k7RE"
},
"proxyUrl": "https://127.0.0.1"
}
},
{
"event": "provisioned",
"timestamp": "2026-11-21T11:13:26.753Z",
"role": "primary",
"nodeMetadata": {
"nodeId": "cluster-ixiVlbCz9Yq6k7RE",
"tags": {
"pool": "local",
"versionSkew": "none",
"workerProtocolVersion": "2.3",
"workerVersion": "0.1.0-2026-11-21-7114c45"
},
"createdAt": "2026-11-21T11:13:23.322Z",
"providerMetadata": {
"provider": "cluster"
}
},
"runningNodeMetadata": {
"publicDnsName": "",
"privateDnsName": "127.0.0.1",
"privateIpAddress": "127.0.0.1",
"publicIpAddress": "127.0.0.1",
"providerMetadata": {
"provider": "cluster",
"instanceId": "cluster-ixiVlbCz9Yq6k7RE"
},
"proxyUrl": "https://127.0.0.1"
}
},
{
"event": "created",
"timestamp": "2026-11-21T11:13:26.709Z"
}
],
"dropped": false,
"dormant": false,
"nodeId": "cluster-ixiVlbCz9Yq6k7RE",
"nodeAddress": "127.0.0.1",
"migration": {
"declaredStrategy": "stopThenStart"
}
}
],
"nextCursor": null
}
Terminal window
curl --silent --show-error --fail-with-body --request DELETE --header 'Accept: application/json' --header 'X-Norsk-Proxy: $(cat ~/.norsk-mgr/proxy-secret)' http://127.0.0.1:9333/api/v1/productions/evening-news-01
{
"productionId": "evening-news-01",
"deleted": true
}
Terminal window
curl --silent --show-error --fail-with-body --request DELETE --header 'Accept: application/json' --header 'X-Norsk-Proxy: $(cat ~/.norsk-mgr/proxy-secret)' http://127.0.0.1:9333/api/v1/production-templates/evening-news
{
"status": "ok",
"name": "evening-news"
}
Terminal window
curl --silent --show-error --fail-with-body --request DELETE --header 'Accept: application/json' --header 'X-Norsk-Proxy: $(cat ~/.norsk-mgr/proxy-secret)' http://127.0.0.1:9333/api/v1/product-templates/evening-news-studio
{
"status": "ok",
"name": "evening-news-studio"
}

Captured 2026-11-21 against norsk-mgr 0.1.0-2026-11-21-7114c45, Norsk Manager 1.4.2-2026-11-19-3758b1eb — every command and screenshot on this page is from that run.