Server Groups

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

200

Server Groups retrieved successfully

application/json

totalintegerOptionalExample: 1

400

Bad Request

application/json

500

Internal Server Error

application/json

get/api/v4.3/conf/{config}/server-groups

GET /api/v4.3/conf/{config}/server-groups HTTP/1.1
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": "off",
      "crl_verify": false,
      "crl": [
        "text"
      ],
      "cdp": [
        "text"
      ],
      "crl_statuses": [
        {
          "url": "https://example.com",
          "issuer": "text",
          "last_check": "text",
          "last_download": "text",
          "last_update": "text",
          "status": true,
          "error": "text"
        }
      ]
    }
  ]
}

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

get

Get a Server Group from the specified configuration

Path parameters

configstringRequired

entry_idstringRequired

Responses

200

Server Group retrieved successfully

application/json

idstringRequired

Unique id

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

challenge_cookie_domainstring · min: 1Required

The domain for a challenge's cookie.

descriptionstringOptionalDefault: ""

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 · enumOptional

Controls how client certificate is checked when mTLS is enabled.

Default: offPossible values:

crl_verifybooleanOptional

Enable Certificate Revocation List (CRL) validation for client certificates.

Default: false

crlstring[]Optional

List of CRL content bodies.

Default: []

cdpstring[]Optional

List of CRL Distribution Point URLs.

Default: []

400

Bad Request

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

get/api/v4.3/conf/{config}/server-groups/{entry_id}

GET /api/v4.3/conf/{config}/server-groups/{entry_id} HTTP/1.1
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": "off",
  "crl_verify": false,
  "crl": [
    "text"
  ],
  "cdp": [
    "text"
  ],
  "crl_statuses": [
    {
      "url": "https://example.com",
      "issuer": "text",
      "last_check": "text",
      "last_download": "text",
      "last_update": "text",
      "status": true,
      "error": "text"
    }
  ]
}

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.

descriptionstringOptionalDefault: ""

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 · enumOptional

Controls how client certificate is checked when mTLS is enabled.

Default: offPossible values:

crl_verifybooleanOptional

Enable Certificate Revocation List (CRL) validation for client certificates.

Default: false

crlstring[]Optional

List of CRL content bodies.

Default: []

cdpstring[]Optional

List of CRL Distribution Point URLs.

Default: []

Responses

200

Server Group updated successfully

application/json

messagestringRequired

Information about successful update operation

Example: Successfully updated entry

400

Input Error

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

put/api/v4.3/conf/{config}/server-groups/{entry_id}

PUT /api/v4.3/conf/{config}/server-groups/{entry_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 343

{
  "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": "off",
  "crl_verify": false,
  "crl": [
    "text"
  ],
  "cdp": [
    "text"
  ]
}

{
  "message": "Successfully updated entry"
}

Create Server Group (a site/domain)

post

Create a Server Group within a configuration

Path parameters

configstringRequired

entry_idstringRequiredPattern: ^[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.

descriptionstringOptionalDefault: ""

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 · enumOptional

Controls how client certificate is checked when mTLS is enabled.

Default: offPossible values:

crl_verifybooleanOptional

Enable Certificate Revocation List (CRL) validation for client certificates.

Default: false

crlstring[]Optional

List of CRL content bodies.

Default: []

cdpstring[]Optional

List of CRL Distribution Point URLs.

Default: []

Responses

201

Server Group created successfully

application/json

messagestringRequired

Information about successful create operation

Example: Successfully created entry

400

Bad Request

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

post/api/v4.3/conf/{config}/server-groups/{entry_id}

POST /api/v4.3/conf/{config}/server-groups/{entry_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 343

{
  "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": "off",
  "crl_verify": false,
  "crl": [
    "text"
  ],
  "cdp": [
    "text"
  ]
}

{
  "message": "Successfully created entry"
}

Delete a Server Group (a site/domain)

delete

Delete a Server Group from the specified configuration

Path parameters

configstringRequired

entry_idstringRequired

Responses

200

Server Group deleted successfully

application/json

messagestringRequired

Information about successful delete operation

Example: Successfully deleted entry

400

Input Error

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

delete/api/v4.3/conf/{config}/server-groups/{entry_id}

DELETE /api/v4.3/conf/{config}/server-groups/{entry_id} HTTP/1.1
Accept: */*

{
  "message": "Successfully deleted entry"
}

PreviousSecurity Policies NextTags

Last updated 7 months ago

Was this helpful?