Avi IPReputationDB Object API
CLI ``` - configure ipreputationdb - show ipreputationdb - show ipreputationdb data ```
Version: 22.1.5
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /ipreputationdbpost /ipreputationdbdelete /ipreputationdb/{uuid}get /ipreputationdb/{uuid}patch /ipreputationdb/{uuid}put /ipreputationdb/{uuid}get /ipreputationdb/{uuid}/runtime/internal/
(ipreputationdbGet)
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
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"description" : "aeiou",
"base_file_refs" : [ "aeiou" ],
"incremental_file_refs" : [ "aeiou" ],
"uuid" : "aeiou",
"version" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"vendor" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"service_status" : {
"error" : "aeiou",
"last_successful_update_check" : {
"usecs" : 123456789,
"secs" : 123456789
}
},
"configpb_attributes" : {
"version" : 123
},
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ]
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
IPReputationDBApiResponse
401
log in failed
(ipreputationdbPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — IPReputationDB object creation
Return type
Example data
Content-Type: application/json
{
"description" : "aeiou",
"base_file_refs" : [ "aeiou" ],
"incremental_file_refs" : [ "aeiou" ],
"uuid" : "aeiou",
"version" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"vendor" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"service_status" : {
"error" : "aeiou",
"last_successful_update_check" : {
"usecs" : 123456789,
"secs" : 123456789
}
},
"configpb_attributes" : {
"version" : 123
},
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
IPReputationDB
401
log in failed
Up
delete /ipreputationdb/{uuid}
(ipreputationdbUuidDelete)
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
object deleted
String
404
not found
Up
get /ipreputationdb/{uuid}
(ipreputationdbUuidGet)
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
Example data
Content-Type: application/json
{
"description" : "aeiou",
"base_file_refs" : [ "aeiou" ],
"incremental_file_refs" : [ "aeiou" ],
"uuid" : "aeiou",
"version" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"vendor" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"service_status" : {
"error" : "aeiou",
"last_successful_update_check" : {
"usecs" : 123456789,
"secs" : 123456789
}
},
"configpb_attributes" : {
"version" : 123
},
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
IPReputationDB
401
log in failed
Up
patch /ipreputationdb/{uuid}
(ipreputationdbUuidPatch)
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 — IPReputationDB object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"description" : "aeiou",
"base_file_refs" : [ "aeiou" ],
"incremental_file_refs" : [ "aeiou" ],
"uuid" : "aeiou",
"version" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"vendor" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"service_status" : {
"error" : "aeiou",
"last_successful_update_check" : {
"usecs" : 123456789,
"secs" : 123456789
}
},
"configpb_attributes" : {
"version" : 123
},
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
IPReputationDB
401
log in failed
Up
put /ipreputationdb/{uuid}
(ipreputationdbUuidPut)
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 — IPReputationDB object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"description" : "aeiou",
"base_file_refs" : [ "aeiou" ],
"incremental_file_refs" : [ "aeiou" ],
"uuid" : "aeiou",
"version" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"vendor" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"service_status" : {
"error" : "aeiou",
"last_successful_update_check" : {
"usecs" : 123456789,
"secs" : 123456789
}
},
"configpb_attributes" : {
"version" : 123
},
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
IPReputationDB
401
log in failed
Up
get /ipreputationdb/{uuid}/runtime/internal/
(ipreputationdbUuidRuntimeInternalGet)
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:
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
String
401
log in failed
[ Jump to Methods ]
Table of Contents
ConfigPbAttributesIPReputationDBIPReputationDBApiResponseIPReputationServiceStatusKeyValueRoleFilterMatchLabelTimeStamp
version (optional)
Integer Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
base_file_refs (optional)
array[String] IP reputation DB base file. It is a reference to an object of type FileObject. Field introduced in 20.1.1. Maximum of 1 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
configpb_attributes (optional)
ConfigPbAttributes Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
description (optional)
String Description. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
incremental_file_refs (optional)
array[String] IP reputation DB incremental update files. It is a reference to an object of type FileObject. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
markers (optional)
array[RoleFilterMatchLabel] List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
name
String IP reputation DB name. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
service_status (optional)
IPReputationServiceStatus If this object is managed by the IP reputation service, this field contain the status of this syncronization. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
uuid (optional)
String UUID of this object. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
vendor
String Organization providing IP reputation data. Enum options - IP_REPUTATION_VENDOR_WEBROOT. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
version (optional)
String A version number for this database object. This is informal for the consumer of this API only, a tool which manages this object can store version information here. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
count
results
next (optional)
error (optional)
String If the last attempted update failed, this is a more detailed error message. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
last_successful_update_check (optional)
TimeStamp The time when the IP reputation service last successfull attemped to update this object. This is the case when either this file references in this object got updated or when the IP reputation service knows positively that there are no newer versions for these files. It will be not update, if an error occurs during an update attempt. In this case, the errror will be set. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
key
String Key. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
String Value. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
key
String Key for filter match. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
values (optional)
array[String] Values for filter match. Multiple values will be evaluated as OR. Example key = value1 OR key = value2. Behavior for match is key = * if this field is empty. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
secs
Long Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int64
usecs
Long Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int64