Avi ErrorPageProfile Object API
CLI ``` - configure errorpageprofile - show errorpageprofile ```
Contact Info: support@avinetworks.com
Version: 21.1.6
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /errorpageprofilepost /errorpageprofiledelete /errorpageprofile/{uuid}get /errorpageprofile/{uuid}patch /errorpageprofile/{uuid}put /errorpageprofile/{uuid}
(errorpageprofileGet)
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" : [ {
"app_name" : "aeiou",
"company_name" : "aeiou",
"tenant_ref" : "aeiou",
"error_pages" : [ {
"error_page_body_ref" : "aeiou",
"enable" : true,
"error_redirect" : "aeiou",
"match" : {
"match_criteria" : "aeiou",
"ranges" : [ {
"end" : 123,
"begin" : 123
} ],
"status_codes" : [ "" ]
},
"index" : 123
} ],
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"uuid" : "aeiou",
"host_name" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "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
ErrorPageProfileApiResponse
401
log in failed
Up
post /errorpageprofile
(errorpageprofilePost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — ErrorPageProfile object creation
Return type
Example data
Content-Type: application/json
{
"app_name" : "aeiou",
"company_name" : "aeiou",
"tenant_ref" : "aeiou",
"error_pages" : [ {
"error_page_body_ref" : "aeiou",
"enable" : true,
"error_redirect" : "aeiou",
"match" : {
"match_criteria" : "aeiou",
"ranges" : [ {
"end" : 123,
"begin" : 123
} ],
"status_codes" : [ "" ]
},
"index" : 123
} ],
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"uuid" : "aeiou",
"host_name" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "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
ErrorPageProfile
401
log in failed
Up
delete /errorpageprofile/{uuid}
(errorpageprofileUuidDelete)
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 /errorpageprofile/{uuid}
(errorpageprofileUuidGet)
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
{
"app_name" : "aeiou",
"company_name" : "aeiou",
"tenant_ref" : "aeiou",
"error_pages" : [ {
"error_page_body_ref" : "aeiou",
"enable" : true,
"error_redirect" : "aeiou",
"match" : {
"match_criteria" : "aeiou",
"ranges" : [ {
"end" : 123,
"begin" : 123
} ],
"status_codes" : [ "" ]
},
"index" : 123
} ],
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"uuid" : "aeiou",
"host_name" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "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
ErrorPageProfile
401
log in failed
Up
patch /errorpageprofile/{uuid}
(errorpageprofileUuidPatch)
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 — ErrorPageProfile object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"app_name" : "aeiou",
"company_name" : "aeiou",
"tenant_ref" : "aeiou",
"error_pages" : [ {
"error_page_body_ref" : "aeiou",
"enable" : true,
"error_redirect" : "aeiou",
"match" : {
"match_criteria" : "aeiou",
"ranges" : [ {
"end" : 123,
"begin" : 123
} ],
"status_codes" : [ "" ]
},
"index" : 123
} ],
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"uuid" : "aeiou",
"host_name" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "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
ErrorPageProfile
401
log in failed
Up
put /errorpageprofile/{uuid}
(errorpageprofileUuidPut)
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 — ErrorPageProfile object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"app_name" : "aeiou",
"company_name" : "aeiou",
"tenant_ref" : "aeiou",
"error_pages" : [ {
"error_page_body_ref" : "aeiou",
"enable" : true,
"error_redirect" : "aeiou",
"match" : {
"match_criteria" : "aeiou",
"ranges" : [ {
"end" : 123,
"begin" : 123
} ],
"status_codes" : [ "" ]
},
"index" : 123
} ],
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"uuid" : "aeiou",
"host_name" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "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
ErrorPageProfile
401
log in failed
[ Jump to Methods ]
Table of Contents
ConfigPbAttributesErrorPageErrorPageProfileErrorPageProfileApiResponseHTTPStatusMatchHTTPStatusRangeKeyValueRoleFilterMatchLabel
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
enable (optional)
Boolean Enable or disable the error page. Field introduced in 17.2.4. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
error_page_body_ref (optional)
String Custom error page body used to sent to the client. It is a reference to an object of type ErrorPageBody. Field introduced in 17.2.4. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
error_redirect (optional)
String Redirect sent to client when match. Field introduced in 17.2.4. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
index (optional)
Integer Index of the error page. Field introduced in 17.2.4. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
match (optional)
HTTPStatusMatch Add match criteria for http status codes to the error page. Field introduced in 17.2.4. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
app_name (optional)
String Name of the Virtual Service which generated the error page. Field deprecated in 18.1.1. Field introduced in 17.2.4. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
company_name (optional)
String Name of the company to show in error page. Field deprecated in 18.1.1. Field introduced in 17.2.4. 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.
error_pages (optional)
array[ErrorPage] Defined Error Pages for HTTP status codes. Field introduced in 17.2.4. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
host_name (optional)
String Fully qualified domain name for which the error page is generated. Field deprecated in 18.1.1. Field introduced in 17.2.4. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
labels (optional)
array[KeyValue] Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field deprecated in 20.1.5. Field introduced in 20.1.3. Maximum of 4 items allowed. Allowed in Enterprise edition with any value, 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 Field introduced in 17.2.4. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Field introduced in 17.2.4. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
uuid (optional)
String Field introduced in 17.2.4. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
count
results
next (optional)
match_criteria
String Criterion to use for matching the HTTP response status code(s). Enum options - IS_IN, IS_NOT_IN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ranges (optional)
array[HTTPStatusRange] HTTP response status code range(s). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
status_codes (optional)
array[Integer] HTTP response status code(s). Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
begin
Integer Starting HTTP response status code. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
end
Integer Ending HTTP response status code. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
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.