Avi FileObject Object API

CLI ``` - configure fileobject - show fileobject ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 20.1.2
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /fileobject
  2. post /fileobject
  3. delete /fileobject/{uuid}
  4. get /fileobject/{uuid}
  5. patch /fileobject/{uuid}
  6. put /fileobject/{uuid}
Up
get /fileobject
(fileobjectGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

FileObjectApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "restrict_download" : true,
    "created" : "aeiou",
    "description" : "aeiou",
    "type" : "aeiou",
    "uuid" : "aeiou",
    "version" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou",
    "path" : "aeiou",
    "expires_at" : "aeiou",
    "size" : 123456789,
    "read_only" : true,
    "tenant_ref" : "aeiou",
    "checksum" : "aeiou",
    "name" : "aeiou",
    "compressed" : true,
    "is_federated" : true
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK FileObjectApiResponse

401

log in failed

Up
post /fileobject
(fileobjectPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — FileObject object creation

Return type

FileObject

Example data

Content-Type: application/json
{
  "restrict_download" : true,
  "created" : "aeiou",
  "description" : "aeiou",
  "type" : "aeiou",
  "uuid" : "aeiou",
  "version" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "path" : "aeiou",
  "expires_at" : "aeiou",
  "size" : 123456789,
  "read_only" : true,
  "tenant_ref" : "aeiou",
  "checksum" : "aeiou",
  "name" : "aeiou",
  "compressed" : true,
  "is_federated" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK FileObject

401

log in failed

Up
delete /fileobject/{uuid}
(fileobjectUuidDelete)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

object deleted String

404

not found

Up
get /fileobject/{uuid}
(fileobjectUuidGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

FileObject

Example data

Content-Type: application/json
{
  "restrict_download" : true,
  "created" : "aeiou",
  "description" : "aeiou",
  "type" : "aeiou",
  "uuid" : "aeiou",
  "version" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "path" : "aeiou",
  "expires_at" : "aeiou",
  "size" : 123456789,
  "read_only" : true,
  "tenant_ref" : "aeiou",
  "checksum" : "aeiou",
  "name" : "aeiou",
  "compressed" : true,
  "is_federated" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK FileObject

401

log in failed

Up
patch /fileobject/{uuid}
(fileobjectUuidPatch)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — FileObject object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

FileObject

Example data

Content-Type: application/json
{
  "restrict_download" : true,
  "created" : "aeiou",
  "description" : "aeiou",
  "type" : "aeiou",
  "uuid" : "aeiou",
  "version" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "path" : "aeiou",
  "expires_at" : "aeiou",
  "size" : 123456789,
  "read_only" : true,
  "tenant_ref" : "aeiou",
  "checksum" : "aeiou",
  "name" : "aeiou",
  "compressed" : true,
  "is_federated" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK FileObject

401

log in failed

Up
put /fileobject/{uuid}
(fileobjectUuidPut)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — FileObject object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

FileObject

Example data

Content-Type: application/json
{
  "restrict_download" : true,
  "created" : "aeiou",
  "description" : "aeiou",
  "type" : "aeiou",
  "uuid" : "aeiou",
  "version" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "path" : "aeiou",
  "expires_at" : "aeiou",
  "size" : 123456789,
  "read_only" : true,
  "tenant_ref" : "aeiou",
  "checksum" : "aeiou",
  "name" : "aeiou",
  "compressed" : true,
  "is_federated" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK FileObject

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. FileObject
  2. FileObjectApiResponse

FileObject Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
checksum (optional)
String SHA1 checksum of the file. Field introduced in 20.1.1.
compressed (optional)
Boolean This field indicates whether the file is gzip-compressed. Field introduced in 20.1.1.
created (optional)
String Timestamp of creation for the file. Field introduced in 20.1.1.
description (optional)
String Description of the file. Field introduced in 20.1.1.
expires_at (optional)
String 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.
is_federated (optional)
Boolean 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.
name
String Name of the file object. Field introduced in 20.1.1.
path (optional)
String Path to the file. Field introduced in 20.1.1.
read_only (optional)
Boolean Enforce Read-Only on the file. Field introduced in 20.1.1.
restrict_download (optional)
Boolean Flag to allow/restrict download of the file. Field introduced in 20.1.1.
size (optional)
Long Size of the file. Field introduced in 20.1.1. format: int64
tenant_ref (optional)
String Tenant that this object belongs to. It is a reference to an object of type Tenant. Field introduced in 20.1.1.
type
String Type of the file. Enum options - OTHER_FILE_TYPES, IP_REPUTATION, GEO_DB, TECH_SUPPORT, HSMPACKAGES, IPAMDNSSCRIPTS, CONTROLLER_IMAGE. Field introduced in 20.1.1.
url (optional)
String url
uuid (optional)
String UUID of the file. Field introduced in 20.1.1.
version (optional)
String Version of the file. Field introduced in 20.1.1.

FileObjectApiResponse Up

count
Integer format: int32
results
next (optional)