One file this export published, verified against the digest in the export row

GET

/v1/entities/{entity_id}/exports/{export_id}/artifacts/{artifact}

const url = 'https://example.com/v1/entities/example/exports/example/artifacts/example?disposition=attachment';
const options = {method: 'GET'};

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://example.com/v1/entities/example/exports/example/artifacts/example?disposition=attachment'

Return one published journal file, the form of these books other tools can read.

The name is a key into the export’s immutable artifact list, not a path. A name the export did not record is a 404 before any path is built from it, and the file is read only from under this entity’s configured export root. It is re-hashed against the sha256 the row recorded before any byte is returned. That digest is the claim that these bytes passed the pinned verifier, so a file that no longer matches is refused rather than served with a warning (:mod:haddon.api.exported).

An export published elsewhere, for example by bin/haddon-export into an operator’s own directory, is recorded here but its bytes are not served: they are not under the root this service serves from.

Parameters

Path Parameters

export_id

required

Export Id

string

artifact

required

Artifact

string

entity_id

required

Entity Id

The entity this path is relative to

string

The entity this path is relative to

Query Parameters

disposition

Disposition

A journal is plain text, so both are honoured

string

default: attachment /^(attachment|inline)$/

A journal is plain text, so both are honoured

Responses

200

One published journal file, re-hashed against what was recorded

text/plain

string format: binary

400

Bad Request

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

retryable

required

Retryable

boolean

details

required

Details

Array<object>

object

key

additional properties

any

request_id

Any of:

string
null

string

next_action

Any of:

object
null

object

key

additional properties

any

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

401

Unauthorized

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

retryable

required

Retryable

boolean

details

required

Details

Array<object>

object

key

additional properties

any

request_id

Any of:

string
null

string

next_action

Any of:

object
null

object

key

additional properties

any

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

403

Forbidden

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

retryable

required

Retryable

boolean

details

required

Details

Array<object>

object

key

additional properties

any

request_id

Any of:

string
null

string

next_action

Any of:

object
null

object

key

additional properties

any

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

404

Not Found

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

retryable

required

Retryable

boolean

details

required

Details

Array<object>

object

key

additional properties

any

request_id

Any of:

string
null

string

next_action

Any of:

object
null

object

key

additional properties

any

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

409

Conflict

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

retryable

required

Retryable

boolean

details

required

Details

Array<object>

object

key

additional properties

any

request_id

Any of:

string
null

string

next_action

Any of:

object
null

object

key

additional properties

any

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

412

Precondition Failed

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

retryable

required

Retryable

boolean

details

required

Details

Array<object>

object

key

additional properties

any

request_id

Any of:

string
null

string

next_action

Any of:

object
null

object

key

additional properties

any

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

422

Unprocessable Content

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

retryable

required

Retryable

boolean

details

required

Details

Array<object>

object

key

additional properties

any

request_id

Any of:

string
null

string

next_action

Any of:

object
null

object

key

additional properties

any

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

500

Internal Server Error

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

retryable

required

Retryable

boolean

details

required

Details

Array<object>

object

key

additional properties

any

request_id

Any of:

string
null

string

next_action

Any of:

object
null

object

key

additional properties

any

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

503

Service Unavailable

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

retryable

required

Retryable

boolean

details

required

Details

Array<object>

object

key

additional properties

any

request_id

Any of:

string
null

string

next_action

Any of:

object
null

object

key

additional properties

any

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "retryable": true,
    "details": [
      {}
    ],
    "request_id": "example",
    "next_action": {}
  }
}

One file this export published, verified against the digest in the export row

Parameters

Path Parameters

Query Parameters

Responses

200

400

Example generated

401

Example generated

403

Example generated

404

Example generated

409

Example generated

412

Example generated

422

Example generated

500

Example generated

503

Example generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated