S3

S3 filesystems are only accessible via HTTP their configured mountpoint. Use the POST or PUT method with the path to that file to (over-)write a file. The body of the request contains the contents of the file. No particular encoding or Content-Type is required. The file can then be downloaded from the same path.

This filesystem is practical rarely changing data (e.g. VOD) for long term storage.

On this page and in the examples we assume that a S3 storage with the name aws is mounted on /awsfs.

PUT/POST

curl http://127.0.0.1:8080/awsfs/path/to/a/file.txt -X PUT -d @somefile.txt

GET

curl http://127.0.0.1:8080/awsfs/path/to/a/file.txt -o file.txt

DELETE

curl http://127.0.0.1:8080/awsfs/path/to/a/file.txt -X DELETE

The returned Content-Type is based solely on the file extension. For a list of known mime-types and their extensions see storage.mime_types in the configuration.

Access protection

It is strongly recommended to enable a username/password (HTTP Basic-Auth) protection for any PUT/POST and DELETE operations on /memfs. GET operations are not protected.

S3

By default HTTP Basic-Auth is not enabled.

API

The contents of the S3 filesystem mounted on /awsfs are also accessible via the API in the same way as described above, but with the same protection as the API (see API-Security configuration) for all operations. It is also possible to list all files that are currently in the filesystem.

Create, Update

Example:

Curl

echo 'test' > example.txt && \
curl http://127.0.0.1:8080/api/v3/fs/aws/example.txt \
   -d @example.txt \
   -X PUT

PyClient

from core_client import Client

client = Client(base_url="http://127.0.0.1:8080")
client.login()

client.v3_fs_put_file(
    name: "aws",
    path: "example.txt",
    data: b"test"
)

GoClient

import (
    "strings"
    "github.com/datarhei/core-client-go/v16"
)

client, _ := coreclient.New(coreclient.Config{
    Address: "https://127.0.0.1:8080",
})

data := strings.NewReader("test")
err := client.FilesystemAddFile("aws", "/example.txt", data)

The contents for the upload has to be provided as an io.Reader.

After the successful upload the file is available at /awsfs/example.txt and /api/v3/fs/aws/example.txt.

Description:

Add a file to a filesystem

Writes or overwrites a file on a filesystem

PUT//api/v3/fs/{name}/{path}

Authorization

ApiKeyAuth

Path parameters

name*string

Name of the filesystem

path*string

Path to file

Body

application/data

File data

itemsinteger

Response

201204507

Created

Body

text/plainapplication/json

string

Request

JavaScriptCurlPython

const response = await fetch('//api/v3/fs/{name}/{path}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/data"
    },
    body: JSON.stringify([
      0
    ]),
});
const data = await response.json();

Response

201204507

text

Read

List all files

Listing all currently stored files is done by calling /api/v3/fs/aws. It also accepts the query parameters pattern, sort (name, size, or lastmod) and order (asc or desc). If none of the parameters are given, all files will be listed sorted by their last modification time in ascending order.

With the pattern parameter you can filter the list based on a glob pattern, with the addition of the ** placeholder to include multiple subdirectories, e.g. listing all .ts file in the root directory has the pattern /*.ts, listing all .ts file in the whole filesystem has the pattern /**.ts.

Example:

Curl

curl "http://127.0.0.1:8080/api/v3/fs/aws?sort=name&order=asc" \
   -X GET

PyClient

from core_client import Client

client = Client(base_url="http://127.0.0.1:8080")
client.login()

core_memfs_list = client.v3_fs_get_file_list(name="aws")
print(core_memfs_list)

GoClient

import (
    "fmt"
    "github.com/datarhei/core-client-go/v16"
)

client, _ := coreclient.New(coreclient.Config{
    Address: "https://127.0.0.1:8080",
})

files, err := client.FilesystemList("aws", "/*.", coreclient.SORT_NAME, coreclient.ORDER_ASC)

for _, file := range files {
    fmt.Printf("%+v\n", file)
}

Description:

List all files on a filesystem

List all files on a filesystem. The listing can be ordered by name, size, or date of last modification in ascending or descending order.

GET//api/v3/fs/{name}

Authorization

ApiKeyAuth

Path parameters

name*string

Name of the filesystem

Query parameters

Response

200

OK

Body

application/json

last_modifiedinteger (int64)

namestring

size_bytesinteger (int64)

Request

JavaScriptCurlPython

const response = await fetch('//api/v3/fs/{name}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "last_modified": 0,
    "name": "text",
    "size_bytes": 0
  }
]

Download a file

For downloading a file you have to specify the complete path and filename. The Content-Type will always be application/data.

Example:

Curl

curl http://127.0.0.1:8080/api/v3/fs/aws/example.txt \
   -X GET

PyClient

from core_client import Client

client = Client(base_url="http://127.0.0.1:8080")
client.login()

core_memfs_file = client.v3_fs_get_file(
    name="aws",
    path="example.txt"
)
print(core_memfs_file)

GoClient

import (
    "github.com/datarhei/core-client-go/v16"
)

client, _ := coreclient.New(coreclient.Config{
    Address: "https://127.0.0.1:8080",
})

data, err := client.FilesystemGetFile("aws", "/example.txt")
defer data.Close()

The returned data is an io.ReadCloser.

Description:

Fetch a file from a filesystem

Fetch a file from a filesystem

GET//api/v3/fs/{name}/{path}

Authorization

ApiKeyAuth

Path parameters

name*string

Name of the filesystem

path*string

Path to file

Response

200301404

OK

Body

application/dataapplication/json

string (binary)

Request

JavaScriptCurlPython

const response = await fetch('//api/v3/fs/{name}/{path}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200301404

binary

Delete

For deleting a file you have to specify the complete path and filename.

Example:

Curl

curl http://127.0.0.1:8080/api/v3/fs/aws/example.txt \
   -X DELETE

PyClient

from core_client import Client

client = Client(base_url="http://127.0.0.1:8080")
client.login()

client.v3_fs_delete_file(
    name="aws",
    path="example.txt"
)

GoClient

import (
    "github.com/datarhei/core-client-go/v16"
)

client, _ := coreclient.New(coreclient.Config{
    Address: "https://127.0.0.1:8080",
})

err := client.FilesystemDeleteFile("aws", "/example.txt")

Description:

Remove a file from a filesystem

Remove a file from a filesystem

DELETE//api/v3/fs/{name}/{path}

Authorization

ApiKeyAuth

Path parameters

name*string

Name of the filesystem

path*string

Path to file

Response

200404

OK

Body

text/plain

string

Request

JavaScriptCurlPython

const response = await fetch('//api/v3/fs/{name}/{path}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200404

text

Configuration

S3