{ "info": { "_postman_id": "721c3f77-256b-4c43-831f-f8080bac0c32", "name": "Encore Framework Apps API", "description": "Conceptual OpenAPI describing the runtime HTTP surface that the Encore framework\n(Encore.ts and Encore.go) exposes for every Encore application. This is not a\nsingle hosted API \u2014 it is the per-application surface generated by the framework\nwhen an api() / //encore:api declaration is parsed. Real endpoints, paths, and\nschemas are app-specific.\n\n\nContact Support:\n Name: Encore", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:33:56.000Z", "updatedAt": "2026-07-28T01:33:56.000Z", "lastUpdatedBy": "35240", "uid": "35240-721c3f77-256b-4c43-831f-f8080bac0c32" }, "item": [ { "name": "apps", "item": [ { "name": "{app_id}", "item": [ { "name": "environments", "item": [ { "name": "{env}", "item": [ { "name": "deployments", "item": [ { "name": "List Deployments", "id": "600dcb2d-cd3b-47ca-bbbf-021e63d06fff", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/apps/:app_id/environments/:env/deployments", "host": [ "{{baseUrl}}" ], "path": [ "apps", ":app_id", "environments", ":env", "deployments" ], "variable": [ { "id": "6679a3e5-ee11-4ce4-9af3-fbe5cff5e61e", "key": "app_id", "value": "", "description": "(Required) " }, { "id": "aeeaaac1-c913-412c-9806-74040fed1734", "key": "env", "value": "", "description": "(Required) " } ] }, "description": "List deployments for an environment." }, "response": [ { "id": "ff6f4c1d-89e3-4706-82b4-edb572ef7f7a", "name": "Deployment history.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/apps/:app_id/environments/:env/deployments", "host": [ "{{baseUrl}}" ], "path": [ "apps", ":app_id", "environments", ":env", "deployments" ], "variable": [ { "key": "app_id" }, { "key": "env" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"commit\": \"\",\n \"status\": \"succeeded\",\n \"created_at\": \"\"\n },\n {\n \"id\": \"\",\n \"commit\": \"\",\n \"status\": \"succeeded\",\n \"created_at\": \"\"\n }\n]", "createdAt": "2026-07-28T01:33:57.000Z", "updatedAt": "2026-07-28T01:33:57.000Z", "uid": "35240-ff6f4c1d-89e3-4706-82b4-edb572ef7f7a" } ], "createdAt": "2026-07-28T01:33:57.000Z", "updatedAt": "2026-07-28T01:33:57.000Z", "uid": "35240-600dcb2d-cd3b-47ca-bbbf-021e63d06fff" }, { "name": "Trigger Deployment", "id": "5fd0096f-45fc-463a-aff4-db77289b49b3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"commit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/apps/:app_id/environments/:env/deployments", "host": [ "{{baseUrl}}" ], "path": [ "apps", ":app_id", "environments", ":env", "deployments" ], "variable": [ { "id": "5d89e911-55d4-4e05-97b3-cafb428c85b2", "key": "app_id", "value": "", "description": "(Required) " }, { "id": "c53e5340-5824-40a1-ae00-b8ff9e67b65a", "key": "env", "value": "", "description": "(Required) " } ] }, "description": "Trigger a new deployment of a commit to the named environment (equivalent to `git push encore`)." }, "response": [ { "id": "de40cd92-ffef-45db-80de-91e37149e9af", "name": "Deployment accepted.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"commit\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/apps/:app_id/environments/:env/deployments", "host": [ "{{baseUrl}}" ], "path": [ "apps", ":app_id", "environments", ":env", "deployments" ], "variable": [ { "key": "app_id" }, { "key": "env" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"commit\": \"\",\n \"status\": \"failed\",\n \"created_at\": \"\"\n}", "createdAt": "2026-07-28T01:33:57.000Z", "updatedAt": "2026-07-28T01:33:57.000Z", "uid": "35240-de40cd92-ffef-45db-80de-91e37149e9af" } ], "createdAt": "2026-07-28T01:33:57.000Z", "updatedAt": "2026-07-28T01:33:57.000Z", "uid": "35240-5fd0096f-45fc-463a-aff4-db77289b49b3" } ], "id": "e1d0ff37-168a-4783-97e8-1db3c6fb6da8", "createdAt": "2026-07-28T01:33:57.000Z", "updatedAt": "2026-07-28T01:33:57.000Z", "uid": "35240-e1d0ff37-168a-4783-97e8-1db3c6fb6da8" } ], "id": "db696d35-a0b6-4603-aa3d-b4292539e91f", "createdAt": "2026-07-28T01:33:57.000Z", "updatedAt": "2026-07-28T01:33:57.000Z", "uid": "35240-db696d35-a0b6-4603-aa3d-b4292539e91f" }, { "name": "List Environments", "id": "f05d929a-e963-4e28-94b7-9aa8d1cc2056", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/apps/:app_id/environments", "host": [ "{{baseUrl}}" ], "path": [ "apps", ":app_id", "environments" ], "variable": [ { "id": "5c6ccf9c-b00b-4266-b6b7-5f0246dd296c", "key": "app_id", "value": "", "description": "(Required) " } ] }, "description": "List environments (development, preview, staging, production) for an Encore application." }, "response": [ { "id": "3204780a-b01d-45fe-82b4-8df7bf9a973c", "name": "List of environments.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/apps/:app_id/environments", "host": [ "{{baseUrl}}" ], "path": [ "apps", ":app_id", "environments" ], "variable": [ { "key": "app_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"name\": \"\",\n \"type\": \"development\",\n \"cloud\": \"gcp\",\n \"region\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"staging\",\n \"cloud\": \"encore\",\n \"region\": \"\"\n }\n]", "createdAt": "2026-07-28T01:33:57.000Z", "updatedAt": "2026-07-28T01:33:57.000Z", "uid": "35240-3204780a-b01d-45fe-82b4-8df7bf9a973c" } ], "createdAt": "2026-07-28T01:33:57.000Z", "updatedAt": "2026-07-28T01:33:57.000Z", "uid": "35240-f05d929a-e963-4e28-94b7-9aa8d1cc2056" } ], "id": "6b50a9be-ea3e-4e27-b49f-30c23f5448d3", "createdAt": "2026-07-28T01:33:57.000Z", "updatedAt": "2026-07-28T01:33:57.000Z", "uid": "35240-6b50a9be-ea3e-4e27-b49f-30c23f5448d3" }, { "name": "secrets", "item": [ { "name": "List Secrets", "id": "d0072365-90ba-41e3-9f93-4190b82d4db7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/apps/:app_id/secrets", "host": [ "{{baseUrl}}" ], "path": [ "apps", ":app_id", "secrets" ], "variable": [ { "id": "aeb1ad2b-8aec-4f29-944a-91983579a2b2", "key": "app_id", "value": "", "description": "(Required) " } ] }, "description": "List secret names declared by the application (values are never returned)." }, "response": [ { "id": "c899dd5a-dcab-468f-9d95-1dae00fdde5e", "name": "Secret metadata.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/apps/:app_id/secrets", "host": [ "{{baseUrl}}" ], "path": [ "apps", ":app_id", "secrets" ], "variable": [ { "key": "app_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"name\": \"\",\n \"environments\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"environments\": [\n \"\",\n \"\"\n ]\n }\n]", "createdAt": "2026-07-28T01:33:57.000Z", "updatedAt": "2026-07-28T01:33:57.000Z", "uid": "35240-c899dd5a-dcab-468f-9d95-1dae00fdde5e" } ], "createdAt": "2026-07-28T01:33:57.000Z", "updatedAt": "2026-07-28T01:33:57.000Z", "uid": "35240-d0072365-90ba-41e3-9f93-4190b82d4db7" }, { "name": "Set Secret Value", "id": "bf561191-d779-4c89-bdab-0030fbff8adb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"env\": \"\",\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/apps/:app_id/secrets", "host": [ "{{baseUrl}}" ], "path": [ "apps", ":app_id", "secrets" ], "variable": [ { "id": "0fee95e6-2f8f-4c48-b88b-0d903d78f929", "key": "app_id", "value": "", "description": "(Required) " } ] }, "description": "Set or update a secret value for an environment." }, "response": [ { "id": "101164a7-b93f-4b2d-9147-4349745908c9", "name": "Secret stored.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"env\": \"\",\n \"value\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/apps/:app_id/secrets", "host": [ "{{baseUrl}}" ], "path": [ "apps", ":app_id", "secrets" ], "variable": [ { "key": "app_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:33:57.000Z", "updatedAt": "2026-07-28T01:33:57.000Z", "uid": "35240-101164a7-b93f-4b2d-9147-4349745908c9" } ], "createdAt": "2026-07-28T01:33:57.000Z", "updatedAt": "2026-07-28T01:33:57.000Z", "uid": "35240-bf561191-d779-4c89-bdab-0030fbff8adb" } ], "id": "9b59ddd8-c49f-4a09-8e63-16d79f5006ab", "createdAt": "2026-07-28T01:33:57.000Z", "updatedAt": "2026-07-28T01:33:57.000Z", "uid": "35240-9b59ddd8-c49f-4a09-8e63-16d79f5006ab" }, { "name": "traces", "item": [ { "name": "Query Distributed Traces", "id": "27a20182-2296-4123-b110-b49ca717c7d6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/apps/:app_id/traces?env=&limit=50", "host": [ "{{baseUrl}}" ], "path": [ "apps", ":app_id", "traces" ], "query": [ { "key": "env", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [ { "id": "c167ca98-1c2b-47d2-b679-ad4609388ca9", "key": "app_id", "value": "", "description": "(Required) " } ] }, "description": "Query distributed traces captured by Encore Cloud." }, "response": [ { "id": "095f9ee3-0ec5-4994-ad74-5406303e75bc", "name": "Trace list.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/apps/:app_id/traces?env=&limit=50", "host": [ "{{baseUrl}}" ], "path": [ "apps", ":app_id", "traces" ], "query": [ { "key": "env", "value": "" }, { "key": "limit", "value": "50" } ], "variable": [ { "key": "app_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"trace_id\": \"\",\n \"root_span\": \"\",\n \"endpoint\": \"\",\n \"status\": \"\",\n \"duration_ms\": \"\",\n \"started_at\": \"\"\n },\n {\n \"trace_id\": \"\",\n \"root_span\": \"\",\n \"endpoint\": \"\",\n \"status\": \"\",\n \"duration_ms\": \"\",\n \"started_at\": \"\"\n }\n]", "createdAt": "2026-07-28T01:33:57.000Z", "updatedAt": "2026-07-28T01:33:57.000Z", "uid": "35240-095f9ee3-0ec5-4994-ad74-5406303e75bc" } ], "createdAt": "2026-07-28T01:33:57.000Z", "updatedAt": "2026-07-28T01:33:57.000Z", "uid": "35240-27a20182-2296-4123-b110-b49ca717c7d6" } ], "id": "78833ecf-c994-4433-9c35-7003853a0510", "createdAt": "2026-07-28T01:33:57.000Z", "updatedAt": "2026-07-28T01:33:57.000Z", "uid": "35240-78833ecf-c994-4433-9c35-7003853a0510" } ], "id": "47770c94-0d84-40ed-a49a-743e09dfa050", "createdAt": "2026-07-28T01:33:57.000Z", "updatedAt": "2026-07-28T01:33:57.000Z", "uid": "35240-47770c94-0d84-40ed-a49a-743e09dfa050" }, { "name": "List Encore Applications", "id": "3606a429-806c-48db-b6a5-a5dce27a4321", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/apps", "host": [ "{{baseUrl}}" ], "path": [ "apps" ] }, "description": "List Encore applications the caller has access to." }, "response": [ { "id": "35259aee-25f8-40af-984c-0c4a103044a9", "name": "List of Encore applications.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/apps", "host": [ "{{baseUrl}}" ], "path": [ "apps" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"framework\": \"encore.go\",\n \"repository\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"framework\": \"encore.go\",\n \"repository\": \"\"\n }\n]", "createdAt": "2026-07-28T01:33:57.000Z", "updatedAt": "2026-07-28T01:33:57.000Z", "uid": "35240-35259aee-25f8-40af-984c-0c4a103044a9" } ], "createdAt": "2026-07-28T01:33:57.000Z", "updatedAt": "2026-07-28T01:33:57.000Z", "uid": "35240-3606a429-806c-48db-b6a5-a5dce27a4321" } ], "id": "a637ff0a-bc56-49f2-ba74-c69fe8d78a65", "createdAt": "2026-07-28T01:33:57.000Z", "updatedAt": "2026-07-28T01:33:57.000Z", "uid": "35240-a637ff0a-bc56-49f2-ba74-c69fe8d78a65" } ], "variable": [ { "key": "baseUrl", "value": "http://localhost:4000" } ] }