Get file carve

GET

/api/v1/carves/{env}/{name}

curl --request GET \
  --url https://osctrl.net/api/v1/carves/example/example \
  --header 'Authorization: <Authorization>'

Returns a file carve and the files produced by it.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

env

required

string

Environment name or UUID

name

required

string

Carve query name

Responses

200

OK

Media typeapplication/json

object

files

Array<object>

object

archived

boolean

block_size

integer

carve_id

string

carve_size

integer

completed_at

string

completed_blocks

integer

created_at

string

path

string

session_id

string

status

string

total_blocks

integer

uuid

string

query

object

active

boolean

carve_status

string

completed

boolean

created_at

string

creator

string

deleted

boolean

environment_id

integer

errors

integer

executions

integer

expected

integer

expiration

string

expired

boolean

extra_data

string

hidden

boolean

id

integer

name

string

path

string

protected

boolean

query

string

target

string

targets

Array<object>

object

type

string

value

string

type

string

updated_at

string

Example^generated

{
  "files": [
    {
      "archived": true,
      "block_size": 1,
      "carve_id": "example",
      "carve_size": 1,
      "completed_at": "example",
      "completed_blocks": 1,
      "created_at": "example",
      "path": "example",
      "session_id": "example",
      "status": "example",
      "total_blocks": 1,
      "uuid": "example"
    }
  ],
  "query": {
    "active": true,
    "carve_status": "example",
    "completed": true,
    "created_at": "example",
    "creator": "example",
    "deleted": true,
    "environment_id": 1,
    "errors": 1,
    "executions": 1,
    "expected": 1,
    "expiration": "example",
    "expired": true,
    "extra_data": "example",
    "hidden": true,
    "id": 1,
    "name": "example",
    "path": "example",
    "protected": true,
    "query": "example",
    "target": "example",
    "targets": [
      {
        "type": "example",
        "value": "example"
      }
    ],
    "type": "example",
    "updated_at": "example"
  }
}

400

Bad request

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

401

Unauthorized

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

403

Forbidden

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

404

Not found

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

409

Conflict

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

429

Too many requests

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

500

Internal server error

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

503

Service unavailable

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}