Nekoweb API

https://nekoweb.org/api
Admin
Nekoweb API is a RESTful API that allows developers to programmatically interact with their Nekoweb...
Tokens:2,816
Snippets:31
Trust Score:9.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### Initiate Big File Upload

Source: https://nekoweb.org/api

Start a large file upload process (over 100MB) by making a GET request. This returns an 'id' to be used for subsequent chunk uploads.

```http
GET /api/files/big/create
```

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

### /site/info_all

Source: https://nekoweb.org/api

Get information about all your sites. Returns a JSON array of objects with main, domain, title, updates, followers, views, created_at and updated_at properties.

```APIDOC
## GET /site/info_all

### Description
Get information about all your sites.

### Method
GET

### Endpoint
/site/info_all

### Response
#### Success Response (200)
- **Array of site objects**, each containing:
  - **main** (boolean) - Indicates if it's the main site.
  - **domain** (string) - The domain of the site.
  - **title** (string) - The title of the site.
  - **updates** (integer) - Number of updates.
  - **followers** (integer) - Number of followers.
  - **views** (integer) - Number of views.
  - **created_at** (string) - Timestamp of creation.
  - **updated_at** (string) - Timestamp of last update.
```

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

### /site/info

Source: https://nekoweb.org/api

Get information about your main site. Returns a JSON object with domain, title, updates, followers, views, created_at and updated_at properties.

```APIDOC
## GET /site/info

### Description
Get information about your main site.

### Method
GET

### Endpoint
/site/info

### Response
#### Success Response (200)
- **domain** (string) - The domain of the site.
- **title** (string) - The title of the site.
- **updates** (integer) - Number of updates.
- **followers** (integer) - Number of followers.
- **views** (integer) - Number of views.
- **created_at** (string) - Timestamp of creation.
- **updated_at** (string) - Timestamp of last update.
```

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

### /api/files/limits

Source: https://nekoweb.org/api

Get your current rate limit status. Returns a JSON object with info about status of various rate limits for your account.

```APIDOC
## GET /api/files/limits

### Description
Get your current rate limit status.

### Method
GET

### Endpoint
/api/files/limits

### Response
#### Success Response (200)
- **general** (object) - Rate limit info for general file operations.
- **big_uploads** (object) - Rate limit info for big uploads.
- **zip** (object) - Rate limit info for zip operations.

#### Response Example
{
    "general": { "limit": 100, "remaining": 99, "reset": 1724615605438 },
    "big_uploads":{ "limit": 5, "remaining": 5, "reset": -1 },
    "zip":{ "limit":1, "remaining": 0,"reset": 1724615028902 }
}
```

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

### /site/info/:domain

Source: https://nekoweb.org/api

Get information about a specific site by its domain. This endpoint doesn't require auth if requested from Nekoweb site. Returns a JSON object with domain, title, updates, followers, views, created_at and updated_at properties.

```APIDOC
## GET /site/info/:domain

### Description
Get information about a site.

### Method
GET

### Endpoint
/site/info/:domain

### Parameters
#### Path Parameters
- **domain** (string) - Required - The domain of the site.
```

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

### Read Folder Contents

Source: https://nekoweb.org/api

Retrieve a list of files and subfolders within a specified directory using a GET request with the 'pathname' query parameter.

```http
GET /api/files/readfolder?pathname=/path/to/folder
```

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

### Get Rate Limit Status

Source: https://nekoweb.org/api

Retrieve current rate limit status for your account. The 'reset' value of -1 indicates the counter hasn't started.

```json
{
    "general": { "limit": 100, "remaining": 99, "reset": 1724615605438 },
    "big_uploads":{ "limit": 5, "remaining": 5, "reset": -1 },
    "zip":{ "limit":1, "remaining": 0,"reset": 1724615028902 }
}
```

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

### Create File or Folder

Source: https://nekoweb.org/api

Use this POST request to create a new file or folder. Specify the 'pathname' and 'isFolder' (boolean) parameters.

```http
POST /api/files/create
Content-type: application/x-www-form-urlencoded

pathname=/path/to/your/file_or_folder&isFolder=false
```

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

### /files/create

Source: https://nekoweb.org/api

Create a new file or folder. Content type: application/x-www-form-urlencoded.

```APIDOC
## POST /files/create

### Description
Create a new file or folder.

### Method
POST

### Endpoint
/files/create

### Parameters
#### Request Body
- **pathname** (string) - Required - The path of the file or folder to create.
- **isFolder** (boolean) - Required - false for file, true for folder.
```

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

### /files/readfolder

Source: https://nekoweb.org/api

Read a folder. Returns a JSON array with objects like this: {name: String, dir: Boolean}.

```APIDOC
## GET /files/readfolder

### Description
Read a folder.

### Method
GET

### Endpoint
/files/readfolder

### Parameters
#### Query Parameters
- **pathname** (string) - Required - The path of the folder to read.

### Response
#### Success Response (200)
- **Array of objects**, each containing:
  - **name** (string) - The name of the file or folder.
  - **dir** (boolean) - True if it's a directory, false if it's a file.
```

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

### Import Zip File from Big Upload

Source: https://nekoweb.org/api

Import a zip file that has been uploaded using the big file upload process. Specify the 'path' to import into; defaults to root if omitted.

```http
POST /api/files/import/:bigid
Content-type: application/x-www-form-urlencoded

path=/import/destination/
```

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

### Upload File

Source: https://nekoweb.org/api

Upload a file using a POST request with 'multipart/form-data'. This will overwrite existing files. Maximum upload size is 100MB.

```http
POST /api/files/upload
Content-type: multipart/form-data

pathname=/path/to/upload/to&file=@your_file.txt
```

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

### /files/rename

Source: https://nekoweb.org/api

Rename/Move a file or folder. Content type: application/x-www-form-urlencoded.

```APIDOC
## POST /files/rename

### Description
Rename/Move a file or folder.

### Method
POST

### Endpoint
/files/rename

### Parameters
#### Request Body
- **pathname** (string) - Required - The old path of the file or folder.
- **newpathname** (string) - Required - The new path of the file or folder.
```

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

### /files/import/:bigid

Source: https://nekoweb.org/api

Import a zip file from a big file upload. Replace :bigid with the id of the big file upload. Content type: application/x-www-form-urlencoded.

```APIDOC
## POST /files/import/:bigid

### Description
Import a zip file from a big file upload.

### Method
POST

### Endpoint
/files/import/:bigid

### Parameters
#### Path Parameters
- **bigid** (string) - Required - The id of the big file upload.

#### Request Body
- **path** (string) - Optional (default: /) - The path of the folder to import to.
```

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

### Rename or Move File/Folder

Source: https://nekoweb.org/api

Use this POST endpoint to rename or move a file or folder by providing both the current ('pathname') and new ('newpathname') paths.

```http
POST /api/files/rename
Content-type: application/x-www-form-urlencoded

pathname=/old/path/to/file&newpathname=/new/path/to/file
```

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

### /files/big/create

Source: https://nekoweb.org/api

Create upload for a big file. Allows you to upload files larger than 100MB. Returns a JSON object with a id property. Use this id to upload the file in chunks.

```APIDOC
## GET /files/big/create

### Description
Create upload for a big file.

### Method
GET

### Endpoint
/files/big/create

### Response
#### Success Response (200)
- **id** (string) - The ID for the big file upload.
```

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

### /files/upload

Source: https://nekoweb.org/api

Upload a file or files. This will overwrite old files. Max 100MB. Content type: multipart/form-data.

```APIDOC
## POST /files/upload

### Description
Upload a file or files. This will overwrite old files. Max 100MB.

### Method
POST

### Endpoint
/files/upload

### Parameters
#### Request Body
- **pathname** (string) - Required - The path of the folder to upload to.
```

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

### Delete File or Folder

Source: https://nekoweb.org/api

Send a POST request with the 'pathname' of the file or folder to delete.

```http
POST /api/files/delete
Content-type: application/x-www-form-urlencoded

pathname=/path/to/delete
```

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

### /files/edit

Source: https://nekoweb.org/api

Edit a file. Content type: multipart/form-data.

```APIDOC
## POST /files/edit

### Description
Edit a file.

### Method
POST

### Endpoint
/files/edit

### Parameters
#### Request Body
- **pathname** (string) - Required - The path of the file to edit.
- **content** (string) - Required - The new content of the file.
```

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

### /files/big/append

Source: https://nekoweb.org/api

Append a chunk to a big file upload. Chunk must be less than 100MB. Content type: multipart/form-data.

```APIDOC
## POST /files/big/append

### Description
Append a chunk to a big file upload.

### Method
POST

### Endpoint
/files/big/append

### Parameters
#### Request Body
- **id** (string) - Required - The id of the big file upload.
- **file** (file) - Required - Chunk of file.
```

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

### Edit File Content

Source: https://nekoweb.org/api

Modify the content of an existing file using a POST request. Provide the 'pathname' and the new 'content'.

```http
POST /api/files/edit
Content-type: multipart/form-data

pathname=/path/to/edit.txt&content=New file content here.
```

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

### /files/delete

Source: https://nekoweb.org/api

Delete a file or folder. Content type: application/x-www-form-urlencoded.

```APIDOC
## POST /files/delete

### Description
Delete a file or folder.

### Method
POST

### Endpoint
/files/delete

### Parameters
#### Request Body
- **pathname** (string) - Required - The path of the file or folder to delete.
```

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

### /files/big/move

Source: https://nekoweb.org/api

Move a big file upload to the final location. Content type: application/x-www-form-urlencoded.

```APIDOC
## POST /files/big/move

### Description
Move a big file upload to the final location.

### Method
POST

### Endpoint
/files/big/move

### Parameters
#### Request Body
- **id** (string) - Required - The id of the big file upload.
- **pathname** (string) - Required - The path of the file to move to.
```

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

### Append Chunk to Big File Upload

Source: https://nekoweb.org/api

Upload a chunk (less than 100MB) of a large file using its 'id'. This is part of the multi-step big file upload process.

```http
POST /api/files/big/append
Content-type: multipart/form-data

id=your_big_file_id&file=@chunk.part
```

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

### Finalize Big File Upload

Source: https://nekoweb.org/api

Move the completed big file upload to its final destination on the server. Requires the upload 'id' and the target 'pathname'.

```http
POST /api/files/big/move
Content-type: application/x-www-form-urlencoded

id=your_big_file_id&pathname=/final/path/to/your/large_file.zip
```
Tokens:
Raw