curl
curl -sS -X POST "https://gateway.orbit/api/v1/projects/4/documents" \
--cacert /path/to/orbit-root-ca.pem \
-H 'Accept: application/json' \
-H 'X-Orbit-Request-Id: 9d6b1e5c-4a3f-4a1b-9f0e-6d2c3f5a7b81' \
-H 'Content-Type: application/json' \
-d '{"kind": "folder", "name": "example"}'{
"data": {
"id": 123,
"project_id": 123,
"kind": "<string>",
"parent_id": 123,
"name": "<string>",
"revision": 123,
"archived_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"path": "<string>",
"is_archived": true,
"current_version": {
"id": 123,
"number": 123,
"media_type": "<string>",
"size_bytes": 123,
"sha256": "<string>",
"created_at": "<string>",
"created_by_node_id": 123
}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Projects
project:document:create
Project-scoped Documents. Requires ProjectOwning Node access. See /reference/project-documents for limits, archive inheritance, revision preconditions and retry recovery. No object keys or credentials are returned.
POST
/
api
/
v1
/
projects
/
{project}
/
documents
curl
curl -sS -X POST "https://gateway.orbit/api/v1/projects/4/documents" \
--cacert /path/to/orbit-root-ca.pem \
-H 'Accept: application/json' \
-H 'X-Orbit-Request-Id: 9d6b1e5c-4a3f-4a1b-9f0e-6d2c3f5a7b81' \
-H 'Content-Type: application/json' \
-d '{"kind": "folder", "name": "example"}'{
"data": {
"id": 123,
"project_id": 123,
"kind": "<string>",
"parent_id": 123,
"name": "<string>",
"revision": 123,
"archived_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"path": "<string>",
"is_archived": true,
"current_version": {
"id": 123,
"number": 123,
"media_type": "<string>",
"size_bytes": 123,
"sha256": "<string>",
"created_at": "<string>",
"created_by_node_id": 123
}
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Path Parameters
Numeric Project ID.
Required range:
x >= 1Body
application/json
- Option 1
- Option 2
- Option 3
folder or file
Available options:
folder, file Allowed value:
"folder"Document name
Required range:
x >= 1Exact UTF-8 text without NUL; decoded UTF-8 size is at most 1 MiB.
Maximum string length:
1048576Canonical RFC 4648 base64; decoded size is at most 10 MiB.
Maximum string length:
13981016Media type
Maximum string length:
127