FileObject

JSON Example

{
    "_last_modified": "string",
    "checksum": "string",
    "child_refs": [
        "string"
    ],
    "compressed": false,
    "configpb_attributes": {
        "version": 0
    },
    "created": "string",
    "crl_info": {
        "common_name": "string",
        "distinguished_name": "string",
        "etag": "string",
        "fingerprint": "string",
        "last_refreshed": "string",
        "last_update": "string",
        "next_update": "string",
        "server_url": "string",
        "text": "string",
        "update_interval": 0
    },
    "description": "string",
    "events": [
        {
            "task_event": [
                {
                    "duration": 0,
                    "end_time": "string",
                    "message": "string",
                    "start_time": "string",
                    "status": "string"
                }
            ],
            "task_name": "string"
        }
    ],
    "expires_at": "string",
    "gslb_geodb_format": "string",
    "has_parent": false,
    "is_federated": false,
    "name": "string",
    "path": "string",
    "read_only": false,
    "restrict_download": false,
    "size": 0,
    "tenant_ref": "string",
    "type": "string",
    "url": "string",
    "uuid": "string",
    "version": "string"
}

string

_last_modified

Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

string

checksum

Optional

SHA1 checksum of the file. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

array of string

child_refs

Optional

AVI internal formatted/converted files. It is a reference to an object of type FileObject. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

boolean

compressed

Optional

This field indicates whether the file is gzip-compressed. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

ConfigPbAttributes

configpb_attributes

Optional

configpb_attributes

string

created

Optional

Timestamp of creation for the file. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

CRL

crl_info

Optional

crl_info

string

description

Optional

Description of the file. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

array of FileObjectEventMap

events

Optional

List of all FileObject events. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string

expires_at

Optional

Timestamp when the file will be no longer needed and can be removed by the system. If this is set, a garbage collector process will try to remove the file after this time. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

gslb_geodb_format

Optional

This field indicates the file format of GSLB geodb file type. Enum options - GSLB_GEODB_FILE_FORMAT_AVI, GSLB_GEODB_FILE_FORMAT_MAXMIND_CITY, GSLB_GEODB_FILE_FORMAT_MAXMIND_CITY_V6, GSLB_GEODB_FILE_FORMAT_MAXMIND_CITY_V4_AND_V6, GSLB_GEODB_FILE_FORMAT_AVI_V6, GSLB_GEODB_FILE_FORMAT_AVI_V4_AND_V6. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

boolean

has_parent

Optional

This field indicates if the the given FileObjecthas a parent FileObject or not. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

boolean

is_federated

Optional

This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

name

Required

Name of the file object. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

path

Optional

Path to the file. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean

read_only

Optional

Enforce Read-Only on the file. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean

restrict_download

Optional

Flag to allow/restrict download of the file. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint64 As uint64

size

Optional

Size of the file. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

tenant_ref

Optional

Tenant that this object belongs to. It is a reference to an object of type Tenant. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

type

Required

Type of the file. Enum options - OTHER_FILE_TYPES, IP_REPUTATION, GEO_DB, TECH_SUPPORT, HSMPACKAGES, IPAMDNSSCRIPTS, CONTROLLER_IMAGE, CRL_DATA, IP_REPUTATION_IPV6, GSLB_GEO_DB, CSRF_JS. Field introduced in 20.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition. Allowed in Essentials (Allowed values- OTHER_FILE_TYPES), Basic (Allowed values- OTHER_FILE_TYPES) edition.

string

url

Optional

url

string

uuid

Optional

UUID of the file. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

version

Optional

Version of the file. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.