Fivemanage

https://docs.fivemanage.com
Admin
Fivemanage provides API references, SDKs, and integration guides for developers to manage digital...
Tokens:35,464
Snippets:325
Trust Score:6.5
Update:3 months ago
Show doc for...
Tokens:
Raw
### Quickstart

Source: https://docs.fivemanage.com/llms.txt

Start using Fivemanage in a couple of steps.

```APIDOC
## Quickstart

### Description
Start using Fivemanage in a couple steps.

### Endpoint
/quickstart.md
```

--------------------------------

### File Uploads - First Steps

Source: https://docs.fivemanage.com/llms.txt

Guide to getting started with uploading files to Fivemanage.

```APIDOC
## Uploading Files - First Steps

### Description
Follow this guide to start uploading files to Fivemanage.

### Endpoint
/guides/uploading-files/first-steps.md
```

--------------------------------

### Fivemanage Lite - Quickstart

Source: https://docs.fivemanage.com/llms.txt

Get Fivemanage Lite up and running in minutes using Docker.

```APIDOC
## Fivemanage Lite - Quickstart

### Description
Get Fivemanage Lite up and running in minutes using Docker.

### Endpoint
/lite/guides/quickstart.md
```

--------------------------------

### Run Backend Development Server

Source: https://docs.fivemanage.com/lite/guides/contributing

Start the backend development server using Air for hot-reloading. Ensure Air is installed.

```bash
air
```

--------------------------------

### Install Frontend Dependencies

Source: https://docs.fivemanage.com/lite/guides/contributing

Navigate to the web directory and install frontend dependencies using pnpm. This is required for frontend development.

```bash
cd web
pnpm install
cd ..
```

--------------------------------

### Start Development Infrastructure with Docker

Source: https://docs.fivemanage.com/lite/guides/contributing

Use Docker Compose to start the required local infrastructure, including databases like Postgres, ClickHouse, and MinIO. Ensure Docker is running.

```bash
docker compose -f deployments/docker-compose.yml up -d
```

--------------------------------

### Example config.json for Fivemanage SDK

Source: https://docs.fivemanage.com/fivem-sdk/configuration

An example configuration file demonstrating how to set up logging levels, console output, cloud logging, player identifier exclusions, and enable automatic logging for player events, chat events, and ox_inventory events.

```json
{
  "$schema": "./config.schema.json",
  "logs": {
    "level": "info",
    "levels": ["error", "warn", "info", "debug"],
    "console": true,
    "enableCloudLogging": true,
    "appendPlayerIdentifiers": true,
    "excludedPlayerIdentifiers": ["ip"],
    "excludeInDepthMetadata": false,
    "playerEvents": {
      "enabled": true,
      "dataset": "connections"
    },
    "chatEvents": {
      "enabled": false,
      "dataset": "chat"
    },
    "oxInventoryEvents": {
      "enabled": true,
      "dataset": "inventory"
    }
  }
}
```

--------------------------------

### Hytale SDK - Installation

Source: https://docs.fivemanage.com/llms.txt

Instructions on how to install the Fivemanage Logger plugin on your Hytale server.

```APIDOC
## Hytale SDK - Installation

### Description
How to install the Fivemanage Logger plugin on your Hytale server.

### Endpoint
/hytale-sdk/installation.md
```

--------------------------------

### Production-Ready MinIO with Docker Compose

Source: https://docs.fivemanage.com/lite/guides/logs-storage/minio

Integrate MinIO into your stack using Docker Compose for a more robust setup. This example includes persistent storage and essential environment variables.

```yaml
services:
  minio:
    image: minio/minio:latest
    container_name: lite-minio
    restart: always
    ports:
      - "9000:9000"   # API Port
      - "9001:9001"   # Console Port
    environment:
      MINIO_ROOT_USER: minioadmin
      MINIO_ROOT_PASSWORD: your_secure_password
    command: server /data --console-address ":9001"
    volumes:
      - minio_data:/data

volumes:
  minio_data:

```

--------------------------------

### Ensure Fivem-SDK and Dependencies

Source: https://docs.fivemanage.com/fivem-sdk/installation

Add these lines to your server.cfg to ensure the Fivem-SDK and its dependencies are loaded correctly. Ensure screenshot-basic starts before fmsdk.

```cfg
ensure screenshot-basic
ensure fmsdk
```

--------------------------------

### Clone Fivemanage Lite Repository

Source: https://docs.fivemanage.com/lite/guides/contributing

Clone the project repository to your local machine. Navigate into the cloned directory to proceed with setup.

```bash
git clone https://github.com/fivemanage/fivemanage-lite.git
cd fivemanage-lite
```

--------------------------------

### List All Files using Go

Source: https://docs.fivemanage.com/api-reference/files/list-all-files

A Go program to list all files, demonstrating how to create an HTTP GET request, set the Authorization header, and read the response body.

```go
package main  
  
import (  
	"fmt"
	"net/http"
	"io"
)
  
func main() {  
  
	url := "https://api.fivemanage.com/api/v3/file"  
  
	req, _ := http.NewRequest("GET", url, nil)  
  
	req.Header.Add("Authorization", "<api-key>")  
  
	res, _ := http.DefaultClient.Do(req)  
  
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)  
  
	fmt.Println(string(body))  
  
}
```

--------------------------------

### Run Frontend Development Server

Source: https://docs.fivemanage.com/lite/guides/contributing

Navigate to the web directory and start the frontend development server using `pnpm dev`. This command is used for frontend development.

```bash
cd web
pnpm dev
```

--------------------------------

### Fivemanage Lite - ClickHouse Setup

Source: https://docs.fivemanage.com/llms.txt

Configure ClickHouse for high-performance log ingestion in Fivemanage Lite.

```APIDOC
## Fivemanage Lite - ClickHouse Setup

### Description
Configure ClickHouse for high-performance log ingestion.

### Endpoint
/lite/guides/logs-storage/clickhouse.md
```

--------------------------------

### Run Basic MinIO Instance with Docker

Source: https://docs.fivemanage.com/lite/guides/logs-storage/minio

Use this command to start a single MinIO instance for testing or development. It maps the API and console ports and sets default credentials.

```bash
docker run -d \
  --name minio \
  -p 9000:9000 \
  -p 9001:9001 \
  -e MINIO_ROOT_USER=minioadmin \
  -e MINIO_ROOT_PASSWORD=minioadmin123 \
  -v minio_data:/data \
  minio/minio:latest server /data --console-address ":9001"

```

--------------------------------

### Fivemanage Lite - MinIO Setup

Source: https://docs.fivemanage.com/llms.txt

Configure MinIO for self-hosted S3-compatible storage in Fivemanage Lite.

```APIDOC
## Fivemanage Lite - MinIO Setup

### Description
Configure MinIO for self-hosted S3-compatible storage.

### Endpoint
/lite/guides/logs-storage/minio.md
```

--------------------------------

### File Uploads - Videos

Source: https://docs.fivemanage.com/llms.txt

Guide on how to upload videos through the Fivemanage API.

```APIDOC
## Uploading Files - Videos

### Description
How to upload videos through our API.

### Endpoint
/guides/uploading-files/videos.md
```

--------------------------------

### Run Basic ClickHouse Instance with Docker

Source: https://docs.fivemanage.com/lite/guides/logs-storage/clickhouse

Use this command to start a standalone ClickHouse server using the official Docker image. It maps ports and sets up a named volume for data persistence.

```bash
docker run -d \
  --name clickhouse-server \
  --ulimit nofile=262144:262144 \
  -p 8123:8123 \
  -p 9000:9000 \
  -e CLICKHOUSE_PASSWORD=password \
  -v clickhouse_data:/var/lib/clickhouse \
  clickhouse/clickhouse-server:latest
```

--------------------------------

### Hytale SDK - Usage

Source: https://docs.fivemanage.com/llms.txt

Guide on how to use the Fivemanage Logger API in your own Hytale mods.

```APIDOC
## Hytale SDK - Usage

### Description
How to use the Fivemanage Logger API in your own Hytale mods.

### Endpoint
/hytale-sdk/usage.md
```

--------------------------------

### List All Files using Go

Source: https://docs.fivemanage.com/api-reference/files/list-all-files

This Go program retrieves the list of all files. It makes an HTTP GET request to the API endpoint. Replace `<api-key>` with your actual API key.

```go
package main  
  
import (  
	"fmt"  
	"net/http"  
	"io"  
)  
  
func main() {  
  
	url := "https://api.fivemanage.com/api/v3/file"  
  
	req, _ := http.NewRequest("GET", url, nil)  
  
	req.Header.Add("Authorization", "<api-key>")  
  
	res, _ := http.DefaultClient.Do(req)  
  
	defer res.Body.Close()  
	body, _ := io.ReadAll(res.Body)  
  
	fmt.Println(string(body))  
  
}
```

--------------------------------

### List All Files using Python

Source: https://docs.fivemanage.com/api-reference/files/list-all-files

This Python script fetches the list of all files. Ensure you have the `requests` library installed. Replace `<api-key>` with your actual API key.

```python
import requests  
  
url = "https://api.fivemanage.com/api/v3/file"  
  
headers = {"Authorization": "<api-key>"}  
  
response = requests.get(url, headers=headers)  
  
print(response.text)
```

--------------------------------

### Example API Response

Source: https://docs.fivemanage.com/api-reference/introduction

Successful API calls typically return data in JSON format with a 200 OK or 201 Created status. This example shows a successful media upload response.

```json
{
  "status": "ok",
  "data": {
    "id": "7F9pGhN8qwErT1vx5aZk",
    "url": "https://r2.fivemanage.com/<teamId>/7F9pGhN8qwErT1vx5aZk.jpg"
  }
}
```

--------------------------------

### Start Docker Compose Stack

Source: https://docs.fivemanage.com/lite/guides/quickstart

Execute this command in the directory containing your `docker-compose.yml` file to launch all defined services in detached mode.

```bash
docker-compose up -d
```

--------------------------------

### Configure Fivemanage Lite to Connect to ClickHouse

Source: https://docs.fivemanage.com/lite/guides/logs-storage/clickhouse

Set these environment variables in Fivemanage Lite to establish a connection to your running ClickHouse instance. Ensure the host, port, username, and database match your ClickHouse setup.

```bash
CLICKHOUSE_HOST=localhost:9000
CLICKHOUSE_USERNAME=default
CLICKHOUSE_PASSWORD=your_secure_password
CLICKHOUSE_DATABASE=default
```

--------------------------------

### Production-Ready ClickHouse with Docker Compose

Source: https://docs.fivemanage.com/lite/guides/logs-storage/clickhouse

Deploy ClickHouse using Docker Compose for a more robust setup, including configuration file mounting and secure password management. Essential for integrating with your existing stack.

```yaml
services:
  clickhouse:
    image: clickhouse/clickhouse-server:latest
    container_name: lite-clickhouse
    restart: always
    ports:
      - '8123:8123'   # HTTP Interface
      - '9000:9000'   # Native Interface (Used by Fivemanage Lite)
    environment:
      - CLICKHOUSE_USER=default
      - CLICKHOUSE_PASSWORD=your_secure_password
      - CLICKHOUSE_DB=default
    ulimits:
      nofile:
        soft: 262144
        hard: 262144
    volumes:
      - clickhouse_data:/var/lib/clickhouse/
      - ./clickhouse-config.xml:/etc/clickhouse-server/config.d/custom_config.xml

volumes:
  clickhouse_data:
```

--------------------------------

### List Uploaded Videos

Source: https://docs.fivemanage.com/guides/uploading-files/videos

Retrieve a list of all uploaded videos. This example filters the results to only include items of type 'video'. Ensure 'YOUR_API_TOKEN' is replaced with your valid API key.

```javascript
const axios = require('axios');

const apiKey = 'YOUR_API_TOKEN';
// Filter by type=video
const url = 'https://api.fivemanage.com/api/v3/file?type=video';

axios.get(url, {
    headers: { Authorization: apiKey }
}).then(res => {
    console.log(res.data);
}).catch(err => {
    console.error(err);
});
```

--------------------------------

### Upload Video with Metadata

Source: https://docs.fivemanage.com/guides/uploading-files/videos

Use this snippet to upload a video file along with optional metadata. Ensure you have the 'axios' and 'fs' libraries installed and replace 'YOUR_API_TOKEN' with your actual API key. The video file should be provided as a Blob.

```javascript
const axios = require('axios');
const fs = require('fs');

const apiKey = 'YOUR_API_TOKEN';
const url = 'https://api.fivemanage.com/api/v3/file';

const formData = new FormData();

formData.append('file', yourVideoBlob);
// Optional metadata field (JSON string)
formData.append("metadata", JSON.stringify({
    name: 'My video',
    description: 'This is a video of something cool",
    // or any other field
}));

axios.post(url, formData, {
    headers: {
        Authorization: apiKey,
    }
}).then(res => {
    console.log(res.data.url);
}).catch(err => {
    console.error(err);
});
```

--------------------------------

### Docker Compose for Full Fivemanage Lite Stack

Source: https://docs.fivemanage.com/lite/guides/quickstart

This Docker Compose configuration sets up a complete Fivemanage Lite environment, including Postgres, ClickHouse, MinIO, and Jaeger. It defines services, ports, environment variables, and volumes for persistent data. Use this for a self-contained development or testing setup.

```yaml
version: '3.8'
services:
  lite:
    image: ghcr.io/fivemanage/lite:latest
    ports:
      - "8080:8080"
    environment:
      - DSN=postgres://postgres:root@lite-database:5432/fivemanage-lite-dev?sslmode=disable
      - CLICKHOUSE_HOST=lite-clickhouse:9000
      - ADMIN_PASSWORD=password
      - API_TOKEN_HMAC_SECRET=change_this_to_a_secure_random_string
      - S3_PROVIDER=minio
      - AWS_ENDPOINT=http://lite-minio:9000
      - AWS_ACCESS_KEY_ID=minioadmin
      - AWS_SECRET_ACCESS_KEY=minioadmin123
      - AWS_BUCKET=fivemanage
      - AWS_REGION=us-east-1
    depends_on:
      - lite-database
      - lite-clickhouse
      - lite-minio

  lite-database:
    image: postgres:latest
    environment:
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: root
      POSTGRES_DB: fivemanage-lite-dev
    volumes:
      - postgres_data:/var/lib/postgresql/data

  lite-clickhouse:
    image: clickhouse/clickhouse-server:latest
    environment:
      CLICKHOUSE_PASSWORD: password
    ports:
      - '18123:8123'
      - '19000:9000'
    volumes:
      - clickhouse_data:/var/lib/clickhouse/

  lite-minio:
    image: minio/minio:latest
    command: server /data --console-address ":9001"
    environment:
      MINIO_ROOT_USER: minioadmin
      MINIO_ROOT_PASSWORD: minioadmin123
    ports:
      - "9000:9000"
      - "9001:9001"
    volumes:
      - minio_data:/data

volumes:
  postgres_data:
  clickhouse_data:
  minio_data:
```

--------------------------------

### Get Image Details

Source: https://docs.fivemanage.com/guides/uploading-files/images

Retrieve details about a specific image, including its metadata, using a GET request with the file ID.

```APIDOC
## Get Image Details

### Description
Retrieve details for a specific image using its file ID.

### Method
GET

### Endpoint
https://api.fivemanage.com/api/v3/file/${fileId}

### Path Parameters
- **fileId** (string) - Required - The unique identifier of the file.

### Headers
- **Authorization** (string) - Required - Your API key.

### Response
#### Success Response (200)
- The response will contain the details of the specified image, including its ID, URL, and any associated metadata.

### Response Example
```json
{
  "data": {
    "id": "7F9pGhN8qwErT1vx5aZk",
    "url": "https://r2.fivemanage.com/6E9pGhN8qwErT1vx5aZk/7F9pGhN8qwErT1vx5aZk.webp",
    "metadata": {
      "name": "My image",
      "description": "This is my image"
    }
  },
  "status": "ok"
}
```
```

--------------------------------

### Get Image Details with Axios

Source: https://docs.fivemanage.com/guides/uploading-files/images

Fetch details for a specific image, including its metadata, by sending a GET request to the /api/v3/file/:fileId endpoint. Replace :fileId with the actual ID of the image. Your API key must be provided in the Authorization header.

```javascript
const axios = require('axios');

const apiKey = 'YOUR_API_TOKEN';
const fileId = '7F9pGhN8qwErT1vx5aZk';
const url = `https://api.fivemanage.com/api/v3/file/${fileId}`;

axios.get(url, {
    headers: { Authorization: apiKey }
}).then(res => {
    console.log(res.data);
}).catch(err => {
    console.error(err);
});

```

--------------------------------

### Get Log by Trace ID

Source: https://docs.fivemanage.com/llms.txt

Retrieve a single log entry by its trace ID.

```APIDOC
## GET /v3/logging/logs/{traceId}

### Description
Retrieve a single log entry by its trace ID.

### Method
GET

### Endpoint
/v3/logging/logs/{traceId}

### Parameters
#### Path Parameters
- **traceId** (string) - Required - The trace ID of the log entry to retrieve.

### Response
#### Success Response (200)
- **logEntry** (object) - The log entry object.
  - **traceId** (string) - The trace ID of the log entry.
  - **timestamp** (string) - The timestamp of the log entry.
  - **level** (string) - The log level (e.g., INFO, WARN, ERROR).
  - **message** (string) - The log message.
  - **metadata** (object) - Additional metadata associated with the log entry.
```

--------------------------------

### Fivemanage Lite - Developing & Contributing

Source: https://docs.fivemanage.com/llms.txt

Learn how to build Fivemanage Lite from source and contribute to the project.

```APIDOC
## Fivemanage Lite - Developing & Contributing

### Description
Learn how to build Fivemanage Lite from source and contribute to the project.

### Endpoint
/lite/guides/contributing.md
```

--------------------------------

### Download Backend Dependencies

Source: https://docs.fivemanage.com/lite/guides/contributing

Download the necessary backend Go modules using `go mod download`.

```bash
go mod download
```

--------------------------------

### List Images

Source: https://docs.fivemanage.com/guides/uploading-files/images

List uploaded images using a GET request. Can be filtered by type to only retrieve images.

```APIDOC
## List Images

### Description
List uploaded files, with an option to filter by type to retrieve only images.

### Method
GET

### Endpoint
https://api.fivemanage.com/api/v3/file

### Query Parameters
- **type** (string) - Optional - Filter results to only include a specific type (e.g., `image`).

### Headers
- **Authorization** (string) - Required - Your API key.

### Response
#### Success Response (200)
- The response will be a list of uploaded files, potentially filtered by type.

### Response Example
```json
[
  {
    "id": "7F9pGhN8qwErT1vx5aZk",
    "url": "https://r2.fivemanage.com/6E9pGhN8qwErT1vx5aZk/7F9pGhN8qwErT1vx5aZk.webp",
    "type": "image"
  }
]
```
```

--------------------------------

### Run Fivemanage Lite with Docker

Source: https://docs.fivemanage.com/lite/guides/quickstart

Use this command to run the Fivemanage Lite container directly. Ensure your database (Postgres/ClickHouse) is already running and accessible. Configure the application using environment variables for database connection strings, host, admin password, and API token secret.

```bash
docker run -d \
  --name fivemanage-lite \
  -p 8080:8080 \
  -e DSN="postgres://user:password@your-postgres-host:5432/fivemanage?sslmode=disable" \
  -e CLICKHOUSE_HOST="your-clickhouse-host:9000" \
  -e ADMIN_PASSWORD="secure_admin_password" \
  -e API_TOKEN_HMAC_SECRET="your_32_byte_random_secret_string" \
  ghcr.io/fivemanage/lite:latest
```

--------------------------------

### Get Video Details

Source: https://docs.fivemanage.com/guides/uploading-files/videos

Fetch detailed information about a specific video, including its metadata, using its file ID.

```APIDOC
## Get Video Details

### Description
Fetch detailed information about a specific video, including its metadata, using its file ID.

### Method
GET

### Endpoint
https://api.fivemanage.com/api/v3/file/${fileId}

### Parameters
#### Path Parameters
- **fileId** (string) - Required - The unique identifier of the video.

### Request Example
```js
const axios = require('axios');

const apiKey = 'YOUR_API_TOKEN';
const fileId = '7F9pGhN8qwErT1vx5aZk';
const url = `https://api.fivemanage.com/api/v3/file/${fileId}`;

axios.get(url, {
    headers: { Authorization: apiKey }
}).then(res => {
    console.log(res.data);
}).catch(err => {
    console.error(err);
});
```
```

--------------------------------

### List All Files using Ruby

Source: https://docs.fivemanage.com/api-reference/files/list-all-files

This Ruby script fetches the list of all files using the Net::HTTP library. Replace `<api-key>` with your actual API key.

```ruby
require 'uri'  
require 'net/http'  
  
url = URI("https://api.fivemanage.com/api/v3/file")  
  
http = Net::HTTP.new(url.host, url.port)  
http.use_ssl = true  
  
request = Net::HTTP::Get.new(url)  
request["Authorization"] = '<api-key>'  
  
response = http.request(request)  
puts response.read_body
```

--------------------------------

### API Error Response

Source: https://docs.fivemanage.com/api-reference/files/list-all-files

This is an example of an error response from the API. It typically includes an 'error' field with a descriptive message.

```json
{
  "error": "Error message"
}
```

--------------------------------

### Configure LB Phone Upload Methods

Source: https://docs.fivemanage.com/guides/integration/lb-phone

Set all media upload methods to 'Fivemanage' in the lb-phone configuration file. This ensures all media is sent to Fivemanage.

```lua
Config.UploadMethod.Video = "Fivemanage"
Config.UploadMethod.Image = "Fivemanage"
Config.UploadMethod.Audio = "Fivemanage"
```

--------------------------------

### Set Fivemanage API Keys for LB Phone

Source: https://docs.fivemanage.com/guides/integration/lb-phone

Enter your Fivemanage API tokens in the lb-phone server API keys file. Replace 'YOUR_TOKEN' with your actual API keys for each media type.

```lua
API_KEYS = {
    Video = "YOUR_TOKEN",
    Image = "YOUR_TOKEN",
    Audio = "YOUR_TOKEN",
}
```

--------------------------------

### API Upload Response Success

Source: https://docs.fivemanage.com/guides/uploading-files/videos

This is an example of a successful response when uploading a video. It contains the unique ID and URL of the uploaded video.

```json
{
  "data": {
    "id": "7F9pGhN8qwErT1vx5aZk",
    "url": "https://r2.fivemanage.com/6E9pGhN8qwErT1vx5aZk/7F9pGhN8qwErT1vx5aZk.mp4"
  },
  "status": "ok"
}
```

--------------------------------

### Request Presigned URL with cURL

Source: https://docs.fivemanage.com/guides/uploading-files/presigned-urls

Perform a GET request to the server to obtain a presigned URL. Ensure your API token is included in the Authorization header.

```bash
curl --request GET \
	--url 'https://api.fivemanage.com/api/v3/file/presigned-url' \
	--header 'Authorization: YOUR_API_TOKEN' \

```

--------------------------------

### Structured JSON Log Example

Source: https://docs.fivemanage.com/fivemanage/guides/logs/best-practices

Use structured JSON for log messages instead of simple string concatenation. This allows for powerful filtering and querying.

```json
{
  "level": "info",
  "message": "Player joined the server",
  "metadata": {
    "playerId": "123",
    "playerName": "JohnDoe",
    "ip": "192.168.1.1"
  }
}
```

--------------------------------

### Configure Fivemanage Lite to Connect to MinIO

Source: https://docs.fivemanage.com/lite/guides/logs-storage/minio

Set these environment variables in Fivemanage Lite to establish a connection with your MinIO instance. Ensure the bucket exists and credentials match.

```dotenv
S3_PROVIDER=minio
AWS_ENDPOINT=http://localhost:9000
AWS_ACCESS_KEY_ID=minioadmin
AWS_SECRET_ACCESS_KEY=your_secure_password
AWS_BUCKET=fivemanage
AWS_REGION=us-east-1

```

--------------------------------

### Hytale Server Mods Directory with Configuration

Source: https://docs.fivemanage.com/hytale-sdk/installation

Shows the directory structure required for the Fivemanage Logger plugin's configuration file.

```bash
/your-server-root/
└── mods/
    └── Fivemanage_Logger/
        └── config.json
```

--------------------------------

### List All Files using JavaScript (Fetch API)

Source: https://docs.fivemanage.com/api-reference/files/list-all-files

This JavaScript snippet uses the Fetch API to list all files. Replace `<api-key>` with your actual API key.

```javascript
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};  
  
fetch('https://api.fivemanage.com/api/v3/file', options)  
  .then(res => res.json())  
  .then(res => console.log(res))  
  .catch(err => console.error(err));
```

--------------------------------

### Upload Image with Axios

Source: https://docs.fivemanage.com/guides/uploading-files/images

Use this snippet to upload an image file using Axios. Ensure you have the 'axios' and 'fs' modules installed. The API key should be replaced with your actual token.

```javascript
const axios = require('axios');
const fs = require('fs');

const apiKey = 'YOUR_API_TOKEN';
const url = 'https://api.fivemanage.com/api/v3/file';

const formData = new FormData();

formData.append('file', fs.createReadStream('image.png'));
// Optional metadata field (JSON string)
formData.append("metadata", JSON.stringify({
    name: 'My image',
    description: 'This is my image',
}));

// Custom filename and path
formData.append("filename", "cool_image.png")
// if a folder does not exist, it will be created automatically
formData.append("path", "path/to/folder")

axios.post(url, formData, {
    headers: {
        Authorization: apiKey,
    }
}).then(res => {
    console.log(res.data.url);
}).catch(err => {
    console.error(err);
});

```

--------------------------------

### Logging with Fivemanage SDK in Hytale

Source: https://docs.fivemanage.com/fivemanage/guides/logs/best-practices

Demonstrates how to log info and error messages with metadata using the FivemanageLogger in a Java/Kotlin Hytale server environment. Ensure you have the FivemanageLogger class wrapper available.

```kotlin
import com.fivemanage.sdk.FivemanageLogger

val logger = FivemanageLogger("YOUR_API_TOKEN")

// Log an info message
logger.info("Player joined the adventure", mapOf(
    "playerUuid" to player.uniqueId.toString(),
    "world" to player.world.name
))

// Log an error with exception
try {
    // ... risky code ...
} catch (e: Exception) {
    logger.error("An error occurred", mapOf(
        "exception" to e.message,
        "stackTrace" to e.stackTraceToString()
    ))
}
```

--------------------------------

### List Uploaded Images with Axios

Source: https://docs.fivemanage.com/guides/uploading-files/images

Retrieve a list of uploaded images by sending a GET request to the /api/v3/file endpoint with the query parameter type=image. Include your API key in the Authorization header.

```javascript
const axios = require('axios');

const apiKey = 'YOUR_API_TOKEN';
// Filter by type=image
const url = 'https://api.fivemanage.com/api/v3/file?type=image';

axios.get(url, {
    headers: { Authorization: apiKey }
}).then(res => {
    console.log(res.data);
}).catch(err => {
    console.error(err);
});

```

--------------------------------

### Hytale Server Mods Directory Structure

Source: https://docs.fivemanage.com/hytale-sdk/installation

Illustrates the expected file structure after placing the Fivemanage Logger JAR file in the mods directory.

```bash
/your-server-root/
└── mods/
    └── Fivemanage_Logger.jar
```

--------------------------------

### List All Files using Java (Unirest)

Source: https://docs.fivemanage.com/api-reference/files/list-all-files

This Java snippet uses the Unirest library to list all files. Ensure Unirest is included in your project dependencies. Replace `<api-key>` with your actual API key.

```java
HttpResponse<String> response = Unirest.get("https://api.fivemanage.com/api/v3/file")  
  .header("Authorization", "<api-key>")  
  .asString();
```

--------------------------------

### Complete Configuration Structure

Source: https://docs.fivemanage.com/hytale-sdk/configuration

This JSON object shows the full configuration for the Fivemanage Logger, including settings for both the log provider and player events.

```json
{
  "LogProvider": {
    "Provider": "fivemanage",
    "ApiKey": "your-fivemanage-api-key",
    "WriteToDisk": false,
    "EnableBatching": true,
    "BufferSize": 10,
    "FlushIntervalMs": 5000
  },
  "PlayerEvents": {
    "Dataset": "player-events",
    "Enabled": true
  }
}
```

--------------------------------

### Configure FiveManage API Key in RX ReportsPRO

Source: https://docs.fivemanage.com/guides/integration/reports-pro

Paste your FiveManage API token into the sv_config.lua file to enable screenshot integration.

```lua
Config.FIVEMANAGE_API_KEY = 'your_token_here'
```

--------------------------------

### List All Files

Source: https://docs.fivemanage.com/api-reference/files/list-all-files

Fetches a list of all files. Requires an API key for authentication.

```APIDOC
## GET /api/v3/file

### Description
Retrieves a list of all files associated with the account. This endpoint is useful for auditing, managing, or displaying file inventories.

### Method
GET

### Endpoint
/api/v3/file

### Parameters
#### Query Parameters
None

#### Headers
- **Authorization** (string) - Required - Your API key for authentication.

### Request Example
```http
GET /api/v3/file HTTP/1.1
Host: api.fivemanage.com
Authorization: <api-key>
```

### Response
#### Success Response (200)
- **data** (array) - An array of file objects.
  - **filename** (string) - The name of the file.
  - **id** (string) - The unique identifier for the file.
  - **metadata** (object) - Additional metadata associated with the file.
  - **originalUrl** (string) - The original URL of the file.
  - **size** (integer) - The size of the file in bytes.
  - **type** (string) - The MIME type of the file.
  - **url** (string) - The accessible URL of the file.
- **pagination** (object) - Pagination details for the response.
  - **limit** (integer) - The maximum number of items per page.
  - **page** (integer) - The current page number.
  - **total** (integer) - The total number of files available.
- **status** (string) - The status of the operation.

#### Response Example (200)
```json
{
  "data": [
    {
      "filename": "example.jpg",
      "id": "file123",
      "metadata": {},
      "originalUrl": "https://r2.fivemanage.com/23492kdx23121/7F9pGhN8qwErT1vx5aZk.jpg",
      "size": 102400,
      "type": "image/jpeg",
      "url": "https://cdn.fivemanage.com/files/file123"
    }
  ],
  "pagination": {
    "limit": 10,
    "page": 1,
    "total": 50
  },
  "status": "success"
}
```

#### Error Response (401)
- **error** (string) - Description of the authentication error.

#### Response Example (401)
```json
{
  "error": "Invalid API key"
}
```

#### Error Response (500)
- **error** (string) - Description of the server error.

#### Response Example (500)
```json
{
  "error": "Internal server error"
}
```
```

--------------------------------

### Get Specific Video Details

Source: https://docs.fivemanage.com/guides/uploading-files/videos

Fetch detailed information, including metadata, for a specific video using its file ID. Replace 'YOUR_API_TOKEN' and '7F9pGhN8qwErT1vx5aZk' with your API key and the target video's ID, respectively.

```javascript
const axios = require('axios');

const apiKey = 'YOUR_API_TOKEN';
const fileId = '7F9pGhN8qwErT1vx5aZk';
const url = `https://api.fivemanage.com/api/v3/file/${fileId}`;

axios.get(url, {
    headers: { Authorization: apiKey }
}).then(res => {
    console.log(res.data);
}).catch(err => {
    console.error(err);
});
```

--------------------------------

### Enable Fivemanage Integration in TGIANN

Source: https://docs.fivemanage.com/guides/integration/tgiann

Configure the screenshot settings in `screenshotConfig.lua` to enable Fivemanage integration and set your API key. This snippet activates the Fivemanage module and specifies the API key for authentication. If Fivemanage is active, the discordWebhook setting is ignored.

```lua
screenshot = {
    fivemanage     = {  -- https://fivemanage.com
        active = true,  -- Set to true to enable Fivemanage
        api = 'YOUR_API_KEY', -- Fivemanage API Key
    },
    discordWebhook = "" -- If 'fivemanage' is active, this will be ignored
}
```

--------------------------------

### Capture and Upload Player Image (Lua)

Source: https://docs.fivemanage.com/fivem-sdk/images

Captures a screenshot from the player's screen and uploads it to Fivemanage. Use this for client-side initiated image captures.

```Lua
local imageData = exports.fmsdk:takeImage({
    name = "Player Screenshot",
    description = "Captured via script"
})

if imageData then
    print("Image uploaded to: " .. imageData.url)
end
```

--------------------------------

### OpenAPI Specification for Presigned Upload URL

Source: https://docs.fivemanage.com/api-reference/files/create-presigned-upload-url

This OpenAPI 3.0 specification defines the GET endpoint `/v3/file/presigned-url` for creating a presigned upload URL. It includes request parameters, response schemas for success and errors, and security scheme definitions.

```yaml
openapi: 3.0.0
info:
  description: >-
    This is the API server for Fivemanage, providing endpoints for media
    management, logging, and SDK integration.
  title: Fivemanage API
  termsOfService: https://fivemanage.com/legal/terms-of-service
  contact:
    name: Support
    email: support@fivemanage.com
  version: '1.0'
servers:
  - url: https://api.fivemanage.com/api
security: []
paths:
  /v3/file/presigned-url:
    get:
      tags:
        - Files
      summary: Create Presigned Upload URL
      description: >-
        Generate a presigned URL for file upload in V3. This URL allows
        uploading a file directly without using an API token in the final POST.
      parameters:
        - description: Expiration time in Unix timestamp
          name: expiresAt
          in: query
          schema:
            type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.PresignedUrlResponseV3'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    api.PresignedUrlResponseV3:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/api.PresignedUrlResponseDataV3'
        status:
          type: string
          example: ok
    api.ErrorResponse:
      type: object
      properties:
        error:
          type: string
          example: Error message
    api.PresignedUrlResponseDataV3:
      type: object
      properties:
        presignedUrl:
          type: string
          example: >-
            https://fmapi.net/api/v3/file/presigned-url/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      name: Authorization
      in: header

```

--------------------------------

### Fivemanage Lite - Configuration

Source: https://docs.fivemanage.com/llms.txt

Configure Fivemanage Lite environment variables and dependencies.

```APIDOC
## Fivemanage Lite - Configuration

### Description
Configure Fivemanage Lite environment variables and dependencies.

### Endpoint
/lite/guides/configuration.md
```

--------------------------------

### Basic Logging Methods in FivemanageLogger

Source: https://docs.fivemanage.com/hytale-sdk/usage

Utilize static methods like info, warn, error, and debug to send logs with a dataset, message, and optional metadata. Ensure the FivemanageLogger class is imported.

```java
import com.fivemanage.FivemanageLogger;
import java.util.Map;

// Info level
FivemanageLogger.info("my-mod", "Something happened", metadata);

// Warning level
FivemanageLogger.warn("my-mod", "Something might be wrong", metadata);

// Error level
FivemanageLogger.error("my-mod", "Something went wrong!", metadata);

// Debug level
FivemanageLogger.debug("my-mod", "Detailed debug information", metadata);
```

--------------------------------

### List All Files using cURL

Source: https://docs.fivemanage.com/api-reference/files/list-all-files

Use this command to list all files via cURL. Replace `<api-key>` with your actual API key.

```bash
curl --request GET \
  --url https://api.fivemanage.com/api/v3/file \
  --header 'Authorization: <api-key>'
```
Tokens:
Raw