Webscale Networks Applications API
An application configures the Webscale service for a group of relatedwebsites.
Webscale Networks Applications API is one of 25 APIs that Webscale Networks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Application. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and authentication docs.
This API exposes 9 operations across 6 paths, and defines 138 schemas. It is described by OpenAPI 3.2.0, at version 2026.273.
Requests are made against a single base URL, https://api.webscale.com/v2.
9 operations
6 paths
138 schemas
1 DELETE6 GET1 PATCH1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Webscale Networks Applications API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (access_key).
By default, every request must be authenticated.
access_key— An access key secret must be sent as a [bearer token](https://www.rfc-editor.org/rfc/rfc7235section-5.1) with each HTTP request in an Authorization header. Tok…
Paths & Operations 9
Across 6 paths, the API surfaces 9 operations — 1 DELETE, 6 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Applications 9
An application configures the Webscale service for a group of related websites.
GET
/applications
Read application collection
POST
/applications
Create an application
GET
/applications/{id}
Read an application
PATCH
/applications/{id}
Update an application
DELETE
/applications/{id}
Delete an application
GET
/applications/metrics
Read application collection metrics
GET
/applications/{id}/metrics
Read application metrics
GET
/applications/{app_id}/webcontrols
Read web controls
GET
/applications/{app_id}/webcontrols/{id}
Read a web control
Schemas 138
The contract defines 138 schemas that model the data the API accepts and returns. The most detailed are ApplicationConfiguration (45 properties), Task (12 properties), TlsConfiguration (9 properties), PageControlActionUseAlternateBackends (8 properties). Each schema is shown below with its type and property counts.
ConditionReferrerMatches
object
True for a request for which request referrer matches a referrer pattern from a list
3 properties
2 required
ConditionReferrerDoesNotMatch
object
True for a request for which request referrer does not match any referrer pattern from a list
3 properties
2 required
ConditionRandom
object
True if a value from a uniform random variable from 0.0 to 1.0 is less than or equal to the specified probability.
2 properties
2 required
ConditionUrls
array
Array of url objects
SecretHref
string
The endpoint for the secret resource.
PageControlActionDisableSessionTracking
object
Disable Webscale session tracking. No session-tracking cookies will be added to responses.
1 property
1 required
CdnOriginRequest
object
6 properties
3 required
ConditionMatchesFilter
object
True if a request matches the given filter. The matches filter condition supports filtering on query parameters in the URL, and JSON and formdata in the reques…
3 properties
3 required
ConditionHeaderValueMatches
object
Test to check if the header value matches the specified pattern. Header value pattern must be a regular expression.
4 properties
3 required
ConditionAddressIsNotThreat
object
True if the requester's IP address is not a known malicious source.
1 property
1 required
ApplicationPatch
AddressWithPort
string
IP address with port number(optional).
PageControlActionSetPagespeedOptions
object
Provides options for the pagespeed integration
4 properties
1 required
AddressSetHref
string
The endpoint for an address set resource
Component
object
2 properties
PageControlActionDiscontinue
object
Discontinue execution of traffic controls. Final action that can be used to finalize a set of non-final actions
1 property
1 required
Label
string
A custom label starting with a lowercase letter following by numbers and lowercase letters. Dashes and underscores are accepted if they are followed by lowerca…
ConcurrentLimit
integer
Maximum number of concurrently active requests that can be run in a load balancer before requests are put in the suspend queue. This attribute may only be set…
Asn
string
An Autonomous System Number (ASN) as a decimal string.
AccountState
object
1 property
ConditionCountryIsNot
object
True if the country of origin of a request is not in the specified list.
2 properties
2 required
ClusterHref
stringnull
The endpoint for the cluster resource.
Application
object
An application configuration and its state.
ConditionHeadersMatch
object
Test to check if the list of named header values match their respective specified patterns.
3 properties
2 required
ConditionAddressIsNotWhitelisted
object
True if the requester's IP address is not on the application whitelist.
1 property
1 required
ApplicationPost
object
2 required
ApplicationInitializer
object
2 properties
ConditionUrlMatches
object
True for a request URL that matches a URL pattern from a list.
3 properties
2 required
PageControlActionRedirectUsingMap
object
Redirect the request using a url map. If the request URL is found in the url map and a redirect occurs, then this is a final action
5 properties
4 required
PageControlActionAddIPToList
object
Add IP address of the request to address set
3 properties
2 required
ConditionRateLimit
object
True when the number of request during a duration is greater than a specified threshold.
5 properties
3 required
AccountIdentity
object
2 properties
2 required
Substitute
object
2 properties
2 required
ConditionIsCrawler
object
True if the requester's IP address is a known Web Crawler.
1 property
1 required
TlsConfiguration
object
9 properties
TranslatePath
string
Configuration to specify the handling of URL paths through the Webscale proxy. The default behavior is to leave the path value untouched (preserve). A value of…
AccountHref
string
A reference to an account
MethodName
string
Name of different HTTP methods.
MergeSlashes
boolean
Controls whether the server merges consecutive slashes in URLs. By default, consecutive slashes are merged into a single slash.
WebControlConfiguration
object
Configuration for a web control
6 properties
2 required
SuspendLimit
integer
Maximum number of requests that can be put in the suspend queue of a load balancer before the oldest requests are failed. This attribute may only be set by sys…
PageControlActionSubstitute
object
Substitute a string with an alternate string.
2 properties
2 required
ConditionAuthCookieIsSet
object
True when a specified authorization cookie is set and not expired.
2 properties
2 required
CacheTagConfiguration
object
The configuration to populate cache tags.
2 properties
2 required
MetricValues
array
An array of metric values, one per resolution period
ConditionAddressIsThreat
object
True if the requester's IP address is a known malicious source.
1 property
1 required
ConditionHeader
object
2 properties
2 required
PageControlActionUseServerlessFunction
object
Allows the user to invoke serverless function
2 properties
1 required
PageControlActionServeCaptchaChallenge
object
Issue a reCaptcha challenge to the user for all incoming requests unless the user has successfully completed a validation before.
1 property
1 required
PageControlActionInjectHtml
object
Inject HTML from a specified microsite file into a response document before the close of the head tag whenever the content type is text/html.
3 properties
3 required
ConditionUrl
object
A wildcard or regular expression url definition used for triggering page controls on requests.
NonNegativeInteger
integer
An integer of value 0 or more.
PageControlActionDisableRum
object
Disable real user monitoring when RUM is enabled for the application. No beacon script for collecting RUM metrics will be injected into html responses.
1 property
1 required
PageControlActionCacheOverrides
object
Update the cache-related headers of responses from backend servers.
2 properties
2 required
Account
object
AccountLogRetention
object
5 properties
1 required
ConditionAddressIsWhitelisted
object
True if the requester's IP address is on the application whitelist.
1 property
1 required
SearchResult
object
Results of a search task
1 property
FileHref
string
Endpoint resource reference to a file.
CdnConfiguration
object
Configuration for the CDN of an application.
2 properties
1 required
SiteCacheRule
object
A rule for caching requests. All of the conditions for the rule must evaluate to true in order for the rule to be used.
5 properties
3 required
ApplicationLogRetention
object
5 properties
1 required
HandlerHref
string
A reference to the handler.
WebControlIdentity
object
Identifier for a web control
1 property
Task
object
12 properties
ConditionMethodIs
object
True if the method name of a request is included in the specified list.
2 properties
2 required
ApplicationServer
object
ApplicationState
object
6 properties
3 required
PageControlActionAddLabels
object
Add custom labels to processed traffic. This is a non-final action.
2 properties
2 required
PageControlActionRewriteUrl
object
Rewrite the incoming request URL prior to serving it. The rewrite is designed to rewrite the URL path and the query parameters. If the URL scheme or the hostna…
2 properties
2 required
PageControlActionSetRequestTimeout
object
Set timeout for a request
2 properties
2 required
MaximumQueueTime
integer
Maximum amount of time a request can spend in the suspend queue of a load balancer before it is failed with a timeout. This attribute may only be set by system…
ConditionReferrerIsNotDefined
object
True for a request for which request referrer hostname does not match a hostname for this application.
1 property
1 required
TlsVersion
string
Names of the versions of Transport Layer Security (TLS)
Metrics
object
Metrics for the given specifications.
4 properties
4 required
ApplicationIdentifier
object
1 property
SiteCacheCondition
A condition used to match requests for Dynamic Site Cache
ConditionUrlDoesNotMatch
object
True for a request URL that does not match any URL pattern from a list.
3 properties
2 required
ConditionHeaderValueDoesNotMatch
object
Test to check if the header value does not match the specified pattern. If the specified header does not exist, this condition will evaluate to true. Header va…
4 properties
3 required
PageControlActionServe
object
Serve the microsite resource specified by a relative path with a specified status code. If the resource does not exist in the application's microsite, then the…
4 properties
3 required
Timestamp
string
An iso8601 formatted timestamp
ConditionAsnIs
object
True if the ASN of a request is included in the specified list.
2 properties
2 required
AccountConfiguration
object
4 properties
ConditionHeadersNotMatch
object
Test to check if the list of named header values does not match their respective specified patterns.
3 properties
2 required
Server
object
1 property
1 required
ConditionStatusCodeMatches
object
True if the response code matches the pattern.
2 properties
2 required
PageControlActionUseAlternateBackends
object
Use different servers than the default for matching requests. Final action
8 properties
1 required
ConditionUserAgentDoesNotMatch
object
True for a request user-agent that does not match a specified regular expression
3 properties
2 required
CountryCodes
array
A list of country codes
CoveredAlias
object
Certificate information for covered alias
3 properties
CdnCacheKey
object
Specifies which headers, cookies, and query parameters are used as a key for cache entries. A request that has a cache key value shared by a request for which…
6 properties
3 required
Substitutes
array
Array of substitutes
ServicesHref
string
The endpoint for a resource accessible via services available for this account.
ConditionAddressInSet
object
Tests if requester's IP address is in the specified address set.
2 properties
2 required
PageControlActionUserHasRole
object
Limit access to accounts and applications to users belonging to the given role.
2 properties
2 required
CdnControl
object
7 properties
2 required
Hostname
string
PageControlActionRedirect
object
Redirect the request. Final action
3 properties
3 required
PageControlActionRouteForVerification
object
Causes any request that would be processed by a subsequent use-alternate-backends that specifies a cluster to be routed to deployment in verifying state if it…
1 property
1 required
ConditionCountryIs
object
True if the country of origin of a request is included in the specified list.
2 properties
2 required
DurationDisplayUnit
string
Unit to use for displaying the time duration specified.
PageControlActionSetCookie
object
Set a response cookie.
5 properties
3 required
MultiMetrics
array
An Array of metrics for multiple objects
PageControlActionTerminateHttps
object
Use HTTP instead of HTTPS to communicate with backend servers regardless of the request protocol. This only applies to a use-alternate-backends action that is…
1 property
1 required
PageControlAction
An array of actions to enact on the triggering of a page control.
PageControlActionDeny
object
Deny the request with the given status code. Final action
3 properties
3 required
ConditionReferrerIsDefined
object
True for a request for which request referrer hostname matches a hostname for this application
1 property
1 required
WebControlCondition
The condition that cause a web control to trigger
ConditionMethodIsNot
object
True if the method name of a request is not included in the specified list.
2 properties
2 required
MethodNames
array
A list of method names.
ConditionCookieValueDoesNotMatch
object
Test to check if the named cookie value does not match the specified pattern. If the specified cookie does not exist, this condition will evaluate to true. Coo…
4 properties
3 required
PageControlActionDrop
object
Drop the request. Final action
1 property
1 required
PositiveInteger
integer
An integer of value 1 or more.
MetricConfiguration
object
3 properties
1 required
ConditionCookieValueMatches
object
Test to check if the named cookie value matches the specified pattern. Cookie value pattern must be a regular expression.
4 properties
3 required
CacheKeyConfiguration
object
The request attributes used to construct the cache key for requests matching this rule. Note that the request path is always included in the cache key construc…
5 properties
MetricSummary
number
A summary value of a metric across the entire returned time range
ConditionAuthCookieIsNotSet
object
True when a specified authorization cookie is not set or is expired.
2 properties
2 required
CountryCode
string
Two letter country code defined as per the ISO 3166-1 standard.
PageControlActionSetRequestHeader
object
Set a request header before a request is sent to a backend server.
3 properties
3 required
ConditionAsnIsNot
object
True if the ASN of a request is not in the specified list.
2 properties
2 required
ConditionCookieIsNotSet
object
True if a named cookie is not set.
3 properties
2 required
SiteCache
object
A configuration for Dynamic Site Cache
2 properties
2 required
PageControlActionSetResponseHeader
object
Set a response header before a response is returned to a web browser.
3 properties
3 required
PagespeedFilterName
string
ConditionUserAgentMatches
object
True for a request user-agent that matches a specified regular expression
3 properties
2 required
ReferrerPatterns
array
A list of referrer wildcard patterns
CdnControlPath
string
A pattern that is matched to a request path to determine if the control is used for a request. A pattern can contain wildcards that match zero or more characte…
WebControlState
object
4 properties
PageControlActionSetContentSecurityPolicy
object
Set a content security policy.
2 properties
2 required
ConditionCookieIsSet
object
True to see if a named cookie is set.
3 properties
2 required
ConditionHeaders
array
Array of headers conditions
PageControlActionSetAuthCookie
object
Set or extend an authorization cookie. The cookie is valid for a specified duration and a domain and path if specified
5 properties
3 required
WebControl
Conditionally applies a set of actions to a request based on triggering conditions that are evaluated over request attributes.
PageControlActionContinue
object
Continue execution of traffic controls. Non final action
1 property
1 required
ApplicationConfiguration
object
45 properties
ConditionAddressNotInSet
object
Tests if requester's IP address is not in the specified address set
2 properties
1 required
Monitoring
string
The monitoring mode. When active, the application will be monitored regularly from a separate location, in addition to passive monitoring. When passive, the er…
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Webscale Networks 12
Other APIs Webscale Networks publishes across the network.
Webscale Networks Accounts API
Webscale Networks Address sets API
Webscale Networks Application test API
Webscale Networks Builders API
Webscale Networks Clusters API
Webscale Networks Environments API
Webscale Networks Files API
Webscale Networks Groups API
Webscale Networks Labelers API
Webscale Networks Log schemas API
Webscale Networks Logs API
Webscale Networks Metrics API
#Application
Where this information came from
This is an independent, third-party profile of Webscale Networks Applications API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.