Server Groups

PreviousSecurity Policies NextTags

Last updated 27 days ago

Was this helpful?

Get all Server Groups (sites/domains)

get

Get all Server Groups in a configuration. (Usually, each Server Group represents a site or domain.)

Path parameters

configstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/server-groups'

200

400

500

{
  "total": 1,
  "items": [
    {
      "id": "text",
      "challenge_cookie_domain": "text",
      "description": "text",
      "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"
    }
  ]
}

Server Groups retrieved successfully

Get a specific Server Group (a specific site/domain)

get

Get a Server Group from the specified configuration

Path parameters

configstringrequired

entry_idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/server-groups/{entry_id}'

200

400

422

500

{
  "id": "text",
  "challenge_cookie_domain": "text",
  "description": "text",
  "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"
}

Server Group retrieved successfully

Delete a Server Group (a site/domain)

delete

Delete a Server Group from the specified configuration

Path parameters

configstringrequired

entry_idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v4.0/conf/{config}/server-groups/{entry_id}'

200

400

422

500

{
  "message": "Successfully deleted entry"
}

Server Group deleted successfully

Modify Server Group (a site/domain)

put

Update an individual Server Group within a configuration

Path parameters

configstringrequired

entry_idstringrequired

Body

idstringrequired

Unique id

Pattern: ^[A-Za-z0-9\-\_]*$

challenge_cookie_domainstring · min: 1required

The domain for a challenge's cookie.

descriptionstring · default: ""optional

mobile_application_groupstringoptional

ID of Mobile Application Group used for site.

namestring · min: 1 · max: 250required

site name

proxy_templatestringrequired

ID of Proxy template used for site.

routing_profilestringrequired

ID of Routing profile used for site.

security_policystringrequired

ID of security policy applied on site.

server_namesstring[]required

host names corresponding to the site.

ssl_certificatestringoptional

ID of SSL certificate attached to site.

client_certificatestringoptional

ID of SSL client CA certificate attached to site.

client_certificate_modestring · enum · default: "on"optional

Controls how client certificate is checked when mTLS is enabled.

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/server-groups/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "challenge_cookie_domain": "text",
    "description": "text",
    "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"
  }'

200

400

422

500

{
  "message": "Successfully updated entry"
}

Server Group updated successfully

Create Server Group (a site/domain)

post

Create a Server Group within a configuration

Path parameters

configstringrequired

entry_idstringrequired

Pattern: ^[A-Za-z0-9\-\_]*$

Body

idstringrequired

Unique id

Pattern: ^[A-Za-z0-9\-\_]*$

challenge_cookie_domainstring · min: 1required

The domain for a challenge's cookie.

descriptionstring · default: ""optional

mobile_application_groupstringoptional

ID of Mobile Application Group used for site.

namestring · min: 1 · max: 250required

site name

proxy_templatestringrequired

ID of Proxy template used for site.

routing_profilestringrequired

ID of Routing profile used for site.

security_policystringrequired

ID of security policy applied on site.

server_namesstring[]required

host names corresponding to the site.

ssl_certificatestringoptional

ID of SSL certificate attached to site.

client_certificatestringoptional

ID of SSL client CA certificate attached to site.

client_certificate_modestring · enum · default: "on"optional

Controls how client certificate is checked when mTLS is enabled.

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v4.0/conf/{config}/server-groups/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "challenge_cookie_domain": "text",
    "description": "text",
    "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"
  }'

201

400

422

500

{
  "message": "Successfully created entry"
}

Server Group created successfully