Referencia de la APIEndpointsApplications
Preview a public repository or template
Read a public GitHub repository, or a template, and preview what it would deploy. Public: no token needed. Answers 429 when GitHub's rate limit, shared by every caller, runs out. Signed in, use inspectSource.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/api/inspect" \ -H "Content-Type: application/json" \ -d '{ "repoUrl": "string" }'{ "owner": "string", "repo": "string", "defaultBranch": "string", "hasDockerfile": true, "deployable": true, "template": { "services": { "property1": { "image": "string", "build": "string", "entrypoint": "string", "command": "string", "environment": { "property1": "string", "property2": "string" }, "env_file": ".env", "ports": [ 1 ], "expose": [ 1 ], "volumes": [ "string" ], "healthcheck": { "test": "string", "interval": "string", "timeout": "string", "start_period": "string", "retries": 1, "disable": true }, "configs": [ "string" ], "depends_on": [ "string" ], "deploy": { "replicas": 0, "resources": { "reservations": { "cpus": 0, "memory": 0 }, "limits": { "cpus": 0, "memory": 0 } } }, "profiles": [ "string" ] }, "property2": { "image": "string", "build": "string", "entrypoint": "string", "command": "string", "environment": { "property1": "string", "property2": "string" }, "env_file": ".env", "ports": [ 1 ], "expose": [ 1 ], "volumes": [ "string" ], "healthcheck": { "test": "string", "interval": "string", "timeout": "string", "start_period": "string", "retries": 1, "disable": true }, "configs": [ "string" ], "depends_on": [ "string" ], "deploy": { "replicas": 0, "resources": { "reservations": { "cpus": 0, "memory": 0 }, "limits": { "cpus": 0, "memory": 0 } } }, "profiles": [ "string" ] } }, "volumes": { "property1": null, "property2": null }, "configs": { "property1": { "content": "string", "file": "string" }, "property2": { "content": "string", "file": "string" } } }, "templateFile": "string", "templateError": "string", "envSchema": { "property1": { "type": "string", "title": "string", "description": "string", "default": null, "enum": [ null ], "secret": true, "generate": "string" }, "property2": { "type": "string", "title": "string", "description": "string", "default": null, "enum": [ null ], "secret": true, "generate": "string" } }, "profileSchema": { "property1": { "title": "string", "description": "string", "type": "string", "enum": [ "string" ], "items": { "enum": [ "string" ] }, "default": "string" }, "property2": { "title": "string", "description": "string", "type": "string", "enum": [ "string" ], "items": { "enum": [ "string" ] }, "default": "string" } }, "appSchema": { "type": "shared", "envSchema": { "property1": { "type": "string", "title": "string", "description": "string", "default": null, "enum": [ null ], "secret": true, "generate": "string" }, "property2": { "type": "string", "title": "string", "description": "string", "default": null, "enum": [ null ], "secret": true, "generate": "string" } }, "profileSchema": { "property1": { "title": "string", "description": "string", "type": "string", "enum": [ "string" ], "items": { "enum": [ "string" ] }, "default": "string" }, "property2": { "title": "string", "description": "string", "type": "string", "enum": [ "string" ], "items": { "enum": [ "string" ] }, "default": "string" } } }, "reason": "private_or_missing"}Read a trace GET
Returns the spans the workspace's apps sent in a trace, in tree order, with each span's service, timing, status, first exception and attributes. Spans from outside the workspace are left out. Answers 404 when no span of the trace belongs to the workspace, it was sampled out, or it is older than 7 days.
Inspect a source and preview its template POST
Página siguiente