Avi ControllerPortalRegistration Object API
CLI ``` ```
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 /controllerportalregistrationpost /controllerportalregistrationdelete /controllerportalregistration/{uuid}get /controllerportalregistration/{uuid}patch /controllerportalregistration/{uuid}put /controllerportalregistration/{uuid}
Up
get /controllerportalregistration
(controllerportalregistrationGet)
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" : [ {
"portal_auth" : {
"access_token" : "aeiou",
"jwt_token" : "aeiou",
"instance_url" : "aeiou"
},
"tenant_ref" : "aeiou",
"name" : "aeiou",
"asset" : {
"asset_id" : "aeiou"
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
ControllerPortalRegistrationApiResponse
401
log in failed
Up
post /controllerportalregistration
(controllerportalregistrationPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — ControllerPortalRegistration object creation
Return type
Example data
Content-Type: application/json
{
"portal_auth" : {
"access_token" : "aeiou",
"jwt_token" : "aeiou",
"instance_url" : "aeiou"
},
"tenant_ref" : "aeiou",
"name" : "aeiou",
"asset" : {
"asset_id" : "aeiou"
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
ControllerPortalRegistration
401
log in failed
Up
delete /controllerportalregistration/{uuid}
(controllerportalregistrationUuidDelete)
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 /controllerportalregistration/{uuid}
(controllerportalregistrationUuidGet)
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
{
"portal_auth" : {
"access_token" : "aeiou",
"jwt_token" : "aeiou",
"instance_url" : "aeiou"
},
"tenant_ref" : "aeiou",
"name" : "aeiou",
"asset" : {
"asset_id" : "aeiou"
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
ControllerPortalRegistration
401
log in failed
Up
patch /controllerportalregistration/{uuid}
(controllerportalregistrationUuidPatch)
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 — ControllerPortalRegistration object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"portal_auth" : {
"access_token" : "aeiou",
"jwt_token" : "aeiou",
"instance_url" : "aeiou"
},
"tenant_ref" : "aeiou",
"name" : "aeiou",
"asset" : {
"asset_id" : "aeiou"
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
ControllerPortalRegistration
401
log in failed
Up
put /controllerportalregistration/{uuid}
(controllerportalregistrationUuidPut)
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 — ControllerPortalRegistration object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"portal_auth" : {
"access_token" : "aeiou",
"jwt_token" : "aeiou",
"instance_url" : "aeiou"
},
"tenant_ref" : "aeiou",
"name" : "aeiou",
"asset" : {
"asset_id" : "aeiou"
},
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "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
ControllerPortalRegistration
401
log in failed
[ Jump to Methods ]
Table of Contents
ControllerPortalAssetControllerPortalAuthControllerPortalRegistrationControllerPortalRegistrationApiResponse
asset_id (optional)
String Asset ID corresponding to this Controller Cluster, returned on a successful registration. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
access_token (optional)
String Access Token to authenticate Customer Portal REST calls. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
instance_url (optional)
String Salesforce instance URL. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
jwt_token (optional)
String Signed JWT to refresh the access token. Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
asset (optional)
ControllerPortalAsset Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
name
String Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
portal_auth (optional)
ControllerPortalAuth Field introduced in 18.2.6. 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 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
uuid (optional)
String Field introduced in 18.2.6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
count
results
next (optional)