Get All Agent Group Config
Get all agent group configs
Get all agent group configs
Request
URI
GET
https://{api_host}/api/v2/agent/groups
COPY
Query Parameters
Responses
200
Agent group configs retrieved successfully
[
{
"content": [
{}
],
"empty": false,
"first": false,
"last": false,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": false,
"sort": {
"empty": false,
"sorted": false,
"unsorted": false
},
"unpaged": false
},
"size": 0,
"sort": {
"empty": false,
"sorted": false,
"unsorted": false
},
"totalElements": 0,
"totalPages": 0
}
]
array of
object
400
Bad request: Invalid input data
Returns
ErrorBody
of type(s)
application/json
{
"errorCode": "string",
"errorDetails": {},
"errorMessage": "string"
}
string
errorCode
Optional
errorCode
Possible values are :
API_ERROR,
LIMIT_ERROR,
FIELD_ERROR,
TEST_ERROR,
JSON_FORMAT_ERROR,
LICENSE_ERROR,
VSPHERE_INTEGRATION_ERROR,
VROPS_INTEGRATION_ERROR,
UPGRADE_ERROR,
SEARCH_ERROR,
AGENT_ERROR,
RBAC_COMMON_ERROR,
RBAC_USERS_ERROR,
RBAC_GROUPS_ERROR,
RBAC_ADGROUPS_ERROR,
RBAC_DATASETS_ERROR,
RBAC_VIDM_GROUPS_ERROR,
RBAC_VIDB_GROUPS_ERROR,
AUTH_PROVIDER_ERROR,
SECURITY_ERROR,
DEPLOYMENT_ERROR,
SUPPORT_BUNDLE_ERROR,
VIP_ERROR,
LOAD_BALANCER_ERROR,
VIDM_ERROR,
VIDB_ERROR,
AD_ERROR,
WEBHOOK_ERROR,
WEB_PROXY_ERROR,
SMTP_ERROR,
QUERY_ERROR,
CERTIFICATE_PEM_FORMAT_ERROR,
CERTIFICATE_FILE_INVALID,
CERTIFICATE_UPDATE_ERROR,
NSX_INTEGRATION_ERROR,
NSX_MANAGER_CONNECTIVITY_ERROR,
NO_CONFIGURATION_ERROR,
SSL_ERROR,
CERTIFICATE_PURPOSE_ERROR,
VCF_CAPABILITIES_REGISTRY_ERROR,
VALIDATION_ERROR,
INTERNAL_SERVER_ERROR,
UNPROCESSABLE_ENTITY,
RESOURCE_EXHAUSTED,
object
errorDetails
Optional
errorDetails
string
errorMessage
Optional
errorMessage
403
Forbidden: Authentication required
Returns
ErrorBody
of type(s)
application/json
{
"errorCode": "string",
"errorDetails": {},
"errorMessage": "string"
}
string
errorCode
Optional
errorCode
Possible values are :
API_ERROR,
LIMIT_ERROR,
FIELD_ERROR,
TEST_ERROR,
JSON_FORMAT_ERROR,
LICENSE_ERROR,
VSPHERE_INTEGRATION_ERROR,
VROPS_INTEGRATION_ERROR,
UPGRADE_ERROR,
SEARCH_ERROR,
AGENT_ERROR,
RBAC_COMMON_ERROR,
RBAC_USERS_ERROR,
RBAC_GROUPS_ERROR,
RBAC_ADGROUPS_ERROR,
RBAC_DATASETS_ERROR,
RBAC_VIDM_GROUPS_ERROR,
RBAC_VIDB_GROUPS_ERROR,
AUTH_PROVIDER_ERROR,
SECURITY_ERROR,
DEPLOYMENT_ERROR,
SUPPORT_BUNDLE_ERROR,
VIP_ERROR,
LOAD_BALANCER_ERROR,
VIDM_ERROR,
VIDB_ERROR,
AD_ERROR,
WEBHOOK_ERROR,
WEB_PROXY_ERROR,
SMTP_ERROR,
QUERY_ERROR,
CERTIFICATE_PEM_FORMAT_ERROR,
CERTIFICATE_FILE_INVALID,
CERTIFICATE_UPDATE_ERROR,
NSX_INTEGRATION_ERROR,
NSX_MANAGER_CONNECTIVITY_ERROR,
NO_CONFIGURATION_ERROR,
SSL_ERROR,
CERTIFICATE_PURPOSE_ERROR,
VCF_CAPABILITIES_REGISTRY_ERROR,
VALIDATION_ERROR,
INTERNAL_SERVER_ERROR,
UNPROCESSABLE_ENTITY,
RESOURCE_EXHAUSTED,
object
errorDetails
Optional
errorDetails
string
errorMessage
Optional
errorMessage
500
Internal server error
Returns
ErrorBody
of type(s)
application/json
"ErrorBody Object"
string
errorCode
Optional
errorCode
Possible values are :
API_ERROR,
LIMIT_ERROR,
FIELD_ERROR,
TEST_ERROR,
JSON_FORMAT_ERROR,
LICENSE_ERROR,
VSPHERE_INTEGRATION_ERROR,
VROPS_INTEGRATION_ERROR,
UPGRADE_ERROR,
SEARCH_ERROR,
AGENT_ERROR,
RBAC_COMMON_ERROR,
RBAC_USERS_ERROR,
RBAC_GROUPS_ERROR,
RBAC_ADGROUPS_ERROR,
RBAC_DATASETS_ERROR,
RBAC_VIDM_GROUPS_ERROR,
RBAC_VIDB_GROUPS_ERROR,
AUTH_PROVIDER_ERROR,
SECURITY_ERROR,
DEPLOYMENT_ERROR,
SUPPORT_BUNDLE_ERROR,
VIP_ERROR,
LOAD_BALANCER_ERROR,
VIDM_ERROR,
VIDB_ERROR,
AD_ERROR,
WEBHOOK_ERROR,
WEB_PROXY_ERROR,
SMTP_ERROR,
QUERY_ERROR,
CERTIFICATE_PEM_FORMAT_ERROR,
CERTIFICATE_FILE_INVALID,
CERTIFICATE_UPDATE_ERROR,
NSX_INTEGRATION_ERROR,
NSX_MANAGER_CONNECTIVITY_ERROR,
NO_CONFIGURATION_ERROR,
SSL_ERROR,
CERTIFICATE_PURPOSE_ERROR,
VCF_CAPABILITIES_REGISTRY_ERROR,
VALIDATION_ERROR,
INTERNAL_SERVER_ERROR,
UNPROCESSABLE_ENTITY,
RESOURCE_EXHAUSTED,
object
errorDetails
Optional
errorDetails
string
errorMessage
Optional
errorMessage
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/api/v2/agent/groups?pageable=v