Download carve archive

GET

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

const url = 'https://osctrl.net/api/v1/carves/example/archive/example';
const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Downloads the archive for a completed file carve.

Authorizations

ApiKeyAuth

Parameters

Path Parameters

env

required

string

Environment name or UUID

name

required

string

Carve query name

Responses

200

application/octet-stream

string format: binary

400

Bad request

application/octet-stream

object

code

string

error

string

401

Unauthorized

application/octet-stream

object

code

string

error

string

403

Forbidden

application/octet-stream

object

code

string

error

string

404

Not found

application/octet-stream

object

code

string

error

string

409

Conflict

application/octet-stream

object

code

string

error

string

429

Too many requests

application/octet-stream

object

code

string

error

string

500

Internal server error

application/octet-stream

object

code

string

error

string

503

Service unavailable

application/octet-stream

object

code

string

error

string