Desk

Read one file of a hosted project

UTF-8 text and the hash of its bytes. A file that is not text answers error: binary.

get/api/v0/desk/projects/{project_id}/file

Request

Base URL
https://api.outerport.com (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/outerport/apis/outerport-api/docs/api/v0/desk/projects/:project_id/file/get.ts
A function with typed inputs. Its response is checked against the schema.

project_idstring uuid required

pathstring required

Path relative to the project root.

Successful Response

pathstring required

contentstring nullable

sha256string required

sizeinteger

truncatedboolean

errorstring nullable