Cargo | Argon

Get all cargo

get

List all cargo items

Authorizations

Responses

200

List of cargo items

application/json

403

Forbidden

application/json

500

Server error

application/json

get

GET /api/cargo HTTP/1.1
Host: localhost:3000
Authorization: Bearer JWT
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "hash": "text",
    "size": 1,
    "mimeType": "text",
    "type": "local",
    "remoteUrl": "text",
    "properties": {
      "hidden": true,
      "readonly": true,
      "noDelete": true,
      "customProperties": {}
    },
    "createdAt": "2025-06-26T18:18:41.669Z",
    "updatedAt": "2025-06-26T18:18:41.669Z"
  }
]

Upload cargo

post

Upload a file as cargo

Authorizations

Body

filestring · binaryOptional

datastringOptional

JSON string of cargo properties

Responses

201

Cargo uploaded successfully

application/json

400

Invalid request or file

application/json

403

Forbidden

application/json

500

Server error

application/json

post

POST /api/cargo/upload HTTP/1.1
Host: localhost:3000
Authorization: Bearer JWT
Content-Type: multipart/form-data
Accept: */*
Content-Length: 31

{
  "file": "binary",
  "data": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "hash": "text",
  "size": 1,
  "mimeType": "text",
  "type": "local",
  "remoteUrl": "text",
  "properties": {
    "hidden": true,
    "readonly": true,
    "noDelete": true,
    "customProperties": {}
  },
  "createdAt": "2025-06-26T18:18:41.669Z",
  "updatedAt": "2025-06-26T18:18:41.669Z"
}

Add remote cargo

post

Add a remote URL as cargo

Authorizations

Body

namestring · min: 1 · max: 255Required

descriptionstringRequired

remoteUrlstring · uriRequired

Responses

201

Remote cargo added successfully

application/json

400

Invalid request or URL

application/json

403

Forbidden

application/json

500

Server error

application/json

post

POST /api/cargo/remote HTTP/1.1
Host: localhost:3000
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 153

{
  "name": "text",
  "description": "text",
  "remoteUrl": "https://example.com",
  "properties": {
    "hidden": true,
    "readonly": true,
    "noDelete": true,
    "customProperties": {}
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "hash": "text",
  "size": 1,
  "mimeType": "text",
  "type": "local",
  "remoteUrl": "text",
  "properties": {
    "hidden": true,
    "readonly": true,
    "noDelete": true,
    "customProperties": {}
  },
  "createdAt": "2025-06-26T18:18:41.669Z",
  "updatedAt": "2025-06-26T18:18:41.669Z"
}

Get all containers

get

List all cargo containers

Authorizations

Responses

200

List of cargo containers

application/json

403

Forbidden

application/json

500

Server error

application/json

get

GET /api/cargo/container HTTP/1.1
Host: localhost:3000
Authorization: Bearer JWT
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "items": [
      {
        "cargoId": "123e4567-e89b-12d3-a456-426614174000",
        "targetPath": "text"
      }
    ],
    "createdAt": "2025-06-26T18:18:41.669Z",
    "updatedAt": "2025-06-26T18:18:41.669Z"
  }
]

Get cargo

get

Get cargo details by ID

Authorizations

Path parameters

idstring · uuidRequired

Responses

200

Cargo details

application/json

403

Forbidden

application/json

404

Cargo not found

application/json

500

Server error

application/json

get

GET /api/cargo/{id} HTTP/1.1
Host: localhost:3000
Authorization: Bearer JWT
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "hash": "text",
  "size": 1,
  "mimeType": "text",
  "type": "local",
  "remoteUrl": "text",
  "properties": {
    "hidden": true,
    "readonly": true,
    "noDelete": true,
    "customProperties": {}
  },
  "createdAt": "2025-06-26T18:18:41.669Z",
  "updatedAt": "2025-06-26T18:18:41.669Z"
}

Delete cargo

delete

Delete a cargo item

Authorizations

Path parameters

idstring · uuidRequired

Responses

204

Cargo deleted successfully

400

Cannot delete cargo in use

application/json

403

Forbidden

application/json

404

Cargo not found

application/json

500

Server error

application/json

delete

DELETE /api/cargo/{id} HTTP/1.1
Host: localhost:3000
Authorization: Bearer JWT
Accept: */*

No content

Update cargo

patch

Update cargo properties

Authorizations

Path parameters

idstring · uuidRequired

Body

namestring · min: 1 · max: 255Optional

descriptionstringOptional

Responses

200

Cargo updated successfully

application/json

400

Invalid request

application/json

403

Forbidden

application/json

404

Cargo not found

application/json

500

Server error

application/json

patch

PATCH /api/cargo/{id} HTTP/1.1
Host: localhost:3000
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 119

{
  "name": "text",
  "description": "text",
  "properties": {
    "hidden": true,
    "readonly": true,
    "noDelete": true,
    "customProperties": {}
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "hash": "text",
  "size": 1,
  "mimeType": "text",
  "type": "local",
  "remoteUrl": "text",
  "properties": {
    "hidden": true,
    "readonly": true,
    "noDelete": true,
    "customProperties": {}
  },
  "createdAt": "2025-06-26T18:18:41.669Z",
  "updatedAt": "2025-06-26T18:18:41.669Z"
}

Download cargo

get

Download a cargo file

Authorizations

Path parameters

idstring · uuidRequired

Responses

200

Cargo file

application/octet-stream

Responsestring · binary

403

Forbidden

application/json

404

Cargo not found

application/json

500

Server error

application/json

get

GET /api/cargo/{id}/download HTTP/1.1
Host: localhost:3000
Authorization: Bearer JWT
Accept: */*

binary

Create container

post

Create a new cargo container

Authorizations

Body

namestring · min: 1 · max: 255Required

descriptionstringRequired

Responses

201

Container created successfully

application/json

400

Invalid request

application/json

403

Forbidden

application/json

404

Cargo not found

application/json

500

Server error

application/json

post

POST /api/cargo/containers HTTP/1.1
Host: localhost:3000
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "name": "text",
  "description": "text",
  "items": [
    {
      "cargoId": "123e4567-e89b-12d3-a456-426614174000",
      "targetPath": "text"
    }
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "items": [
    {
      "cargoId": "123e4567-e89b-12d3-a456-426614174000",
      "targetPath": "text"
    }
  ],
  "createdAt": "2025-06-26T18:18:41.669Z",
  "updatedAt": "2025-06-26T18:18:41.669Z"
}

Get container

get

Get container details by ID

Authorizations

Path parameters

idstring · uuidRequired

Responses

200

Container details

application/json

403

Forbidden

application/json

404

Container not found

application/json

500

Server error

application/json

get

GET /api/cargo/containers/{id} HTTP/1.1
Host: localhost:3000
Authorization: Bearer JWT
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "items": [
    {
      "cargoId": "123e4567-e89b-12d3-a456-426614174000",
      "targetPath": "text"
    }
  ],
  "createdAt": "2025-06-26T18:18:41.669Z",
  "updatedAt": "2025-06-26T18:18:41.669Z"
}

Delete container

delete

Delete a cargo container

Authorizations

Path parameters

idstring · uuidRequired

Responses

204

Container deleted successfully

403

Forbidden

application/json

404

Container not found

application/json

500

Server error

application/json

delete

DELETE /api/cargo/containers/{id} HTTP/1.1
Host: localhost:3000
Authorization: Bearer JWT
Accept: */*

No content

Update container

patch

Update container details

Authorizations

Path parameters

idstring · uuidRequired

Body

namestring · min: 1 · max: 255Required

descriptionstringRequired

Responses

200

Container updated successfully

application/json

400

Invalid request

application/json

403

Forbidden

application/json

404

Container or cargo not found

application/json

500

Server error

application/json

patch

PATCH /api/cargo/containers/{id} HTTP/1.1
Host: localhost:3000
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "name": "text",
  "description": "text",
  "items": [
    {
      "cargoId": "123e4567-e89b-12d3-a456-426614174000",
      "targetPath": "text"
    }
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "items": [
    {
      "cargoId": "123e4567-e89b-12d3-a456-426614174000",
      "targetPath": "text"
    }
  ],
  "createdAt": "2025-06-26T18:18:41.669Z",
  "updatedAt": "2025-06-26T18:18:41.669Z"
}

Assign container to unit

post

Assign a cargo container to a unit

Authorizations

Path parameters

containerIdstring · uuidRequired

unitIdstring · uuidRequired

Responses

204

Container assigned successfully

403

Forbidden

application/json

404

Container or unit not found

application/json

500

Server error

application/json

post

POST /api/cargo/containers/{containerId}/units/{unitId} HTTP/1.1
Host: localhost:3000
Authorization: Bearer JWT
Accept: */*

No content

Remove container from unit

delete

Remove a cargo container from a unit

Authorizations

Path parameters

containerIdstring · uuidRequired

unitIdstring · uuidRequired

Responses

204

Container removed successfully

403

Forbidden

application/json

404

Container or unit not found

application/json

500

Server error

application/json

delete

DELETE /api/cargo/containers/{containerId}/units/{unitId} HTTP/1.1
Host: localhost:3000
Authorization: Bearer JWT
Accept: */*

No content