API Reference
Devbox
Account-level Artifacts
Blueprint
Repo Connections
- The Repository Object
- GETList available repository connections.
- POSTCreate a Repository Connection.
- GETGet Repository Connection details.
- POSTTrigger an inspection against given repository connection.
- POSTCreate and build a Blueprint from a RepositoryConnection Inspection.
- POSTAdd user-defined manifest to repository inspection.
- POSTDelete a Repository Connection and associated objects.
- GETList repository inspections.
- POSTRefresh a repository connection.
- GET
Code Scenario
Benchmark
import Runloop from '@runloop/api-client';
const client = new Runloop({
bearerToken: process.env['RUNLOOP_API_KEY'], // This is the default and can be omitted
});
const repositoryInspectionListView = await client.repositories.listInspections('id');
console.log(repositoryInspectionListView.inspections);{
"inspections": [
{
"id": "<string>",
"commit_sha": "<string>",
"inspected_at": 123,
"repository_manifest": {
"container_config": {
"base_image_name": "<string>",
"setup_commands": [
"<string>"
],
"architecture": "x86_64"
},
"workspaces": [
{
"build_tool": [
"<string>"
],
"name": "<string>",
"path": "<string>",
"workspace_setup_commands": [
"<string>"
],
"workspace_refresh_commands": [
"<string>"
],
"dev_commands": {
"install": [
"<string>"
],
"build": [
"<string>"
],
"test": [
"<string>"
],
"lint": [
"<string>"
],
"scripts": [
"<string>"
]
}
}
],
"languages": [
{
"language": "<string>",
"version": "<string>"
}
],
"containerized_services": [
{
"name": "<string>",
"image": "<string>",
"credentials": {
"username": "<string>",
"password": "<string>"
},
"env": {},
"port_mappings": [
"<string>"
],
"options": "<string>"
}
],
"required_env_vars": [
"<string>"
],
"env_vars": {}
},
"status": "invalid",
"user_manifest": {
"container_config": {
"base_image_name": "<string>",
"setup_commands": [
"<string>"
],
"architecture": "x86_64"
},
"workspaces": [
{
"build_tool": [
"<string>"
],
"name": "<string>",
"path": "<string>",
"workspace_setup_commands": [
"<string>"
],
"workspace_refresh_commands": [
"<string>"
],
"dev_commands": {
"install": [
"<string>"
],
"build": [
"<string>"
],
"test": [
"<string>"
],
"lint": [
"<string>"
],
"scripts": [
"<string>"
]
}
}
],
"languages": [
{
"language": "<string>",
"version": "<string>"
}
],
"containerized_services": [
{
"name": "<string>",
"image": "<string>",
"credentials": {
"username": "<string>",
"password": "<string>"
},
"env": {},
"port_mappings": [
"<string>"
],
"options": "<string>"
}
],
"required_env_vars": [
"<string>"
],
"env_vars": {}
},
"build_status": "image_building",
"blueprint_id": "<string>",
"blueprint_name": "<string>",
"workflow_contexts": {}
}
]
}List repository inspections.
List all inspections of a repository connection including automatically generated insights for each inspection.
import Runloop from '@runloop/api-client';
const client = new Runloop({
bearerToken: process.env['RUNLOOP_API_KEY'], // This is the default and can be omitted
});
const repositoryInspectionListView = await client.repositories.listInspections('id');
console.log(repositoryInspectionListView.inspections);{
"inspections": [
{
"id": "<string>",
"commit_sha": "<string>",
"inspected_at": 123,
"repository_manifest": {
"container_config": {
"base_image_name": "<string>",
"setup_commands": [
"<string>"
],
"architecture": "x86_64"
},
"workspaces": [
{
"build_tool": [
"<string>"
],
"name": "<string>",
"path": "<string>",
"workspace_setup_commands": [
"<string>"
],
"workspace_refresh_commands": [
"<string>"
],
"dev_commands": {
"install": [
"<string>"
],
"build": [
"<string>"
],
"test": [
"<string>"
],
"lint": [
"<string>"
],
"scripts": [
"<string>"
]
}
}
],
"languages": [
{
"language": "<string>",
"version": "<string>"
}
],
"containerized_services": [
{
"name": "<string>",
"image": "<string>",
"credentials": {
"username": "<string>",
"password": "<string>"
},
"env": {},
"port_mappings": [
"<string>"
],
"options": "<string>"
}
],
"required_env_vars": [
"<string>"
],
"env_vars": {}
},
"status": "invalid",
"user_manifest": {
"container_config": {
"base_image_name": "<string>",
"setup_commands": [
"<string>"
],
"architecture": "x86_64"
},
"workspaces": [
{
"build_tool": [
"<string>"
],
"name": "<string>",
"path": "<string>",
"workspace_setup_commands": [
"<string>"
],
"workspace_refresh_commands": [
"<string>"
],
"dev_commands": {
"install": [
"<string>"
],
"build": [
"<string>"
],
"test": [
"<string>"
],
"lint": [
"<string>"
],
"scripts": [
"<string>"
]
}
}
],
"languages": [
{
"language": "<string>",
"version": "<string>"
}
],
"containerized_services": [
{
"name": "<string>",
"image": "<string>",
"credentials": {
"username": "<string>",
"password": "<string>"
},
"env": {},
"port_mappings": [
"<string>"
],
"options": "<string>"
}
],
"required_env_vars": [
"<string>"
],
"env_vars": {}
},
"build_status": "image_building",
"blueprint_id": "<string>",
"blueprint_name": "<string>",
"workflow_contexts": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Repo Connection ID
Response
OK
List of inspections for this repository.
Show child attributes
Show child attributes
The ID of the inspection.
The sha of the inspected version of the Repository.
Inspection time of the Repository Version (Unix timestamp milliseconds).
Repository manifest containing container config and workspace details.
Show child attributes
Show child attributes
Container configuration specifying the base image and setup commands.
Show child attributes
Show child attributes
The name of the base image. Should be one of the GitHub public images like ubuntu-latest, ubuntu-24.04, ubuntu-22.04, windows-latest, windows-2022, macos-latest etc.
Commands to run to setup the base container such as installing necessary toolchains (e.g. apt install).
The target architecture for the Repository Container.
x86_64, arm64 List of workspaces within the repository. Each workspace represents a buildable unit of code.
Show child attributes
Show child attributes
Name of the build tool used (e.g. pip, npm).
Name of the workspace. Can be empty if the workspace is the root of the repository. Only necessary for monorepo style repositories.
Path to the workspace from the root of the repository. Can be empty if the workspace is the root of the repository. Only necessary for monorepo style repositories.
Commands to run to setup this workspace after a fresh clone of the repository on a new container such as installing necessary toolchains and dependencies (e.g. npm install).
Commands to run to refresh this workspace after pulling the latest changes to the repository via git (e.g. npm install).
Extracted common commands important to the developer life cycle like linting, testing, building, etc.
Show child attributes
Show child attributes
Installation command (e.g. pip install -r requirements.txt).
Build command (e.g. npm run build).
Test command (e.g. pytest).
Lint command (e.g. flake8).
Script commands.
List of discovered ContainerizedServices. Services can be explicitly started when creating a Devbox.
Show child attributes
Show child attributes
The name of the container service.
The image of the container service.
The credentials of the container service.
The port mappings of the container service. Port mappings are in the format of <host_port>:<container_port>.
Additional Docker container create options.
Missing environment variables that (may) be required for this repository to run correctly.
The status of the repository inspection.
invalid, repo_auth_pending, repo_authentication_failure, repo_access_failure, inspection_pending, inspection_failed, inspection_success, inspection_user_manifest_added User uploaded repository manifest containing container config and workspace details.
Show child attributes
Show child attributes
Container configuration specifying the base image and setup commands.
Show child attributes
Show child attributes
The name of the base image. Should be one of the GitHub public images like ubuntu-latest, ubuntu-24.04, ubuntu-22.04, windows-latest, windows-2022, macos-latest etc.
Commands to run to setup the base container such as installing necessary toolchains (e.g. apt install).
The target architecture for the Repository Container.
x86_64, arm64 List of workspaces within the repository. Each workspace represents a buildable unit of code.
Show child attributes
Show child attributes
Name of the build tool used (e.g. pip, npm).
Name of the workspace. Can be empty if the workspace is the root of the repository. Only necessary for monorepo style repositories.
Path to the workspace from the root of the repository. Can be empty if the workspace is the root of the repository. Only necessary for monorepo style repositories.
Commands to run to setup this workspace after a fresh clone of the repository on a new container such as installing necessary toolchains and dependencies (e.g. npm install).
Commands to run to refresh this workspace after pulling the latest changes to the repository via git (e.g. npm install).
Extracted common commands important to the developer life cycle like linting, testing, building, etc.
Show child attributes
Show child attributes
Installation command (e.g. pip install -r requirements.txt).
Build command (e.g. npm run build).
Test command (e.g. pytest).
Lint command (e.g. flake8).
Script commands.
List of discovered ContainerizedServices. Services can be explicitly started when creating a Devbox.
Show child attributes
Show child attributes
The name of the container service.
The image of the container service.
The credentials of the container service.
The port mappings of the container service. Port mappings are in the format of <host_port>:<container_port>.
Additional Docker container create options.
Missing environment variables that (may) be required for this repository to run correctly.
The status of the linked Blueprint build.
image_building, image_build_success, image_build_failure The blueprint ID associated with this inspection if successful.
The blueprint name associated with this inspection if successful.
Workflow contexts mapping workflow names to their processing details.
Show child attributes
Show child attributes
Workflow context containing file name and details about actions processing during inspection.
Show child attributes
Show child attributes
The file name of the workflow.
Details about actions processing for this workflow.
Show child attributes
Show child attributes
Actions that were translated into commands and executed.
Actions that were skipped because they were unnecessary (e.g., upload artifacts).
Actions that were not understood and skipped because we did not know what to do.
Was this page helpful?