Link11 WAAP
v5
v5
  • Link11 WAAP Documentation
  • Release Notes
  • Known Issues
  • User Guide
    • Introduction to Link11 WAAP
  • How Link11 WAAP Works
    • Traffic Filtering Process
    • Traffic Reporting and Analytics
    • Policy Mapping and Traffic Routing
    • Tagging
    • UI Overview and Common Elements
  • Console UI Walkthrough
    • Analytics
      • Dashboard
      • Events Log
    • Security
      • Global Filters
      • Flow Control Policies
      • Security Policies
      • Rate Limit Rules
      • ACL Profiles
      • Actions
      • Dynamic Rules
      • Quarantined
      • Content Filter
        • Content Filter Profiles
        • Content Filter Rules
    • Sites
      • Server Groups
      • Proxy Templates
      • Mobile Application Groups
      • Backend Services
      • Edge Functions
      • DNS Records
      • SSL
        • Load Balancers
        • Certificates
    • System
      • Interactive Challenge
      • SSO Configuration
      • Purge CDN Cache
      • Users Management
      • Security Alerts
      • Log Exporters
      • Version Control
      • System DB
      • Publish Changes
    • Account
  • Using the product
    • Best Practices
      • Saving and Publishing Your Changes
      • Enabling Passive Challenges
      • Understanding and Diagnosing Traffic Issues
    • How Do I...
      • Authenticate mobile app users
      • Ban, unban, and allowlist traffic sources
      • Bypass Link11 WAAP for loadtesting or other purposes
      • Configure a new path/section of a site
      • Control caching behavior
      • Enable GraphQL traffic
      • Enable mTLS (mutual TLS)
      • Protect sensitive information in logs and analytics
      • Quickly block an attacker
      • Redirect or block HTTP traffic
      • Run custom code
      • Set rate limits and exemptions
      • Stream event data to a SIEM solution or other destination
    • The Link11 WAAP API
      • Overview
      • Internal data structures
      • Using Swagger UI
      • Using curl
  • Reference Information
    • Acronyms
    • API
      • API access to traffic data
      • Types of namespaces
      • Namespace reference
        • ACL Profiles
        • Actions
        • Backend Services
        • Certificates
        • Configs
        • Content Filter Profiles
        • Content Filter Rules
        • Data queries
        • Dynamic Rules
        • Edge Functions
        • Flow Control Policies
        • Global Filters
        • Load Balancers
        • Log Exporters
        • Mobile Application Groups
        • Planets
        • Proxy Templates
        • Rate Limit Rules
        • Security Alerts
        • Security Policies
        • Server Groups
        • Tags
        • Tools
        • Users
    • Hostile Bot Detection / LWCSI
      • Environmental detection and browser verification
      • Client authentication
      • Biometric behavioral verification
    • HTTP Response Codes
    • Log Exporter Output
    • Pattern Matching Syntax
    • Query Filter Syntax and Best Practices
  • Support
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Reference Information
  2. API
  3. Namespace reference

Server Groups

PreviousSecurity PoliciesNextTags

Last updated 2 months 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
200
Server Groups retrieved successfully
application/json
400
Bad Request
application/json
500
Internal Server Error
application/json
get
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 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
400
Bad Request
application/json
422
Validation Error
application/json
500
Internal Server Error
application/json
get
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"
}

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
400
Input Error
application/json
422
Validation Error
application/json
500
Internal Server Error
application/json
delete
DELETE /api/v4.0/conf/{config}/server-groups/{entry_id} HTTP/1.1
Host: 
Accept: */*
{
  "message": "Successfully deleted entry"
}
  • GETGet all Server Groups (sites/domains)
  • GETGet a specific Server Group (a specific site/domain)
  • PUTModify Server Group (a site/domain)
  • POSTCreate Server Group (a site/domain)
  • DELETEDelete a Server Group (a site/domain)

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: onPossible values:
Responses
200
Server Group updated successfully
application/json
400
Input Error
application/json
422
Validation Error
application/json
500
Internal Server Error
application/json
put
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 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: onPossible values:
Responses
201
Server Group created successfully
application/json
400
Bad Request
application/json
422
Validation Error
application/json
500
Internal Server Error
application/json
post
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"
}