Skip to main content
The FiveMesh API is for scripts, deployment tools and server automation that need to operate FiveMesh services without a dashboard session. Use the API for workspace-scoped tasks such as preparing CDN uploads, managing public asset paths and operating Cache for registered FiveM servers.
Endpoint-specific reference pages will be expanded as the public API surface is finalized. Start with authentication and service scopes before connecting scripts.

​
API areas

AreaUse it for
AuthenticationPassing service keys, handling scopes and keeping secrets server-side.
FiveMesh CDNPublic asset delivery, folder paths, presigned uploads and purge operations.
FiveMesh CacheResource cache setup, cache operations, origin settings and observability.

​
Before you call the API

Create a service key from API keys, then choose the smallest permission set that supports your script. If the script only uploads media for one integration, restrict the key to a path prefix such as /phone or /tablet.
Do not put service keys in client-side Lua, browser code or NUI bundles. Keep API calls that use service keys on the server side.

​
Request pattern

FiveMesh service APIs use bearer authentication. 
curl "$FIVEMESH_API_URL/v1/..." \
  -H "Authorization: Bearer $FIVEMESH_API_KEY" \
  -H "Content-Type: application/json"
Set FIVEMESH_API_URL to the API base URL provided for your workspace or integration environment.