Nekoweb API

https://nekoapi.nekoweb.org
Admin
Nekoweb API allows you to interact with nekoweb servers programmatically, enabling automation of...
Tokens:5,907
Snippets:32
Trust Score:9.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### Import Zip File from Big Upload (Node.js)

Source: https://nekoapi.nekoweb.org/

This Node.js example shows how to import a zip file from a completed big file upload. Replace ':bigid' with the actual ID obtained from a previous upload. Ensure 'node-fetch' is installed.

```javascript
const fetch = require('node-fetch');

let url = 'https://nekoweb.org/api/files/import/il4w31f9m1aqqqe8op7hp';

let options = {
  method: 'POST',
  headers: {
    Authorization: '177e9b41e8b35b5e3cf90dd4a1ce90b9c8d1e6aa79863c0ebfd9c1e5dbb4d24d'
  }
};

fetch(url, options)
  .then(res => res)
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

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

### Get Site Info

Source: https://nekoapi.nekoweb.org/

Retrieves information about a user's site, including details like username, title, followers, and views. This endpoint is publicly accessible.

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

### Description
Get information about a user's site. Replace :username with the username of the user. This endpoint doesn't require auth if requested from Nekoweb site.

### Method
GET

### Endpoint
/site/info/:username

### Parameters
#### Path Parameters
- **username** (string) - Required - The username of the user whose site information is to be retrieved.

### Responses
#### Success Response (200)
OK
- **id** (integer) - The user's ID.
- **username** (string) - The user's username.
- **title** (string) - The title of the user's site.
- **updates** (integer) - The number of updates on the site.
- **followers** (integer) - The number of followers.
- **views** (integer) - The number of views.
- **created_at** (integer) - Timestamp when the site was created.
- **updated_at** (integer) - Timestamp when the site was last updated.

### Request Example
```javascript
const fetch = require('node-fetch');

let url = 'https://nekoweb.org/api/site/info/fairfruit';

let options = {
  method: 'GET'
};

fetch(url, options)
  .then(res => res)
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

### Response Example
```json
{
  "id": 1855,
  "username": "fairfruit",
  "title": "Welcome to Fairfruit",
  "updates": 5,
  "followers": 0,
  "views": 209,
  "created_at": 1709235724576,
  "updated_at": 1709597947291
}
```
```

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

### Get Site Info Node.js

Source: https://nekoapi.nekoweb.org/

Retrieve information about a user's site. This public endpoint does not require authentication.

```javascript
const fetch = require('node-fetch');

let url = 'https://nekoweb.org/api/site/info/fairfruit';

let options = {
  method: 'GET'
};

fetch(url, options)
  .then(res => res)
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

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

### Read Folder Contents using Node.js

Source: https://nekoapi.nekoweb.org/

This Node.js snippet retrieves the contents of a specified folder. It sends a GET request with a query parameter for the folder path.

```javascript
const fetch = require('node-fetch');

let url = 'https://nekoweb.org/api/files/readfolder?pathname=test';

let options = {
  method: 'GET',
  headers: {
    Authorization: '177e9b41e8b35b5e3cf90dd4a1ce90b9c8d1e6aa79863c0ebfd9c1e5dbb4d24d'
  }
};

fetch(url, options)
  .then(res => res)
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

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

### Create Big File Upload using Node.js

Source: https://nekoapi.nekoweb.org/

Initiates an upload process for large files (over 100MB). This Node.js snippet makes a GET request to create the upload.

```javascript
const fetch = require('node-fetch');

let url = 'https://nekoweb.org/api/files/big/create';

let options = {
  method: 'GET',
  headers: {
    Authorization: '177e9b41e8b35b5e3cf90dd4a1ce90b9c8d1e6aa79863c0ebfd9c1e5dbb4d24d'
  }
};

fetch(url, options)
  .then(res => res)
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

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

### Append Data to Big File Upload (Node.js)

Source: https://nekoapi.nekoweb.org/

Use this to append data to a large file upload. Ensure you have the 'form-data' and 'node-fetch' libraries installed. The 'filepath' option is crucial for specifying the local file to upload.

```javascript
const FormData = require('form-data');
const fetch = require('node-fetch');
const formData = new FormData();

formData.append('id', 'fnc8orbox7dk71y1kzwke');
formData.append('file', 'test.txt', { filepath: './test.txt' });

let url = 'https://nekoweb.org/api/files/big/append';

let options = {
  method: 'POST',
  headers: {
    Authorization: '177e9b41e8b35b5e3cf90dd4a1ce90b9c8d1e6aa79863c0ebfd9c1e5dbb4d24d'
  }
};

options.body = formData;

fetch(url, options)
  .then(res => res)
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

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

### Create File or Folder Node.js

Source: https://nekoapi.nekoweb.org/

Create a new file or folder on the nekoweb server. Requires an API key for authorization. The request body must be form-urlencoded.

```javascript
const { URLSearchParams } = require('url');
const fetch = require('node-fetch');
const encodedParams = new URLSearchParams();

encodedParams.set('isFolder', 'true');
encodedParams.set('pathname', 'test');

let url = 'https://nekoweb.org/api/files/create';

let options = {
  method: 'POST',
  headers: {
    Authorization: '177e9b41e8b35b5e3cf90dd4a1ce90b9c8d1e6aa79863c0ebfd9c1e5dbb4d24d',
    'content-type': 'application/x-www-form-urlencoded'
  },
  body: encodedParams
};

fetch(url, options)
  .then(res => res)
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

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

### Create File or Folder

Source: https://nekoapi.nekoweb.org/

Creates a new file or folder within the user's account. Requires an API key for authorization.

```APIDOC
## POST /files/create

### Description
Create a new file or folder.

### Method
POST

### Endpoint
/files/create

### Parameters
#### Header Parameters
- **Authorization** (string) - Required - API key for authentication.

#### Request Body
- **isFolder** (boolean) - Required - Specifies if the item to be created is a folder.
- **pathname** (string) - Required - The path and name for the new file or folder.

### Responses
#### Success Response (200)
OK

### Request Example
```javascript
const { URLSearchParams } = require('url');
const fetch = require('node-fetch');
const encodedParams = new URLSearchParams();

encodedParams.set('isFolder', 'true');
encodedParams.set('pathname', 'test');

let url = 'https://nekoweb.org/api/files/create';

let options = {
  method: 'POST',
  headers: {
    Authorization: '177e9b41e8b35b5e3cf90dd4a1ce90b9c8d1e6aa79863c0ebfd9c1e5dbb4d24d',
    'content-type': 'application/x-www-form-urlencoded'
  },
  body: encodedParams
};

fetch(url, options)
  .then(res => res)
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

### Response Example
```text
Folder created
```
```

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

### Upload File(s)

Source: https://nekoapi.nekoweb.org/

Uploads one or more files to the user's account, overwriting existing files if they have the same name. Maximum file size is 100MB. Requires an API key.

```APIDOC
## POST /files/upload

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

### Method
POST

### Endpoint
/files/upload

### Parameters
#### Header Parameters
- **Authorization** (string) - Required - API key for authentication.

#### Request Body
- **pathname** (string) - Required - The destination path for the uploaded file(s).
- **files** (binary) - Required - The file(s) to upload.

### Responses
#### Success Response (200)
OK

### Request Example
```javascript
const FormData = require('form-data');
const fetch = require('node-fetch');
const formData = new FormData();

formData.append('pathname', '/test');
formData.append('files', 'test.txt', { filepath: './test.txt' });

let url = 'https://nekoweb.org/api/files/upload';

let options = {
  method: 'POST',
  headers: {
    Authorization: '177e9b41e8b35b5e3cf90dd4a1ce90b9c8d1e6aa79863c0ebfd9c1e5dbb4d24d'
  }
};

options.body = formData;

fetch(url, options)
  .then(res => res)
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

### Response Example
```text
Files uploaded
```
```

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

### Upload File Node.js

Source: https://nekoapi.nekoweb.org/

Upload a file or files to the nekoweb server, overwriting existing files. Maximum upload size is 100MB. Requires an API key for authorization. The request body uses multipart/form-data.

```javascript
const FormData = require('form-data');
const fetch = require('node-fetch');
const formData = new FormData();

formData.append('pathname', '/test');
formData.append('files', 'test.txt', { filepath: './test.txt' });

let url = 'https://nekoweb.org/api/files/upload';

let options = {
  method: 'POST',
  headers: {
    Authorization: '177e9b41e8b35b5e3cf90dd4a1ce90b9c8d1e6aa79863c0ebfd9c1e5dbb4d24d'
  }
};

options.body = formData;

fetch(url, options)
  .then(res => res)
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

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

### Import Big File

Source: https://nekoapi.nekoweb.org/

Imports a zip file from a completed big file upload. This should be called after appending the archive.

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

### Description
Import a zip file from a big file upload. Replace :bigid with the id of the big file upload. Should be called after calling `/files/big/append` to upload the archive, with the same id.

### Method
POST

### Endpoint
https://nekoweb.org/api/files/import/{bigid}

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

#### Header Parameters
- **Authorization** (string) - Required - API Key for authentication.

### Request Example
```javascript
const fetch = require('node-fetch');

let url = 'https://nekoweb.org/api/files/import/il4w31f9m1aqqqe8op7hp';

let options = {
  method: 'POST',
  headers: {
    Authorization: '177e9b41e8b35b5e3cf90dd4a1ce90b9c8d1e6aa79863c0ebfd9c1e5dbb4d24d'
  }
};

fetch(url, options)
  .then(res => res)
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

### Response
#### Success Response (200)
- **text/plain** - Imported
```

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

### Create Big File Upload

Source: https://nekoapi.nekoweb.org/

Initiates an upload process for large files, returning an ID for subsequent chunk uploads.

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

### Description
Create upload for a big file. Allows you to upload files larger than 100MB.

### Method
GET

### Endpoint
https://nekoweb.org/api/files/big/create

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

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

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

### Edit File Confirmation

Source: https://nekoapi.nekoweb.org/

This is a plain text response indicating that a file has been successfully edited.

```text
File edited
```

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

### Read Folder Contents

Source: https://nekoapi.nekoweb.org/

Reads the contents of a specified folder and returns a list of files and subfolders.

```APIDOC
## GET /files/readfolder

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

### Method
GET

### Endpoint
https://nekoweb.org/api/files/readfolder

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

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

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

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

### Rename File/Folder Confirmation

Source: https://nekoapi.nekoweb.org/

This is a plain text response indicating successful renaming of a file or folder.

```text
File/folder renamed
```

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

### Delete File/Folder Confirmation

Source: https://nekoapi.nekoweb.org/

This is a plain text response indicating successful deletion of a file or folder.

```text
File/folder deleted
```

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

### Rename File/Folder using Node.js

Source: https://nekoapi.nekoweb.org/

Use this Node.js snippet to rename or move a file or folder. It sends a POST request with URL-encoded parameters.

```javascript
const { URLSearchParams } = require('url');
const fetch = require('node-fetch');
const encodedParams = new URLSearchParams();

encodedParams.set('pathname', 'test');
encodedParams.set('newpathname', 'test2');

let url = 'https://nekoweb.org/api/files/rename';

let options = {
  method: 'POST',
  headers: {
    Authorization: '177e9b41e8b35b5e3cf90dd4a1ce90b9c8d1e6aa79863c0ebfd9c1e5dbb4d24d',
    'content-type': 'application/x-www-form-urlencoded'
  },
  body: encodedParams
};

fetch(url, options)
  .then(res => res)
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

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

### Delete File or Folder Node.js

Source: https://nekoapi.nekoweb.org/

Delete a file or folder from the nekoweb server. Requires an API key for authorization. The request body must be form-urlencoded.

```javascript
const { URLSearchParams } = require('url');
const fetch = require('node-fetch');
const encodedParams = new URLSearchParams();

encodedParams.set('pathname', 'test');

let url = 'https://nekoweb.org/api/files/delete';

let options = {
  method: 'POST',
  headers: {
    Authorization: '177e9b41e8b35b5e3cf90dd4a1ce90b9c8d1e6aa79863c0ebfd9c1e5dbb4d24d',
    'content-type': 'application/x-www-form-urlencoded'
  },
  body: encodedParams
};

fetch(url, options)
  .then(res => res)
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

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

### Rename or Move File/Folder

Source: https://nekoapi.nekoweb.org/

Renames or moves an existing file or folder to a new path.

```APIDOC
## POST /files/rename

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

### Method
POST

### Endpoint
https://nekoweb.org/api/files/rename

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

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

### Response
#### Success Response (200)
- **message** (string) - Indicates the operation was successful (e.g., "File/folder renamed").
```

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

### Delete File or Folder

Source: https://nekoapi.nekoweb.org/

Deletes a specified file or folder from the user's account. Requires an API key for authorization.

```APIDOC
## POST /files/delete

### Description
Delete a file or folder.

### Method
POST

### Endpoint
/files/delete

### Parameters
#### Header Parameters
- **Authorization** (string) - Required - API key for authentication.

#### Request Body
- **pathname** (string) - Required - The path to the file or folder to be deleted.

### Responses
#### Success Response (200)
OK

### Request Example
```javascript
const { URLSearchParams } = require('url');
const fetch = require('node-fetch');
const encodedParams = new URLSearchParams();

encodedParams.set('pathname', 'test');

let url = 'https://nekoweb.org/api/files/delete';

let options = {
  method: 'POST',
  headers: {
    Authorization: '177e9b41e8b35b5e3cf90dd4a1ce90b9c8d1e6aa79863c0ebfd9c1e5dbb4d24d',
    'content-type': 'application/x-www-form-urlencoded'
  },
  body: encodedParams
};

fetch(url, options)
  .then(res => res)
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```
```

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

### Edit File

Source: https://nekoapi.nekoweb.org/

Edits the content of an existing file.

```APIDOC
## POST /files/edit

### Description
Edit a file.

### Method
POST

### Endpoint
https://nekoweb.org/api/files/edit

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

### Request Body
- **pathname** (string) - Required - The path to the file to be edited.
- **content** (string) - Required - The new content for the file.

### Response
#### Success Response (200)
- **message** (string) - Indicates the operation was successful (e.g., "File edited").
```

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

### Move Big File Upload (Node.js)

Source: https://nekoapi.nekoweb.org/

This Node.js snippet demonstrates how to move a big file upload to its final destination. It requires 'node-fetch' and sets the 'content-type' to 'application/x-www-form-urlencoded'.

```javascript
const { URLSearchParams } = require('url');
const fetch = require('node-fetch');
const encodedParams = new URLSearchParams();

encodedParams.set('id', 'fnc8orbox7dk71y1kzwke');
encodedParams.set('pathname', 'test.txt');

let url = 'https://nekoweb.org/api/files/big/move';

let options = {
  method: 'POST',
  headers: {
    Authorization: '177e9b41e8b35b5e3cf90dd4a1ce90b9c8d1e6aa79863c0ebfd9c1e5dbb4d24d',
    'content-type': 'application/x-www-form-urlencoded'
  },
  body: encodedParams
};

fetch(url, options)
  .then(res => res)
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

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

### Append Chunk to Big File Upload

Source: https://nekoapi.nekoweb.org/

Appends a chunk of data to a large file upload. Note that persistence requires a subsequent call to `/files/big/move` or `/files/import/:bigid`.

```javascript
const fetch = require('node-fetch');

let url = 'https://nekoweb.org/api/files/big/append';

let options = {
  method: 'POST',
  headers: {
    Authorization: '177e9b41e8b35b5e3cf90dd4a1ce90b9c8d1e6aa79863c0ebfd9c1e5dbb4d24d'
  }
};

// Assuming 'formData' is a FormData object with 'id' and 'file' appended
// Example: 
// const FormData = require('form-data');
// const formData = new FormData();
// formData.append('id', 'your_big_file_id');
// formData.append('file', fs.createReadStream('path/to/your/chunk'));

// options.body = formData;

// fetch(url, options)
//   .then(res => res)
//   .then(json => console.log(json))
//   .catch(err => console.error('error:' + err));
```

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

### Edit File Content using Node.js

Source: https://nekoapi.nekoweb.org/

This Node.js snippet allows editing the content of a file. It uses `multipart/form-data` for the request body.

```javascript
const FormData = require('form-data');
const fetch = require('node-fetch');
const formData = new FormData();

formData.append('pathname', 'test/test.txt');
formData.append('content', 'Hello world');

let url = 'https://nekoweb.org/api/files/edit';

let options = {
  method: 'POST',
  headers: {
    Authorization: '177e9b41e8b35b5e3cf90dd4a1ce90b9c8d1e6aa79863c0ebfd9c1e5dbb4d24d'
  }
};

options.body = formData;

fetch(url, options)
  .then(res => res)
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

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

### Append Big File

Source: https://nekoapi.nekoweb.org/

Appends data to a large file upload. This is typically the first step in uploading large files in chunks.

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

### Description
Appends data to a large file upload.

### Method
POST

### Endpoint
https://nekoweb.org/api/files/big/append

### Parameters
#### Header Parameters
- **Authorization** (string) - Required - API Key for authentication.

#### Request Body
- **id** (string) - Required - The ID of the big file upload.
- **file** (file) - Required - The file chunk to append.

### Request Example
```javascript
const FormData = require('form-data');
const fetch = require('node-fetch');
const formData = new FormData();

formData.append('id', 'fnc8orbox7dk71y1kzwke');
formData.append('file', 'test.txt', { filepath: './test.txt' });

let url = 'https://nekoweb.org/api/files/big/append';

let options = {
  method: 'POST',
  headers: {
    Authorization: '177e9b41e8b35b5e3cf90dd4a1ce90b9c8d1e6aa79863c0ebfd9c1e5dbb4d24d'
  }
};

options.body = formData;

fetch(url, options)
  .then(res => res)
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

### Response
#### Success Response (200)
- **text/plain** - Appended
```

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

### Append Chunk to Big File Upload

Source: https://nekoapi.nekoweb.org/

Appends a chunk of data to an ongoing big file upload. Requires subsequent calls to persist the file.

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

### Description
Append a chunk to a big file upload.
**⚠ Note:** you'll need to call `/files/big/move` or `/files/import/:bigid` to persist the file.

### Method
POST

### Endpoint
https://nekoweb.org/api/files/big/append

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

### Request Body
- **id** (string) - Required - The ID of the big file upload obtained from `/files/big/create`.
- **file** (binary) - Required - The chunk of the file to upload.
```

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

### Move Big File

Source: https://nekoapi.nekoweb.org/

Moves a big file upload to its final destination after all chunks have been appended.

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

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

### Method
POST

### Endpoint
https://nekoweb.org/api/files/big/move

### Parameters
#### Header Parameters
- **Authorization** (string) - Required - API Key for authentication.

#### Request Body
- **id** (string) - Required - The ID of the big file upload.
- **pathname** (string) - Required - The final path for the file.

### Request Example
```javascript
const { URLSearchParams } = require('url');
const fetch = require('node-fetch');
const encodedParams = new URLSearchParams();

encodedParams.set('id', 'fnc8orbox7dk71y1kzwke');
encodedParams.set('pathname', 'test.txt');

let url = 'https://nekoweb.org/api/files/big/move';

let options = {
  method: 'POST',
  headers: {
    Authorization: '177e9b41e8b35b5e3cf90dd4a1ce90b9c8d1e6aa79863c0ebfd9c1e5dbb4d24d',
    'content-type': 'application/x-www-form-urlencoded'
  },
  body: encodedParams
};

fetch(url, options)
  .then(res => res)
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
```

### Response
#### Success Response (200)
- **text/plain** - Moved
```
Tokens:
Raw