Server Groups

PreviousSecurity Policies NextTags

Last updated 5 months ago

Was this helpful?

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

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

500

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

Server Groups retrieved successfully

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

configConfigrequired

entry_idIdrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

422

500

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

Server Group retrieved successfully

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

configConfigrequired

entry_idIdrequired

Body

challenge_cookie_domainChallenge's Cookie Domainrequired

The domain for a challenge's cookie.

descriptionDescription

idIdrequired

Unique id

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

mobile_sdkMobile SDK Settings

ID of Mobile SDK used for site.

nameNamerequired

site name

proxy_templateProxy Templaterequired

ID of Proxy template used for site.

routing_profileRouting profilerequired

ID of Routing profile used for site.

security_policySecurity Policyrequired

ID of security policy applied on site.

ssl_certificateSSL Certificate

ID of SSL certificate attached to site.

server_namesServer Namesrequired

host names corresponding to the site.

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 '{"challenge_cookie_domain":"text","description":"","id":"text","name":"text","proxy_template":"text","routing_profile":"text","security_policy":"text","server_names":[null]}'

200

400

422

500

{
  "message": "Successfully updated entry"
}

Server Group updated successfully

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

configConfigrequired

entry_idIdrequired

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

Body

challenge_cookie_domainChallenge's Cookie Domainrequired

The domain for a challenge's cookie.

descriptionDescription

idIdrequired

Unique id

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

mobile_sdkMobile SDK Settings

ID of Mobile SDK used for site.

nameNamerequired

site name

proxy_templateProxy Templaterequired

ID of Proxy template used for site.

routing_profileRouting profilerequired

ID of Routing profile used for site.

security_policySecurity Policyrequired

ID of security policy applied on site.

ssl_certificateSSL Certificate

ID of SSL certificate attached to site.

server_namesServer Namesrequired

host names corresponding to the site.

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 '{"challenge_cookie_domain":"text","description":"","id":"text","name":"text","proxy_template":"text","routing_profile":"text","security_policy":"text","server_names":[null]}'

201

400

422

500

{
  "message": "Successfully created entry"
}

Server Group created successfully

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

configConfigrequired

entry_idIdrequired

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