Server Groups
Get all Server Groups in a configuration. (Usually, each Server Group represents a site or domain.)
Server Groups retrieved successfully
Bad Request
Internal Server Error
GET /api/v4.0/conf/{config}/server-groups HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"id": "text",
"challenge_cookie_domain": "text",
"description": "",
"mobile_application_group": "text",
"name": "text",
"proxy_template": "text",
"routing_profile": "text",
"security_policy": "text",
"server_names": [
"text"
],
"ssl_certificate": "text",
"client_certificate": "text",
"client_certificate_mode": "on"
}
]
}Get a Server Group from the specified configuration
Server Group retrieved successfully
Bad Request
Validation Error
Internal Server Error
GET /api/v4.0/conf/{config}/server-groups/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"id": "text",
"challenge_cookie_domain": "text",
"description": "",
"mobile_application_group": "text",
"name": "text",
"proxy_template": "text",
"routing_profile": "text",
"security_policy": "text",
"server_names": [
"text"
],
"ssl_certificate": "text",
"client_certificate": "text",
"client_certificate_mode": "on"
}Update an individual Server Group within a configuration
Unique id
^[A-Za-z0-9\-\_]*$The domain for a challenge's cookie.
""ID of Mobile Application Group used for site.
site name
ID of Proxy template used for site.
ID of Routing profile used for site.
ID of security policy applied on site.
host names corresponding to the site.
ID of SSL certificate attached to site.
ID of SSL client CA certificate attached to site.
Controls how client certificate is checked when mTLS is enabled.
onPossible values: Server Group updated successfully
Input Error
Validation Error
Internal Server Error
PUT /api/v4.0/conf/{config}/server-groups/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 293
{
"id": "text",
"challenge_cookie_domain": "text",
"description": "",
"mobile_application_group": "text",
"name": "text",
"proxy_template": "text",
"routing_profile": "text",
"security_policy": "text",
"server_names": [
"text"
],
"ssl_certificate": "text",
"client_certificate": "text",
"client_certificate_mode": "on"
}{
"message": "Successfully updated entry"
}Create a Server Group within a configuration
^[A-Za-z0-9\-\_]*$Unique id
^[A-Za-z0-9\-\_]*$The domain for a challenge's cookie.
""ID of Mobile Application Group used for site.
site name
ID of Proxy template used for site.
ID of Routing profile used for site.
ID of security policy applied on site.
host names corresponding to the site.
ID of SSL certificate attached to site.
ID of SSL client CA certificate attached to site.
Controls how client certificate is checked when mTLS is enabled.
onPossible values: Server Group created successfully
Bad Request
Validation Error
Internal Server Error
POST /api/v4.0/conf/{config}/server-groups/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 293
{
"id": "text",
"challenge_cookie_domain": "text",
"description": "",
"mobile_application_group": "text",
"name": "text",
"proxy_template": "text",
"routing_profile": "text",
"security_policy": "text",
"server_names": [
"text"
],
"ssl_certificate": "text",
"client_certificate": "text",
"client_certificate_mode": "on"
}{
"message": "Successfully created entry"
}Delete a Server Group from the specified configuration
Server Group deleted successfully
Input Error
Validation Error
Internal Server Error
DELETE /api/v4.0/conf/{config}/server-groups/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}Last updated
Was this helpful?