List file carves

GET

/api/v1/carves/{env}

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

Returns paginated file carves for an environment.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

env

required

string

Environment name or UUID

Query Parameters

page

integer

Page number

page_size

integer

Page size

q

string

Search query

Responses

200

OK

Media typeapplication/json

object

items

Array<object>

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

type

string

updated_at

string

page

integer

page_size

integer

total_items

integer

total_pages

integer

Example^generated

{
  "items": [
    {
      "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",
      "type": "example",
      "updated_at": "example"
    }
  ],
  "page": 1,
  "page_size": 1,
  "total_items": 1,
  "total_pages": 1
}

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"
}