search

Update a File

Update a File in your account.

PUT https://{region}.getafile.io/api/v1/teams/:team_id/file/:id

This endpoint allows you to update a File in your account.

hashtag
Path Parameters

Name
Type
Description

id*

integer

ID of the File

team_id*

integer

ID of the Team

hashtag
Request Body

Name
Type
Description

description*

string

Description of the file for social sharing

published*

string

Published: 1 or 0

type*

string

Type of File (image, document, video)

name*

string

Reference name for the File

url*

string

URL where the File can be accessed

domain_id*

integer

ID of the Domain

path_id

string

ID of the File Path

ips

string

Restrict access to the File to IP addresses: eg. xx.xxx.xx.xx, xxx.xx.xxx.x

password

string

Password protect the File

download_only*

integer

Download only: 1 or 0

external_id

string

External ID from another platform for reference

filereferrer

array

An array of referrer IDs

{
    "id": 64,
    "user_id": 1,
    "domain_id": 8,
    "name": "Test",
    "path_id": null,
    "tags": null,
    "url": "test",
    "fullurl": "test",
    "published": 1,
    "type": "document",
    "discoverable": 0,
    "password": null,
    "ips": null,
    "external_id": null,
    "created_at": "2020-10-04T06:01:11.000Z",
    "updated_at": "2020-10-04T06:01:11.000Z",
    "uri": "https://sandbox-getafile-online.getafile.online/test",
    "statusping": 1,
    "statusping_config": {
      "retries": 3,
      "retries_pause": 3,
      "emails": ["[email protected]"],
    },
    "serving_type": "file",
    "content": null
}

PreviousCreate a FileNextDelete a File

Last updated

Was this helpful?