Skip to main content
POST
/
v1
/
repositories
/
{id}
/
inspect
JavaScript
import Runloop from '@runloop/api-client';

const client = new Runloop({
  bearerToken: 'My Bearer Token',
});

const repositoryInspectionDetails = await client.repositories.inspect('id');

console.log(repositoryInspectionDetails.id);
{
  "id": "<string>",
  "commit_sha": "<string>",
  "inspected_at": 123,
  "repository_manifest": {
    "container_config": {
      "base_image_name": "<string>",
      "setup_commands": [
        "<string>"
      ],
      "architecture": "x86_64"
    },
    "workspaces": [
      {
        "name": "<string>",
        "path": "<string>",
        "build_tool": [
          "<string>"
        ],
        "workspace_setup_commands": [
          "<string>"
        ],
        "workspace_refresh_commands": [
          "<string>"
        ],
        "dev_commands": {
          "install": [
            "<string>"
          ],
          "build": [
            "<string>"
          ],
          "test": [
            "<string>"
          ],
          "lint": [
            "<string>"
          ],
          "scripts": [
            "<string>"
          ]
        }
      }
    ],
    "containerized_services": [
      {
        "name": "<string>",
        "image": "<string>",
        "credentials": {
          "username": "<string>",
          "password": "<string>"
        },
        "env": {},
        "port_mappings": [
          "<string>"
        ],
        "options": "<string>"
      }
    ],
    "languages": [
      {
        "language": "<string>",
        "version": "<string>"
      }
    ],
    "required_env_vars": [
      "<string>"
    ],
    "env_vars": {}
  },
  "user_manifest": {
    "container_config": {
      "base_image_name": "<string>",
      "setup_commands": [
        "<string>"
      ],
      "architecture": "x86_64"
    },
    "workspaces": [
      {
        "name": "<string>",
        "path": "<string>",
        "build_tool": [
          "<string>"
        ],
        "workspace_setup_commands": [
          "<string>"
        ],
        "workspace_refresh_commands": [
          "<string>"
        ],
        "dev_commands": {
          "install": [
            "<string>"
          ],
          "build": [
            "<string>"
          ],
          "test": [
            "<string>"
          ],
          "lint": [
            "<string>"
          ],
          "scripts": [
            "<string>"
          ]
        }
      }
    ],
    "containerized_services": [
      {
        "name": "<string>",
        "image": "<string>",
        "credentials": {
          "username": "<string>",
          "password": "<string>"
        },
        "env": {},
        "port_mappings": [
          "<string>"
        ],
        "options": "<string>"
      }
    ],
    "languages": [
      {
        "language": "<string>",
        "version": "<string>"
      }
    ],
    "required_env_vars": [
      "<string>"
    ],
    "env_vars": {}
  },
  "status": "invalid",
  "build_status": "image_building",
  "blueprint_id": "<string>",
  "blueprint_name": "<string>",
  "workflow_contexts": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Repo Connection ID

Body

application/json
​
github_auth_token
string | null

GitHub authentication token for accessing private repositories.

Response

200 - application/json

OK

​
id
string
required

The ID of the inspection.

​
commit_sha
string
required

The sha of the inspected version of the Repository.

​
inspected_at
integer
required

Inspection time of the Repository Version (Unix timestamp milliseconds).

​
repository_manifest
object
required

Repository manifest containing container config and workspace details.

​
status
enum<string>
required

The status of the repository inspection.

Available options:
invalid,
repo_auth_pending,
repo_authentication_failure,
repo_access_failure,
inspection_pending,
inspection_failed,
inspection_success,
inspection_user_manifest_added
​
user_manifest
object

User uploaded repository manifest containing container config and workspace details.

​
build_status
enum<string>

The status of the linked Blueprint build.

Available options:
image_building,
image_build_success,
image_build_failure
​
blueprint_id
string | null

The blueprint ID associated with this inspection if successful.

​
blueprint_name
string | null

The blueprint name associated with this inspection if successful.

​
workflow_contexts
object | null

Workflow contexts mapping workflow names to their processing details.