Error

A valid request URL is required to generate request examples

{
  "path": "/etc",
  "patterns": [
    "^PermitRootLogin"
  ],
  "matches": [
    {
      "path": "/etc/ssh/sshd_config",
      "line_number": 57,
      "absolute_offset": 1712,
      "line_text": "#PermitRootLogin prohibit-password\n",
      "line_bytes": 8192,
      "submatches": [
        {
          "text": "PermitRootLogin",
          "start": 1,
          "end": 16
        }
      ],
      "type": "match"
    }
  ],
  "truncated": false
}

{
  "error": "Some error occurred, this is an example of error message",
  "status": 500,
  "traceback": [
    "<string>"
  ]
}

{
  "error": "Some error occurred, this is an example of error message",
  "status": 500,
  "traceback": [
    "<string>"
  ]
}

{
  "error": "Some error occurred, this is an example of error message",
  "status": 500,
  "traceback": [
    "<string>"
  ]
}

{
  "error": "Some error occurred, this is an example of error message",
  "status": 500,
  "traceback": [
    "<string>"
  ]
}

inspect

Search file contents in image

Regex content search inside the image’s root filesystem, powered by ripgrep.

Symlinks are never followed during traversal, hidden files are searched, .gitignore-style files inside the image are ignored, and binary files (containing a NUL byte) are skipped. Rust regex syntax, linear-time matching.

Results are a flat, file-ordered list of lines. before/after request extra type: context lines around each type: match line, mirroring ripgrep’s —json message type field.

path may be repeated to search multiple roots in one call, the same way pattern/glob already can; results are concatenated in the given order and share the max_total budget across all of them.

GET

inspect

{image_uuid}

grep

Error

A valid request URL is required to generate request examples

{
  "path": "/etc",
  "patterns": [
    "^PermitRootLogin"
  ],
  "matches": [
    {
      "path": "/etc/ssh/sshd_config",
      "line_number": 57,
      "absolute_offset": 1712,
      "line_text": "#PermitRootLogin prohibit-password\n",
      "line_bytes": 8192,
      "submatches": [
        {
          "text": "PermitRootLogin",
          "start": 1,
          "end": 16
        }
      ],
      "type": "match"
    }
  ],
  "truncated": false
}

{
  "error": "Some error occurred, this is an example of error message",
  "status": 500,
  "traceback": [
    "<string>"
  ]
}

{
  "error": "Some error occurred, this is an example of error message",
  "status": 500,
  "traceback": [
    "<string>"
  ]
}

{
  "error": "Some error occurred, this is an example of error message",
  "status": 500,
  "traceback": [
    "<string>"
  ]
}

{
  "error": "Some error occurred, this is an example of error message",
  "status": 500,
  "traceback": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

IAM bearer token issued by the Nebius IAM service. Sent as Authorization: Bearer <iam-token>. Must be combined with the Project header (see IAMProjectHeader).

This is the recommended authentication scheme for new clients.

Project

string

header

required

Nebius project ID associated with the IAM token. Required together with IAMBearerAuth. Identifies the project context the request is scoped to.

Path Parameters

image_uuid

string<uuid>

required

The UUID of the image to inspect A UUID string

Example:

"12345678-9abc-baba-deda-0123456789ab"

Query Parameters

pattern

string

required

Regex pattern to search for. May be repeated (max 16); patterns are OR-ed. Max 1024 characters each.

Example:

"^PermitRootLogin"

path

string

default:/

File or directory to search inside the image. May be repeated (max 16) to search multiple roots; results are concatenated in the given order, sharing max_total across all paths. Defaults to the rootfs root.

Example:

"/etc"

glob

string

Glob to filter files (ripgrep -g semantics, "!" negates). May be repeated.

Example:

"*.conf"

max_count

integer

Maximum matches per file (hard cap 10000).

Required range: 1 <= x <= 10000

max_total

integer

default:1000

Maximum total matches across all files (default 1000, hard cap 10000).

Required range: 1 <= x <= 10000

case

enum<string>

default:sensitive

Case sensitivity mode.

Available options:

sensitive,

insensitive,

smart

before

integer

default:0

Lines of context to include before each match (ripgrep -B semantics, hard cap 50). For symmetric context (grep -C n), pass both before and after yourself.

Required range: 0 <= x <= 50

after

integer

default:0

Lines of context to include after each match (ripgrep -A semantics, hard cap 50).

Required range: 0 <= x <= 50

Response

path

string

required

The first path inside the image that was searched. When path was repeated, see each row's own path for which root it actually came from.

Example:

"/etc"

patterns

string[]

required

The patterns that were searched for

Example:

["^PermitRootLogin"]

matches

object[]

required

File-ordered lines; each is a match or (when before/after are set) surrounding context

Show child attributes

truncated

boolean

required

True when max_total or the search deadline stopped the search early

Example:

false

API Documentation

Inference and Training

Sandboxes

Search file contents in image

Authorizations

Path Parameters

Query Parameters

Response