> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nonefivem.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Complete REST API reference for NoCloud

The NoCloud API provides a RESTful interface for managing your cloud resources. All endpoints are designed to be simple, predictable, and consistent.

## Base URL

All API requests should be made to:

```
https://api.nonefivem.com/cloud
```

## Authentication

All API requests require authentication using a Bearer token in the `Authorization` header.

<ParamField header="Authorization" type="string" required>
  Your API key in the format: `Bearer <your-api-key>`
</ParamField>

```bash theme={null}
curl -X GET "https://api.nonefivem.com/cloud/storage" \
  -H "Authorization: Bearer your-api-key"
```

<Warning>
  Keep your API key secure. Do not expose it in client-side code or public
  repositories.
</Warning>

## Response Format

All responses are returned in JSON format. Successful responses include the requested data, while error responses follow a consistent structure:

```json theme={null}
{
  "message": "Error message describing what went wrong"
}
```

## HTTP Status Codes

| Status Code | Description                               |
| ----------- | ----------------------------------------- |
| `200`       | Success                                   |
| `201`       | Created                                   |
| `400`       | Bad Request - Invalid parameters          |
| `401`       | Unauthorized - Invalid or missing API key |
| `403`       | Forbidden - Insufficient permissions      |
| `404`       | Not Found - Resource doesn't exist        |
| `429`       | Too Many Requests - Rate limit exceeded   |
| `500`       | Internal Server Error                     |

## Permissions

Different endpoints require different permission levels:

| Permission      | Description                              |
| --------------- | ---------------------------------------- |
| `STORAGE_READ`  | Read storage items and statistics        |
| `STORAGE_WRITE` | Upload, delete, and modify storage items |

## Available Endpoints

<CardGroup cols={2}>
  <Card title="Storage Statistics" icon="chart-bar" href="/cloud/api-reference/storage/statistics">
    Get storage usage and statistics
  </Card>

  <Card title="Storage Items" icon="folder" href="/cloud/api-reference/storage/items">
    List and manage storage items
  </Card>

  <Card title="Signed URLs" icon="link" href="/cloud/api-reference/storage/signed-url">
    Generate pre-signed upload URLs
  </Card>

  <Card title="Retention Settings" icon="clock" href="/cloud/api-reference/storage/retention">
    Configure retention policies
  </Card>
</CardGroup>