Disks

Operations for managing disks

Get Disk

Retrieve a disk by its ID

GET

https://dev.officex.app/v1/drive/{organization_id}/disks/get/{disk_id}

Run In Postman

Path Parameter

organization_id (required)	string (DriveID) Unique identifier for a drive	DriveID_abc123
disk_id (required)	string (DiskID) ID of the Disk to retrieve	DiskID_3574c5fd-9dea-4934-9dbc-f3ddb5bff1e5

Header Parameters

Authorization (required)	stringBearer TOKEN Bearer token for authentication	Bearer eyJhbGciOiJIUz...

Responses

success

{
    "ok": {
        "data": {
            "id": "DiskID_3574c5fd-9dea-4934-9dbc-f3ddb5bff1e5",
            "name": "new disk",
            "disk_type": "LOCAL_SSD",
            "private_note": null,
            "public_note": null,
            "auth_json": null,
            "created_at": 1755524581236,
            "root_folder": "FolderID_8ca1bbbe-297a-4e97-a5ea-c4699ad32e4f",
            "trash_folder": "FolderID_e082ed3b-c43a-4986-94bd-9883cb280182",
            "external_id": null,
            "external_payload": null,
            "endpoint": null,
            "autoexpire_ms": null,
            "permission_previews": [
                "CREATE",
                "VIEW",
                "EDIT",
                "DELETE",
                "INVITE"
            ],
            "labels": []
        }
    }
}

error

{
  "err": {
    "code": 0,
    "message": "string"
  }
}

Typescript Types

	type
Request	IRequestGetDisk
Response	IRequestGetDisk

---

List Disks

List disks with optional filtering and pagination

POST

https://dev.officex.app/v1/drive/{organization_id}/disks/list

Run In Postman

Header Parameters

Authorization (required)	stringBearer TOKEN Bearer token for authentication	Bearer eyJhbGciOiJIUz...

Path Parameter

organization_id (required)	string (DriveID) Unique identifier for a drive	DriveID_abc123

Request Body schema

filters	string <= 256 characters Default: "" Filter string for disks
page_size	integer [ 1 .. 1000 ] Default: 50 Number of items per page	50
direction	string Default: "ASC" Enum: "ASC" "DESC" Sort direction	ASC
cursor_up	string or null <= 256 characters Cursor for pagination (previous page)	string
cursor_down	string or null <= 256 characters Cursor for pagination (next page)	string

Responses

success

{
    "ok": {
        "data": {
            "items": [
                {
                    "id": "DiskID_3574c5fd-9dea-4934-9dbc-f3ddb5bff1e5",
                    "name": "new disk",
                    "disk_type": "LOCAL_SSD",
                    "private_note": null,
                    "public_note": null,
                    "auth_json": null,
                    "created_at": 1755524581236,
                    "root_folder": "FolderID_8ca1bbbe-297a-4e97-a5ea-c4699ad32e4f",
                    "trash_folder": "FolderID_e082ed3b-c43a-4986-94bd-9883cb280182",
                    "external_id": null,
                    "external_payload": null,
                    "endpoint": null,
                    "autoexpire_ms": null,
                    "labels": [],
                    "permission_previews": [
                        "CREATE",
                        "VIEW",
                        "EDIT",
                        "DELETE",
                        "INVITE"
                    ]
                }
            ],
            "page_size": 1,
            "total": 1,
            "direction": "ASC"
        }
    }
}

error

{
  "err": {
    "code": 0,
    "message": "string"
  }
}

Typescript Types

	type
Request	IRequestListDisks
Response	IResponseListDisks

---

Create Disk

Create a new Disk

POST

https://dev.officex.app/v1/drive/{organization_id}/disks/create

Run In Postman

Header Parameters

Authorization (required)	stringBearer TOKEN Bearer token for authentication	Bearer eyJhbGciOiJIUz...

Path Parameter

organization_id (required)	string (DriveID) Unique identifier for a drive	DriveID_abc123

Request Body schema

name (required)	string <= 256 characters Name for the disk	Project Cloud Storage
disk_type (required)	string (DiskType) Enum: "BrowserCache","LocalSSD" ,"AwsBucket" ,"StorjWeb3", "IcpCanister" Type of disk storage, currently supported	AWS_BUCKET
public_note	string or null <= 8192 characters Public note about the disk	Storage for group project files
private_note	string or null <= 8192 characters Private note about the disk	Contains sensitive project data
auth_json	string or null <= 8192 characters Authentication JSON for the disk	{"access_key": "redacted", "secret_key": "redacted", "region": "us-east-1", "bucket": "ofx-bucket-friend-696", "endpoint": "redacted"}
external_id	string (ExternalID) <= 256 characters External identifier for integration purposes	ext-disk-001
external_payload	string (ExternalPayload) <= 8192 characters Additional data for external integrations. Eg Stringified JSON	{"department": "engineering", "cost_center": "cc-12345", "project_id": "p-987654"}

Responses

success

{
    "ok": {
        "data": {
            "id": "DiskID_6320bd41-f966-4052-a067-a9f33d6dfe39",
            "name": "Project Cloud Storage",
            "disk_type": "AWS_BUCKET",
            "private_note": "Contains sensitive project data",
            "public_note": "Storage for group project files",
            "auth_json": "{\"access_key\": \"redacted\", \"secret_key\": \"redacted\", \"region\": \"us-east-1\", \"bucket\": \"ofx-bucket-friend-696\", \"endpoint\": \"redacted\"}",
            "labels": [],
            "created_at": 1755525705285,
            "root_folder": "FolderID_c9107c9a-4f1f-444f-b921-1ebce17cfbf1",
            "trash_folder": "FolderID_8110dace-1e6e-4224-93f0-47c787c7e11d",
            "external_id": "ext-disk-001",
            "external_payload": "{\"department\": \"engineering\", \"cost_center\": \"cc-12345\", \"project_id\": \"p-987654\"}",
            "permission_previews": [
                "CREATE",
                "VIEW",
                "EDIT",
                "DELETE",
                "INVITE"
            ]
        }
    }
}

error

{
  "err": {
    "code": 0,
    "message": "string"
  }
}

Typescript Types

	type
Request	IRequestCreateDisk
Response	IResponseCreateDisk

---

Update Disk

Update a disk

POST

https://dev.officex.app/v1/drive/{organization_id}/disks/update

Run In Postman

Header Parameters

Authorization (required)	stringBearer TOKEN Bearer token for authentication	Bearer eyJhbGciOiJIUz...

Path Parameter

organization_id (required)	string (DriveID) Unique identifier for a drive	DriveID_abc123

Request Body schema

id (required)	string (DiskID) Unique identifier for a disk	DiskID_6320bd41-f966-4052-a067-a9f33d6dfe39
name (required)	string <= 256 characters Name for the disk	Updated Storage Name
public_note	string or null <= 8192 characters Public note about the disk	Primary storage for project Alpha
private_note	string or null <= 8192 characters Private note about the disk	Contains confidential project data
auth_json	string or null <= 8192 characters Authentication JSON for the disk	{"endpoint": "redacted","access_key": "redacted","secret_key": "redacted", "region": "us-east-1", "bucket": "project-alpha-files"}
external_id	string (ExternalID) <= 256 characters External identifier for integration purposes	ext-disk-001-updated
external_payload	string (ExternalPayload) <= 8192 characters Additional data for external integrations. Eg Stringified JSON	{"department": "engineering", "cost_center": "cc-67890", "project_id": "p-123456", "updated": true}

Responses

success

{
    "ok": {
        "data": {
            "id": "DiskID_6320bd41-f966-4052-a067-a9f33d6dfe39",
            "name": "Updated Storage Name",
            "disk_type": "AWS_BUCKET",
            "private_note": "Contains confidential project data",
            "public_note": "Primary storage for project Alpha",
            "auth_json": "{\"endpoint\": \"redacted\",\"access_key\": \"redacted\",\"secret_key\": \"redacted\", \"region\": \"us-east-1\", \"bucket\": \"project-alpha-files\"}",
            "created_at": 1755525705285,
            "root_folder": "FolderID_c9107c9a-4f1f-444f-b921-1ebce17cfbf1",
            "trash_folder": "FolderID_8110dace-1e6e-4224-93f0-47c787c7e11d",
            "external_id": "ext-disk-001-updated",
            "external_payload": "{\"department\": \"engineering\", \"cost_center\": \"cc-67890\", \"project_id\": \"p-123456\", \"updated\": true}",
            "endpoint": null,
            "autoexpire_ms": null,
            "permission_previews": [
                "CREATE",
                "VIEW",
                "EDIT",
                "DELETE",
                "INVITE"
            ],
            "labels": []
        }
    }
}

error

{
  "err": {
    "code": 0,
    "message": "string"
  }
}

Typescript Types

	type
Request	IRequestUpdateDisk
Response	IResponseUpdateDisk

---

Delete Disk

Delete an existing disk

POST

https://dev.officex.app/v1/drive/{organization_id}/disks/delete

Run In Postman

Header Parameters

Authorization (required)	stringBearer TOKEN Bearer token for authentication	Bearer eyJhbGciOiJIUz...

Path Parameter

organization_id (required)	string (DriveID) Unique identifier for a drive	DriveID_abc123

Request Body schema

id (required)	string (DiskID) Unique identifier for a disk	DiskID_6320bd41-f966-4052-a067-a9f33d6dfe39

Responses

success

{
    "ok": {
        "data": {
            "id": "DiskID_6320bd41-f966-4052-a067-a9f33d6dfe39",
            "deleted": true
        }
    }
}

error

{
  "err": {
    "code": 0,
    "message": "string"
  }
}

Typescript Types

	type
Request	IRequestDeleteDisk
Response	IResponseDeleteDisk

---