Artifacts
Usage guides and information for our Artifacts API.
The Artifacts API provides access to FiveM and RedM server artifacts, which are essential for running your game servers. This API helps you stay up-to-date with the latest server versions and manage your server installations programmatically.
Overview
The Artifacts API is a powerful tool that provides programmatic access to FiveM and RedM server artifacts. It's designed to help server administrators and developers:
- Automate server updates and installations
- Monitor version support status
- Stay informed about critical updates
- Manage multiple server instances efficiently
The API provides detailed information about each artifact version, including:
- Version numbers and release dates
- Download links for different platforms (Windows/Linux)
- Support status and lifecycle information
- Critical update flags
- Artifact URLs for direct access
Base URL
Authentication
The Artifacts API is currently public and doesn't require authentication. However, we recommend implementing rate limiting in your applications to ensure fair usage.
Endpoints
GET /api/artifacts
Retrieves a list of all available artifacts with detailed information about each version.
Query Parameters
Parameter | Type | Description | Default |
---|---|---|---|
platform | string | Filter by platform (windows or linux ) | All platforms |
product | string | Filter by product (fivem or redm ) | All products |
version | string | Filter by specific version number | All versions |
status | string | Filter by support status (recommended , latest , active , deprecated , eol ) | All statuses |
search | string | Search artifacts by version number | No search |
limit | number | Maximum number of results per platform (max 500) | 100 |
offset | number | Number of results to skip (for pagination) | 0 |
includeEol | boolean | Include End of Life artifacts in results | false |
sortBy | string | Sort field (version or date ) | version |
sortOrder | string | Sort direction (asc or desc ) | desc |
before | string | Filter artifacts released before this date (ISO format) | No limit |
after | string | Filter artifacts released after this date (ISO format) | No limit |
Response Format
GET /api/artifacts/changes
Retrieves changelog information for specified artifact versions by analyzing GitHub commits and issues. This endpoint provides a comprehensive view of changes between versions, including commit diffs and file changes.
Query Parameters
Parameter | Type | Description | Default |
---|---|---|---|
from | string | The starting version to fetch changes from | Required |
to | string | The ending version to fetch changes to | Required |
platform | string | Filter changes by platform (windows/linux) | Optional |
format | string | Response format (json , markdown , or html ) | json |
includeDiffs | boolean | Include file diffs in the response | false |
Response Format
Example Usage
GET /api/artifacts/check
Retrieves GitHub issues related to specific artifact versions, helping you track reported problems and their status.
Query Parameters
Parameter | Type | Description | Default |
---|---|---|---|
version | string | Filter issues by specific artifact version | All versions |
state | string | Filter by issue state (open or closed ) | All states |
page | number | Page number for pagination | 1 |
perPage | number | Number of results per page | 20 |
Response Format
Example Usage
Use Cases
Server Setup Automation
Version Monitoring
Support Status Check
Rate Limiting
The API implements rate limiting to ensure fair usage and prevent abuse. Here's what you need to know:
- Requests are limited to 100 per minute per IP address
- Exceeding the limit will result in a 429 (Too Many Requests) response
- Include appropriate delays between requests in your applications
- Implement caching to reduce the number of API calls
Error Handling
The API uses standard HTTP status codes to indicate request status:
200
: Success - The request was successful400
: Bad Request - Invalid parameters or malformed request429
: Too Many Requests - Rate limit exceeded500
: Server Error - Internal server error
Example error response:
Caching
The API implements a 1-hour cache for artifact data. This means:
- New versions may not appear immediately in the API response
- Cache is shared across all users
- Cache is automatically invalidated after 1 hour
- Critical updates may bypass the cache
Best Practices
-
Version Management
- Always check the
recommended
status when setting up new servers - Monitor the
supportStatus
of your current version - Keep track of
critical
updates for security patches
- Always check the
-
Performance
- Implement proper caching in your applications
- Use appropriate delays between requests
- Consider using webhooks for version updates
-
Error Handling
- Implement proper error handling and retry logic
- Log API errors for debugging
- Handle rate limiting gracefully
-
Security
- Validate all API responses
- Use HTTPS for all requests
- Keep your integration code up to date
-
Monitoring
- Set up alerts for version updates
- Monitor support status changes
- Track API response times
Support
For questions or issues with the Artifacts API, please contact us on Discord. Our support team is available to help you with:
- API integration issues
- Version management questions
- Best practices guidance
- Feature requests
- Bug reports
Related APIs
Explore our other API offerings:
- Natives API - Access FiveM and RedM native functions and documentation
- Contributors API - GitHub contributors and repository statistics
- Search API - Search documentation and content across the platform
- Chat API - AI-powered assistance for development questions
All our APIs work together to provide a comprehensive development experience for FiveM and RedM.