Outbox
Files published to a public address, with no sign-in
On this page(3 sections)
What the outbox holds and its address. Publishing copies a workspace file or folder in; withdrawing the last one removes the outbox, so its existing always means exactly "something is published". There is no route to read a published file back, because that is what the open address is for.
GET/publicWhat is published to the internet
Everything currently in the outbox and the address it answers on. There is no call to read a published file back: it is served openly to anyone with the link, which is the entire point of having put it there.
What you send
Nothing. Call it as it is.
What comes back
| Field | Type |
|---|---|
urlYour public address, which every file's… | string |
filesWhat the outbox holds | object[] |
pathWhere it sits inside the outbox | string |
sizeSize in bytes | number |
modifiedAtWhen it last changed, in milliseconds | number |
urlIts public address | string |
blockedWhy a file sitting in the… | string |
curl "$SANDBOX/public" \
-H "x-intentic-control: $INTENTIC_TOKEN"import { sandbox } from "@intentic/sandbox-client";
const result = await sandbox.public.list();POST/public/publishPut a file on the internet
Copies a workspace file or folder into the outbox, where it is served to anyone with the link and no sign-in. Answers with the address.
What you send
| Field | Type | Where |
|---|---|---|
pathrequiredWhat to publish, as a workspace… | string | body |
What comes back
| Field | Type |
|---|---|
pathWhere it landed inside the outbox | string |
urlIts public address | string |
curl -X POST "$SANDBOX/public/publish" \
-H "x-intentic-control: $INTENTIC_TOKEN" \
-H "content-type: application/json" \
-d '{"path":"src/app.ts"}'import { sandbox } from "@intentic/sandbox-client";
const result = await sandbox.public.publish({
"path": "src/app.ts"
});POST/public/unpublishTake something off the internet
Withdraws one published entry. When the last one goes, the outbox goes with it, so its existing at all always means something is published.
What you send
| Field | Type | Where |
|---|---|---|
pathrequiredWhat to withdraw, as a path… | string | body |
What comes back
| Field | Type |
|---|---|
okAlways true | true |
curl -X POST "$SANDBOX/public/unpublish" \
-H "x-intentic-control: $INTENTIC_TOKEN" \
-H "content-type: application/json" \
-d '{"path":"src/app.ts"}'import { sandbox } from "@intentic/sandbox-client";
const result = await sandbox.public.unpublish({
"path": "src/app.ts"
});