GET /ipreputationdb/{uuid}

/ipreputationdb/{uuid}

Request

URI

GET

https://api_host/api/ipreputationdb/{uuid}

COPY

Path Parameters

string

uuid

Required

UUID of the object to fetch

Query Parameters

string

name

Optional

object name

string

fields

Optional

List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

boolean

include_name

Optional

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.

boolean

skip_default

Optional

Default values are not set.

string

join_subresources

Optional

It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

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.

Responses

200

Returns IPReputationDB of type(s) application/json

{
    "_last_modified": "string",
    "base_file_refs": [
        "string"
    ],
    "configpb_attributes": {
        "version": 0
    },
    "description": "string",
    "incremental_file_refs": [
        "string"
    ],
    "markers": [
        {
            "key": "string",
            "values": [
                "string"
            ]
        }
    ],
    "name": "string",
    "service_status": {
        "error": "string",
        "last_successful_update_check": {
            "secs": 0,
            "usecs": 0
        }
    },
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string",
    "vendor": "string",
    "version": "string"
}

string

_last_modified

Optional

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

array of string

base_file_refs

Optional

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.

ConfigPbAttributes

configpb_attributes

Optional

configpb_attributes

string

description

Optional

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

array of string

incremental_file_refs

Optional

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.

array of RoleFilterMatchLabel

markers

Optional

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.

string

name

Required

IP reputation DB name. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

IPReputationServiceStatus

service_status

Optional

service_status

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

url

Optional

url

string

uuid

Optional

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

string

vendor

Required

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.

string

version

Optional

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.

401

Operation doesn't return any data structure

On This Page

Description

Request

Path Parameters

Query Parameters

Header Parameters

Response

200 Response Body

Errors

Ipreputation Db Operations