Gofile API

https://gofile.io/api
Admin
Integrate Gofile's powerful storage and content delivery capabilities into your applications using...
Tokens:4,219
Snippets:16
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### GET /contents/{contentId}

Source: https://gofile.io/api/index

Retrieves detailed information about a folder and its contents, including metadata and file listings. This endpoint only works with folder IDs. File information is included within the folder details when present.

```APIDOC
## GET /contents/{contentId}

### Description
Retrieves detailed information about a folder and its contents, including metadata and file listings. This endpoint only works with folder IDs. File information is included within the folder details when present.

### Method
GET

### Endpoint
`https://api.gofile.io/contents/{contentId}`

### Parameters
#### Path Parameters
- **contentId** (string) - Required - The ID of the folder to retrieve details for.

#### Query Parameters
- **password** (string) - Optional - SHA-256 hash of the password for accessing password-protected content. Required only when accessing password-protected folders.
```

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

### GET /accounts/{accountId}

Source: https://gofile.io/api/index

Retrieves detailed information about a specific Gofile account using its account ID. The account ID can be obtained via the `/accounts/getid` endpoint.

```APIDOC
## GET /accounts/{accountId}

### Description
Retrieves detailed information about a specific Gofile account using its account ID. The account ID can be obtained via the `/accounts/getid` endpoint.

### Method
GET

### Endpoint
`https://api.gofile.io/accounts/{accountId}`

### Parameters
#### Path Parameters
- **accountId** (string) - Required - The unique identifier of the account to retrieve information for.

#### Query Parameters
None

#### Request Body
None

### Request Example
(No request body needed, authentication is typically via headers)

### Response
#### Success Response (200)
- **accountInfo** (object) - An object containing various details about the account (e.g., username, email, storage stats).

#### Response Example
```json
{
  "status": "ok",
  "data": {
    "accountInfo": {
      "username": "exampleUser",
      "email": "user@example.com",
      "storageUsed": 1024,
      "storageTotal": 5120
    }
  }
}
```
```

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

### GET /contents/search

Source: https://gofile.io/api/index

Search for files and folders within a specific parent folder based on name or tags. The search is performed recursively through all subfolders of the specified folder. Results include both files and folders that match the search criteria.

```APIDOC
## GET /contents/search

### Description
Search for files and folders within a specific parent folder based on name or tags. The search is performed recursively through all subfolders of the specified folder. Results include both files and folders that match the search criteria.

### Method
GET

### Endpoint
`https://api.gofile.io/contents/search`

### Parameters
#### Query Parameters
- **contentId** (string) - Required - The identifier of the folder to search within. Must be a valid folder ID from your account.
- **searchedString** (string) - Required - Search string to match against content names or tags.

### Search Behavior
- Matches are case-insensitive
- Partial matches are supported (e.g., searching "doc" will match "document.pdf")
- Results include matches in both content names and tags
```

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

### GET /accounts/getid

Source: https://gofile.io/api/index

Retrieves the account ID associated with the provided API token. This ID is necessary for subsequent API calls related to your account.

```APIDOC
## GET /accounts/getid

### Description
Retrieves the account ID associated with the provided API token. This ID is necessary for subsequent API calls related to your account.

### Method
GET

### Endpoint
`https://api.gofile.io/accounts/getid`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
(No request body needed, authentication is typically via headers)

### Response
#### Success Response (200)
- **accountId** (string) - The unique identifier for your Gofile account.

#### Response Example
```json
{
  "status": "ok",
  "data": {
    "accountId": "yourAccountId123"
  }
}
```
```

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

### POST /contents/{contentId}/directlinks

Source: https://gofile.io/api/index

Creates a direct access link to your content. For folders, the system automatically generates a ZIP archive containing all files. Direct links provide immediate access to content without going through the download page interface. You can secure access using various restrictions like IP whitelist, domain limitations, or basic authentication.

```APIDOC
## POST /contents/{contentId}/directlinks

### Description
Creates a direct access link to your content. For folders, the system automatically generates a ZIP archive containing all files. Direct links provide immediate access to content without going through the download page interface. You can secure access using various restrictions like IP whitelist, domain limitations, or basic authentication.

### Method
POST

### Endpoint
`https://api.gofile.io/contents/{contentId}/directlinks`

### Parameters
#### Path Parameters
- **contentId** (string) - Required - The ID of the content for which to create a direct link.

#### Request Body
- **expireTime** (integer) - Optional - Unix timestamp when the direct link should expire. If not specified, the link will remain active indefinitely.
- **sourceIpsAllowed** (array) - Optional - Array of IP addresses allowed to access the direct link. Access will be restricted to these IPs only. Example: `["192.168.1.1", "10.0.0.1"]`
- **domainsAllowed** (array) - Optional - Array of domains allowed to embed or access the direct link. Useful for restricting content embedding. Example: `["example.com", "subdomain.example.com"]`
- **auth** (array) - Optional - Array of username:password combinations required for basic authentication access. Example: `["user1:pass1", "user2:pass2"]`
```

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

### Create Folder

Source: https://gofile.io/api/index

Creates a new folder within your specified parent folder. Use this endpoint to organize your content hierarchically. The newly created folder inherits access permissions from its parent folder.

```APIDOC
## POST /contents/createFolder

### Description
Creates a new folder within your specified parent folder. Use this endpoint to organize your content hierarchically. The newly created folder inherits access permissions from its parent folder.

### Method
POST

### Endpoint
`https://api.gofile.io/contents/createFolder`

### Parameters
#### Request Body
- **parentFolderId** (string) - required - The identifier of the parent folder where the new folder will be created. Must be a valid folder ID from your account.
- **folderName** (string) - optional - Custom name for the new folder. If not provided, the system will generate a unique folder name automatically.

### Request Example
```json
{
  "parentFolderId": "YOUR_PARENT_FOLDER_ID",
  "folderName": "My New Folder"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
- **data** (object) - Contains details about the newly created folder.
  - **folderId** (string) - The unique identifier of the created folder.
  - **folderName** (string) - The name of the created folder.
  - **parentFolderId** (string) - The identifier of the parent folder.
```

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

### POST /contents/import

Source: https://gofile.io/api/index

Imports public content into your account's root folder, allowing you to save shared content to your personal storage.

```APIDOC
## POST /contents/import (Import Public Content)

### Description
Imports public content into your account's root folder, allowing you to save shared content to your personal storage. Only publicly accessible content can be imported.

### Method
POST

### Endpoint
`https://api.gofile.io/contents/import`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **contentsId** (string) - Required - Comma-separated list of content IDs to import into your root folder.

### Request Example
```json
{
  "contentsId": "publicContent1,publicContent2"
}
```

### Response
#### Success Response (200)
Details of the operation's success or failure.

#### Response Example
```json
{
  "status": "ok",
  "data": {
    "info": "Public content imported successfully."
  }
}
```
```

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

### Upload File

Source: https://gofile.io/api/index

Upload files directly using the global upload endpoint or specific regional endpoints. Handles guest account creation and public folder generation if no parameters are provided.

```APIDOC
## POST /uploadfile

### Description
Upload files directly using our global upload endpoint. When uploading without parameters, the system will create a guest account, generate a new public folder in the root directory, and upload the file to this folder.

#### Regional Upload Endpoints
- `https://upload.gofile.io/uploadfile` (Automatic - Closest Region)
- `https://upload-eu-par.gofile.io/uploadfile` (Europe - Paris)
- `https://upload-na-phx.gofile.io/uploadfile` (North America - Phoenix)
- `https://upload-ap-sgp.gofile.io/uploadfile` (Asia Pacific - Singapore)
- `https://upload-ap-hkg.gofile.io/uploadfile` (Asia Pacific - Hong Kong)
- `https://upload-ap-tyo.gofile.io/uploadfile` (Asia Pacific - Tokyo)
- `https://upload-sa-sao.gofile.io/uploadfile` (South America - São Paulo)

### Method
POST

### Endpoint
`https://upload.gofile.io/uploadfile`

### Parameters
#### Form Data
- **file** (file) - required - The file to be uploaded to the server
- **folderId** (string) - optional - Identifier of the destination folder. If not provided, a new public folder will be created.

### Request Example
```
--boundary
Content-Disposition: form-data; name="file"; filename="example.txt"
Content-Type: text/plain

[file content]
--boundary
Content-Disposition: form-data; name="folderId"

[folder id]
--boundary--
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
- **data** (object) - Contains details about the uploaded file and its associated data.
  - **fileCode** (string) - Unique code for the uploaded file.
  - **directLink** (string) - Direct link to the uploaded file.
  - **uploadId** (string) - Identifier for the upload session.
  - **folderId** (string) - Identifier of the folder where the file was uploaded.
```

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

### POST /contents/copy

Source: https://gofile.io/api/index

Copy multiple files or folders to a specified destination folder.

```APIDOC
## POST /contents/copy

### Description
Copy multiple files or folders to a specified destination folder.

### Method
POST

### Endpoint
`https://api.gofile.io/contents/copy`

### Parameters
#### Request Body
- **contentsId** (string) - Required - Comma-separated list of content IDs to copy.
- **folderId** (string) - Required - The identifier of the destination folder where contents will be copied to.
```

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

### POST /contents/import

Source: https://gofile.io/api/index

Moves specified content (files or folders) to a designated destination folder within your account. Moving a folder recursively moves all its contents.

```APIDOC
## POST /contents/import

### Description
Moves specified content (files or folders) to a designated destination folder within your account. Moving a folder recursively moves all its contents.

### Method
POST

### Endpoint
`https://api.gofile.io/contents/import`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **contentsId** (string) - Required - Comma-separated list of content IDs to be moved. Can include both file and folder IDs.
- **folderId** (string) - Required - The identifier of the destination folder where the contents will be moved. Must be a valid folder ID from your account.

### Request Example
```json
{
  "contentsId": "content1,content2",
  "folderId": "destinationFolder123"
}
```

### Response
#### Success Response (200)
Details of the operation's success or failure.

#### Response Example
```json
{
  "status": "ok",
  "data": {
    "info": "Content moved successfully."
  }
}
```
```

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

### POST /accounts/{accountId}/resettoken

Source: https://gofile.io/api/index

Resets your current authentication token and generates a new one. A login link with the new token will be sent to your registered email address. This invalidates the current token immediately.

```APIDOC
## POST /accounts/{accountId}/resettoken

### Description
Resets your current authentication token and generates a new one. A login link with the new token will be sent to your registered email address. This invalidates the current token immediately.

### Method
POST

### Endpoint
`https://api.gofile.io/accounts/{accountId}/resettoken`

### Parameters
#### Path Parameters
- **accountId** (string) - Required - The unique identifier of the account whose token needs to be reset.

#### Query Parameters
None

#### Request Body
None

### Request Example
(No request body needed, authentication is typically via headers)

### Response
#### Success Response (200)
- **message** (string) - Confirmation that the token reset process has been initiated.

#### Response Example
```json
{
  "status": "ok",
  "data": {
    "message": "Token reset initiated. Check your email for the new login link."
  }
}
```
```

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

### Update Content

Source: https://gofile.io/api/index

Modify specific attributes of a file or folder. Different attributes are available depending on the content type. Attributes include name, description, tags, public status, expiry, and password.

```APIDOC
## PUT /contents/{contentId}/update

### Description
Modify specific attributes of a file or folder. Different attributes are available depending on the content type. Attributes include name, description, tags, public status, expiry, and password.

### Method
PUT

### Endpoint
`https://api.gofile.io/contents/{contentId}/update`

### Parameters
#### Path Parameters
- **contentId** (string) - required - The unique identifier of the content (file or folder) to update.

#### Request Body
- **attribute** (string) - required - The attribute to modify. Available options: `name`, `description`, `tags`, `public`, `expiry`, `password`.
- **attributeValue** (mixed) - required - The new value for the specified attribute. Expected format depends on the attribute:
  - `name`: String value for the content name.
  - `description`: Text description for the download page (folders only).
  - `tags`: Comma-separated string (e.g., "tag1,tag2,tag3") (folders only).
  - `public`: Boolean string ("true" or "false") (folders only).
  - `expiry`: Unix timestamp (e.g., 1704067200) (folders only).
  - `password`: String value for the access password (folders only).

### Request Example
```json
{
  "attribute": "name",
  "attributeValue": "New File Name.txt"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
- **message** (string) - A confirmation message regarding the update.
```

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

### PUT /contents/{contentId}/directlinks/{directLinkId}

Source: https://gofile.io/api/index

Updates the configuration of an existing direct link. Use this endpoint to modify access restrictions or update expiration settings. If a parameter is not included in the request, its corresponding restriction will be removed. To maintain existing restrictions, you must include the parameter with its desired value in the request.

```APIDOC
## PUT /contents/{contentId}/directlinks/{directLinkId}

### Description
Updates the configuration of an existing direct link. Use this endpoint to modify access restrictions or update expiration settings. If a parameter is not included in the request, its corresponding restriction will be removed. To maintain existing restrictions, you must include the parameter with its desired value in the request.

### Method
PUT

### Endpoint
`https://api.gofile.io/contents/{contentId}/directlinks/{directLinkId}`

### Parameters
#### Path Parameters
- **contentId** (string) - Required - The ID of the content associated with the direct link.
- **directLinkId** (string) - Required - The ID of the direct link to update.

#### Request Body
- **expireTime** (integer) - Optional - New Unix timestamp for link expiration.
- **sourceIpsAllowed** (array) - Optional - Updated list of allowed IP addresses. Example: `["192.168.1.1", "10.0.0.1"]`
- **domainsAllowed** (array) - Optional - Updated list of allowed domains. Example: `["example.com", "subdomain.example.com"]`
- **auth** (array) - Optional - Updated list of username:password pairs. Example: `["user1:pass1", "user2:pass2"]`
```

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

### PUT /contents/move

Source: https://gofile.io/api/index

Move multiple files and/or folders to a specified destination folder. This operation preserves all content attributes and permissions while updating their location in your storage hierarchy. Moving contents is an atomic operation - either all specified contents are moved successfully, or none are moved if an error occurs.

```APIDOC
## PUT /contents/move

### Description
Move multiple files and/or folders to a specified destination folder. This operation preserves all content attributes and permissions while updating their location in your storage hierarchy. Moving contents is an atomic operation - either all specified contents are moved successfully, or none are moved if an error occurs.

### Method
PUT

### Endpoint
`https://api.gofile.io/contents/move`

### Parameters
#### Request Body
- **contentsId** (string) - Required - Comma-separated list of content IDs to move.
- **folderId** (string) - Required - The identifier of the destination folder where contents will be moved to.
```

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

### Delete Content

Source: https://gofile.io/api/index

Permanently deletes specified files and folders from your account. This action cannot be undone. Warning: Deleting a folder will also remove all its contents, including subfolders and files.

```APIDOC
## DELETE /contents

### Description
Permanently deletes specified files and folders from your account. This action cannot be undone. Warning: Deleting a folder will also remove all its contents, including subfolders and files.

### Method
DELETE

### Endpoint
`https://api.gofile.io/contents`

### Parameters
#### Query Parameters
- **idList** (string) - required - A comma-separated list of content IDs (files and/or folders) to delete.

### Request Example
`https://api.gofile.io/contents?idList=contentId1,contentId2`

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
- **message** (string) - A confirmation message regarding the deletion.
```

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

### DELETE /contents/{contentId}/directlinks/{directLinkId}

Source: https://gofile.io/api/index

Permanently removes a direct link to content. Once deleted, the link cannot be recovered. This action only removes the direct link access - it does not affect the underlying content or other existing direct links to the same content.

```APIDOC
## DELETE /contents/{contentId}/directlinks/{directLinkId}

### Description
Permanently removes a direct link to content. Once deleted, the link cannot be recovered. This action only removes the direct link access - it does not affect the underlying content or other existing direct links to the same content.

### Method
DELETE

### Endpoint
`https://api.gofile.io/contents/{contentId}/directlinks/{directLinkId}`

### Parameters
#### Path Parameters
- **contentId** (string) - Required - The ID of the content associated with the direct link.
- **directLinkId** (string) - Required - The ID of the direct link to delete.
```
Tokens:
Raw