Server Groups

Get all Server Groups (sites/domains)

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

GET/api/v4.0/conf/{config}/server-groups

Path parameters

config*Config

Response

200400500

Server Groups retrieved successfully

Body

application/json

totalinteger

Example: 1

itemsarray of Site

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/server-groups', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400500

{
  "total": 1,
  "items": [
    {
      "challenge_cookie_domain": "text",
      "description": "text",
      "id": "text",
      "mobile_sdk": "text",
      "name": "text",
      "proxy_template": "text",
      "routing_profile": "text",
      "security_policy": "text",
      "server_names": [
        "text"
      ],
      "ssl_certificate": "text"
    }
  ]
}

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

Get a Server Group from the specified configuration

GET/api/v4.0/conf/{config}/server-groups/{entry_id}

Path parameters

config*Config

entry_id*Id

Response

200400422500

Server Group retrieved successfully

Body

application/json

challenge_cookie_domain*Challenge's Cookie Domain

The domain for a challenge's cookie.

descriptionDescription

id*Id

Unique id

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

mobile_sdkMobile SDK Settings

ID of Mobile SDK used for site.

name*Name

site name

proxy_template*Proxy Template

ID of Proxy template used for site.

routing_profile*Routing profile

ID of Routing profile used for site.

security_policy*Security Policy

ID of security policy applied on site.

server_names*Server Names

host names corresponding to the site.

ssl_certificateSSL Certificate

ID of SSL certificate attached to site.

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/server-groups/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400422500

{
  "challenge_cookie_domain": "text",
  "description": "text",
  "id": "text",
  "mobile_sdk": "text",
  "name": "text",
  "proxy_template": "text",
  "routing_profile": "text",
  "security_policy": "text",
  "server_names": [
    "text"
  ],
  "ssl_certificate": "text"
}

Modify Server Group (a site/domain)

Update an individual Server Group within a configuration

PUT/api/v4.0/conf/{config}/server-groups/{entry_id}

Path parameters

config*Config

entry_id*Id

Body

application/json

challenge_cookie_domain*Challenge's Cookie Domain

The domain for a challenge's cookie.

descriptionDescription

id*Id

Unique id

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

mobile_sdkMobile SDK Settings

ID of Mobile SDK used for site.

name*Name

site name

proxy_template*Proxy Template

ID of Proxy template used for site.

routing_profile*Routing profile

ID of Routing profile used for site.

security_policy*Security Policy

ID of security policy applied on site.

server_names*Server Names

host names corresponding to the site.

ssl_certificateSSL Certificate

ID of SSL certificate attached to site.

Response

200400422500

Server Group updated successfully

Body

application/json

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/server-groups/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "server_names": [
        "text"
      ],
      "security_policy": "text",
      "routing_profile": "text",
      "proxy_template": "text",
      "challenge_cookie_domain": "text"
    }),
});
const data = await response.json();

Response

200400422500

{
  "message": "Successfully updated entry"
}

Create Server Group (a site/domain)

Create a Server Group within a configuration

POST/api/v4.0/conf/{config}/server-groups/{entry_id}

Path parameters

config*Config

entry_id*Id

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

Body

application/json

challenge_cookie_domain*Challenge's Cookie Domain

The domain for a challenge's cookie.

descriptionDescription

id*Id

Unique id

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

mobile_sdkMobile SDK Settings

ID of Mobile SDK used for site.

name*Name

site name

proxy_template*Proxy Template

ID of Proxy template used for site.

routing_profile*Routing profile

ID of Routing profile used for site.

security_policy*Security Policy

ID of security policy applied on site.

server_names*Server Names

host names corresponding to the site.

ssl_certificateSSL Certificate

ID of SSL certificate attached to site.

Response

201400422500

Server Group created successfully

Body

application/json

message*Message

Information about successful create operation

Example: "Successfully created entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/server-groups/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "server_names": [
        "text"
      ],
      "security_policy": "text",
      "routing_profile": "text",
      "proxy_template": "text",
      "challenge_cookie_domain": "text"
    }),
});
const data = await response.json();

Response

201400422500

{
  "message": "Successfully created entry"
}

Delete a Server Group (a site/domain)

Delete a Server Group from the specified configuration

DELETE/api/v4.0/conf/{config}/server-groups/{entry_id}

Path parameters

config*Config

entry_id*Id

Response

200400422500

Server Group deleted successfully

Body

application/json

message*Message

Information about successful delete operation

Example: "Successfully deleted entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/server-groups/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200400422500

{
  "message": "Successfully deleted entry"
}