List stored files

GET 
/file

List all files stored in the Object Store.

Responses

200

List of stored files.

application/json

Schema

Schema

files

object[]

required

List of stored files.

Array [

name stringrequired

The name of the file.

sha256 stringrequired

SHA-256 hash of the file content.

size integerrequired

File size in bytes.

content_type stringrequired

How the file should be treated during deploy (raw or template).

]

total integerrequired

Total number of files.

Example (from schema)

{
  "files": [
    {
      "name": "nginx.conf",
      "sha256": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
      "size": 1024,
      "content_type": "raw"
    }
  ],
  "total": 5
}

401

Unauthorized - API key required

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

403

Forbidden - Insufficient permissions

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

500

Error listing files.

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

Loading...