PATCH /fileobject/{uuid}

PATCH /fileobject/{uuid}

/fileobject/{uuid}

Request
URI
PATCH
https://{api_host}/api/fileobject/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-Avi-Version
Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string
X-CSRFToken
Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.

Request Body

FileObject object creation

FileObject of type(s) application/json
Optional

Show optional properties

{
    "name": "string",
    "type": "string"
}
{
    "_last_modified": "string",
    "checksum": "string",
    "compressed": false,
    "configpb_attributes": {
        "version": 0
    },
    "created": "string",
    "crl_info": {
        "body": "string",
        "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",
    "expires_at": "string",
    "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"
}
Responses
200

OK

Returns FileObject of type(s) application/json 
"FileObject Object"
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 in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
compressed
Optional

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

object
configpb_attributes
Optional

configpb_attributes

string
created
Optional

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

object
crl_info
Optional

crl_info

string
description
Optional

Description of the file. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, 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 in Enterprise edition with any value, Essentials, Basic, 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 in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
name
Required

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

string
path
Optional

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

boolean
read_only
Optional

Enforce Read-Only on the file. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, 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 in Enterprise edition with any value, 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 in Enterprise edition with any value, 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 in Enterprise edition with any value, 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. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- OTHER_FILE_TYPES), Basic edition(Allowed values- OTHER_FILE_TYPES), Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

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

string
version
Optional

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


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string","type:"string"}'
On This Page
File Object Operations
GET
GET /fileobject
POST
POST /fileobject
GET
GET /fileobject/{uuid}
PUT
PUT /fileobject/{uuid}
PATCH
PATCH /fileobject/{uuid}
DELETE
DELETE /fileobject/{uuid}
GET
GET /fileobject/{uuid}/federated_info/
PATCH
PATCH /fileobject/{uuid}/['']/
PUT
PUT /fileobject/{uuid}/['']/