Webscale APIs
The Webscale v2 control-plane REST API. 151 operations across 25 resource collections — applications and web controls, address sets, URL maps, clusters, environments and stacks, servers, builders, monitors, metric prototypes, application and SSH logs, archived logs, files and file versions, secrets, tasks, templates, accounts, groups, roles, invitations, users, service users, SSH hosts and access keys. JSON over HTTPS with GET/POST/PATCH/DELETE semantics, href-addressable resources, an EBNF filter expression language, and offset pagination.
This API exposes 151 operations across 157 paths, organized into 25 resource areas, and defines 530 schemas. It is described by OpenAPI 3.0.3, at version 2026.273.
Requests are made against a single base URL, https://api.webscale.com/v2.
151 operations
157 paths
530 schemas
28 DELETE77 GET21 PATCH25 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Webscale APIs 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 151
Across 157 paths, the API surfaces 151 operations — 28 DELETE, 77 GET, 21 PATCH, 25 POST. They span 25 resource areas, including Accounts, Groups, Roles, Service users, Address sets, Application test, Applications, Logs, and 17 more. Each is listed below with its method, path, parameters, and response codes.
Accounts 5
GET
/accounts
Read account collection
POST
/accounts
Create an account
GET
/accounts/{id}
Read an account
PATCH
/accounts/{id}
Update an account
DELETE
/accounts/{id}
Delete an account
Groups 10
GET
/accounts/{id}/group-invitations
Read group invitation collection
POST
/accounts/{id}/group-invitations
Create a group invitation
GET
/accounts/{id}/group-invitations/{invitation_id}
Read a group invitation
PATCH
/accounts/{id}/group-invitations/{invitation_id}
Update a group invitation
DELETE
/accounts/{id}/group-invitations/{invitation_id}
Delete a group invitation
GET
/accounts/{id}/groups
Read groups collection
POST
/accounts/{id}/groups
Create a group
GET
/accounts/{id}/groups/{group_id}
Read a group
PATCH
/accounts/{id}/groups/{group_id}
Update a group
DELETE
/accounts/{id}/groups/{group_id}
Delete a group
Roles 10
GET
/accounts/{id}/roles
Read role collection
POST
/accounts/{id}/roles
Create a role
GET
/accounts/{id}/roles/{role_id}
Read a role
PATCH
/accounts/{id}/roles/{role_id}
Update a role
DELETE
/accounts/{id}/roles/{role_id}
Delete a role
GET
/accounts/{id}/invitations
Read invitation collection
POST
/accounts/{id}/invitations
Create an invitation
GET
/accounts/{id}/invitations/{invitation_id}
Read an invitation
PATCH
/accounts/{id}/invitations/{invitation_id}
Update an invitation
DELETE
/accounts/{id}/invitations/{invitation_id}
Delete an invitation
Service users 5
GET
/accounts/{id}/service-users
Read service user collection
POST
/accounts/{id}/service-users
Create a service user
GET
/accounts/{account_id}/service-users/{id}
Read a service user
PATCH
/accounts/{account_id}/service-users/{id}
Update a service user
DELETE
/accounts/{account_id}/service-users/{id}
Delete a service user
Address sets 8
GET
/address-sets
Read address set collection
POST
/address-sets
Create an address set
GET
/address-sets/{id}
Read an address set
PATCH
/address-sets/{id}
Update an address set
DELETE
/address-sets/{id}
Delete an address set
GET
/address-sets/{id}/addresses
Read addresses for an address set
GET
/address-sets/metrics
Read address set collection metrics
GET
/address-sets/{id}/metrics
Read address set metrics
Application test 1
DELETE
/tests/{id}
Delete a test configuration
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
Logs 5
GET
/applications/{id}/logs
Read application logs
POST
/applications/{id}/logs
Create application logs
GET
/archived-logs
List log status
GET
/archived-logs/{ref}
Download archived logs
DELETE
/archived-logs/{ref}
Delete archived logs
Builders 5
GET
/builders
Read builder collection
POST
/builders
Create a builder
GET
/builders/{id}
Read a builder
PATCH
/builders/{id}
Update a builder
DELETE
/builders/{id}
Delete a builder
Clusters 7
GET
/clusters
Read cluster collection
POST
/clusters
Create a cluster
GET
/clusters/{id}
Read a cluster
PATCH
/clusters/{id}
Update a cluster
DELETE
/clusters/{id}
Delete a cluster
GET
/clusters/{id}/metrics
Read cluster metrics
GET
/clusters/metrics
Read cluster collection metrics
Environments 10
GET
/environments
Read environments collection
POST
/environments
Create an environment
GET
/environments/{id}
Read an environment
PATCH
/environments/{id}
Update an environment
DELETE
/environments/{id}
Delete an environment
GET
/stacks
Read stack collection
POST
/stacks
Create a stack
GET
/stacks/{id}
Read a stack
PATCH
/stacks/{id}
Update a stack
DELETE
/stacks/{id}
Delete a stack
Files 11
GET
/files
Get all files
POST
/files
Create a file.
GET
/files/{id}
Get a file
PATCH
/files/{id}
Update a file
DELETE
/files/{id}
Delete a file
GET
/files/{id}/contents
Get a file contents
GET
/files/{id}/contents/{path}
Get contents of a file within a package
GET
/files/{id}/details
Gets all details.
GET
/files/{id}/versions/{version_id}
Gets properties of a particular version of a file.
GET
/files/{id}/versions/{version_id}/contents
Get contents of a file version
GET
/files/{id}/versions/{version_id}/contents/{path}
Get contents of a file version within a package.
Labelers 1
DELETE
/labelers/{id}
Delete a labeler
Log schemas 1
GET
/log-schemas
Read log schemas
Metrics 4
GET
/metric-prototypes
Read metric prototypes
POST
/metric-prototypes
Create a metric prototype
GET
/metric-prototypes/{id}
Read a metric prototype
DELETE
/metric-prototypes/{id}
Delete a metric prototype
Monitors 6
GET
/monitors
Read monitors collection
POST
/monitors
Create a monitor
GET
/monitors/{id}
Read a monitor
PATCH
/monitors/{id}
Update a monitor
DELETE
/monitors/{id}
Delete a monitor
DELETE
/resources/{id}
Delete a resource
Reports 1
GET
/reports/{report_id}/sections/{section_id}
Read a test report section
Secrets 4
GET
/secrets
Read secret collection
POST
/secrets
Create a secret
GET
/secrets/{id}
Read a secret
DELETE
/secrets/{id}
Delete a secret
Servers 3
GET
/servers
Read server collection
DELETE
/servers/{id}
Delete a server
POST
/servers/{id}/metrics
Create server metrics
SSH Hosts 6
GET
/ssh-hosts
Read SSH host collection
POST
/ssh-hosts
Create SSH host
GET
/ssh-hosts/{id}
Read SSH host
PATCH
/ssh-hosts/{id}
Update SSH Host
DELETE
/ssh-hosts/{id}
Delete SSH host
GET
/ssh-hosts/{id}/logs
Read SSH logs
Tasks 4
GET
/tasks
Read task collection
POST
/tasks
Create a task
GET
/tasks/{id}
Read a task
GET
/tasks/{id}/logs
Read task logs
Templates 5
GET
/templates
Read template collection
POST
/templates
Create a template
GET
/templates/{id}
Read a template
PATCH
/templates/{id}
Update a template
DELETE
/templates/{id}
Delete a template
URL maps 5
GET
/url-maps
Read URL map collection
POST
/url-maps
Create a URL map
GET
/url-maps/{id}
Read a URL map
PATCH
/url-maps/{id}
Update a URL map
DELETE
/url-maps/{id}
Delete a URL map
Users 20
GET
/users
Read user collection
GET
/users/{id}
Read a user
PATCH
/users/{id}
Update a user
GET
/users/{id}/access-keys
Read access keys collection
POST
/users/{id}/access-keys
Create an access key
DELETE
/users/{user_id}/access-keys/{id}
Delete an access key
GET
/users/{id}/authorization
Read authorization
POST
/users/{id}/authorization
Create authorization
GET
/users/{id}/group-invitations
Read group invitations
GET
/users/{id}/group-invitations/{group-invitation-id}
Read a group invitation
PATCH
/users/{id}/group-invitations/{group-invitation-id}
Update a group invitation
GET
/users/{id}/groups
Read user group collection
GET
/users/{id}/groups/{group_id}
Read group membership
DELETE
/users/{id}/groups/{group_id}
Delete group membership
GET
/users/{id}/invitations
Read role invitations
GET
/users/{id}/invitations/{invitation_id}
Read a role invitation
PATCH
/users/{id}/invitations/{invitation_id}
Update a role invitation
GET
/users/{id}/roles
Read role membership collection
GET
/users/{id}/roles/{role_id}
Read role membership
DELETE
/users/{id}/roles/{role_id}
Delete role membership
SSH Public Keys 5
GET
/users/{id}/ssh-public-keys
Read SSH public key collection
POST
/users/{id}/ssh-public-keys
Create an SSH public key
GET
/users/{id}/ssh-public-keys/{key_id}
Read an SSH public key
PATCH
/users/{id}/ssh-public-keys/{key_id}
Update an SSH public key
DELETE
/users/{id}/ssh-public-keys/{key_id}
Delete an SSH public key
Schemas 530
The contract defines 530 schemas that model the data the API accepts and returns. The most detailed are ApplicationConfiguration (45 properties), PlanAttributes (40 properties), PageControlConditions (34 properties), ClusterConfiguration (27 properties). Each schema is shown below with its type and property counts.
AccessKey
A key that is used to authorize access to the Webscale API
AccessKeyConfiguration
object
An authorization granted to a user
3 properties
1 required
AccessKeySecret
AccessKeyState
object
3 properties
Account
object
AccountConfiguration
object
4 properties
AccountHref
string
A reference to an account
AccountIdentity
object
2 properties
2 required
AccountLogRetention
object
5 properties
1 required
AccountPatch
object
Specifies attributes of an account to be updated.
AccountPost
object
Specifies attributes of an account to be posted.
AccountState
object
1 property
Action
object
An action to be executed on a referenced subject
ActionConfiguration
object
Configuration for an action
6 properties
ActionKey
object
1 property
Actions
array
An array of actions
AddressSet
object
An address set record details
Address
string
IP address
AddressWithPort
string
IP address with port number(optional).
AddressSetConfiguration
object
An address set record details
6 properties
AddressSetDomainsParameters
object
Parameters for domains address set type
1 property
1 required
AddressSetEntry
object
An IP address or a CIDR block
AddressSetEntryConfiguration
object
Configuration for address entries for address sets
3 properties
1 required
AddressSetEntryState
object
State values for address entries for address sets
2 properties
AddressSetHref
string
The endpoint for an address set resource
AddressSetJsonFileParameters
object
Parameters for json-file address set type
3 properties
3 required
AddressSetParameters
Parameters for configuring an address set
AddressSetPatch
object
An address set record details to update
AddressSetPost
object
An address set record details needed to create a new set
AddressSetState
object
4 properties
3 required
AddressSetTextFileParameters
object
Parameters for text-file address set type
2 properties
2 required
AnyObject
object
Any JSON object.
ApplicationLogRetention
object
5 properties
1 required
ApplicationProxy
object
7 properties
1 required
ApplicationTest
An Application Test contains test information
ApplicationTestingInitializer
object
ID for an application test
1 property
ApplicationTestingIdentity
object
Identifier for an application test
1 property
ApplicationTestPost
object
The fields required to run the test
5 properties
4 required
ApplicationTestState
object
State for an application test
2 properties
ApplicationTestConfiguration
object
ID for an application test
2 properties
MainApplicationTestConfiguration
object
Json configuration for main application test file.
4 properties
2 required
ApplicationTestUser
object
User credentials for requests
3 properties
2 required
ApplicationTestParameters
object
User configured parameter.
3 properties
3 required
SessionTypeConfiguration
object
Single session for application-test
6 properties
2 required
ApplicationTestRequest
object
Describes a single request in a session
11 properties
3 required
ApplicationTestCookie
object
Cookie to be used in request
4 properties
2 required
ApplicationTestInjections
object
Injections allow injecting data from previous responses into the next outgoing request
4 properties
2 required
ApplicationTestScrape
object
Scrapes allow scraping data from a response so it can be injected into later requests
5 properties
4 required
ApplicationTestTransform
object
Transform
2 properties
1 required
Application
object
An application configuration and its state.
ApplicationCheckResult
object
The result of running a check for an application
3 properties
ApplicationComponent
object
A logical component of the application
5 properties
ApplicationComponentMessage
object
A message for an application component
2 properties
ApplicationConfiguration
object
45 properties
ApplicationHref
string
The endpoint for the application resource.
ApplicationIdentifier
object
1 property
ApplicationInitializer
object
2 properties
ApplicationLog
object
4 properties
4 required
ApplicationMonitorParameters
object
The configuration of an application monitor
1 property
ApplicationPatch
ApplicationPost
object
2 required
ApplicationPost_logs
ApplicationPost_subscriptions
object
ApplicationPut_subscriptions
array
An array of subscription configurations. At least one plan must be a primary plan.
ApplicationProbeResult
object
The results of an individual server probe.
5 properties
ApplicationServer
object
ApplicationState
object
6 properties
3 required
ApplicationStatus
array
The checks that were run in querying status for an application
ArchivedLog
object
Archived log information
2 properties
2 required
ArchivedLogs
array
The available archived logs.
Asn
string
An Autonomous System Number (ASN) as a decimal string.
AuthorizationAccount
object
The account for which an authorization is to be created
1 property
1 required
Billing
object
Billing information for an account.
2 properties
2 required
BillingService
object
2 properties
2 required
Blacklist
array
A list of addresses for which access is restricted.
BlacklistItem
object
3 properties
2 required
BlacklistItemPut
object
2 properties
1 required
Blueprint
object
The endpoint resource reference to the blueprint of the servers.
22 properties
BlueprintLogsApplication
object
The application logs config object to specify which cluster logs are sent to custom logs.
2 properties
2 required
BlueprintLogStream
object
A log stream configuration for use with Webscale Monitoring Agent.
5 properties
2 required
BlueprintLogStreamFilePath
string
An absolute file path to collect logs from. Can have a wildcard match with an asterisk for the file name but not directory name.
BootstrapConfiguration
object
2 properties
2 required
BotManagement
object
1 property
1 required
Builder
object
BuilderConfiguration
object
Universally configurable attributes for a builder object.
15 properties
BuilderFileEntry
object
A file to include in the build context and where it should be placed within the context.
3 properties
2 required
BuilderEnvironmentVariable
object
A key/value pair representing an environment variable to set in the build context.
2 properties
2 required
BuilderIdentity
object
1 property
BuilderInitializer
object
1 property
BuilderPatch
BuilderPost
object
A Docker builder creates a Docker image from it and then pushes the image to an AWS ECR registry.
4 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
CacheTagConfiguration
object
The configuration to populate cache tags.
2 properties
2 required
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
CdnConfiguration
object
Configuration for the CDN of an application.
2 properties
1 required
CdnControl
object
7 properties
2 required
CdnControlAssociation
object
The application and CDN control paths with which the handler is associated.
2 properties
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…
CdnOriginRequest
object
6 properties
3 required
Challenge
object
A challenge verifying ownership of an application alias. An application cannot be started until all it's challenges have been verified. The Tasks api is used t…
4 properties
2 required
Check
object
10 properties
1 required
Cidr
string
A ip address or range.
Cluster
object
A cluster configures and manages a set of service deployments that perform some service on behalf of an application. Initially, clusters were created to manage…
ClusterAccess
object
Describes a method for accessing a service deployment.
1 property
1 required
ClusterConfiguration
object
27 properties
ClusterDns
object
2 properties
2 required
ClusterHref
string
The endpoint for the cluster resource.
ClusterPatch
object
ClusterPost
object
ClusterServer
object
ClusterState
object
6 properties
4 required
Component
object
2 properties
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…
ConditionAddressIsNotThreat
object
True if the requester's IP address is not a known malicious source.
1 property
1 required
ConditionAddressIsNotWhitelisted
object
True if the requester's IP address is not on the application whitelist.
1 property
1 required
ConditionAddressInSet
object
Tests if requester's IP address is in the specified address set.
2 properties
2 required
ConditionAddressIsThreat
object
True if the requester's IP address is a known malicious source.
1 property
1 required
ConditionAddressIsWhitelisted
object
True if the requester's IP address is on the application whitelist.
1 property
1 required
ConditionAddressNotInSet
object
Tests if requester's IP address is not in the specified address set
2 properties
1 required
ConditionAsnIs
object
True if the ASN of a request is included in the specified list.
2 properties
2 required
ConditionAsnIsNot
object
True if the ASN of a request is not in the specified list.
2 properties
2 required
ConditionAuthCookieIsNotSet
object
True when a specified authorization cookie is not set or is expired.
2 properties
2 required
ConditionAuthCookieIsSet
object
True when a specified authorization cookie is set and not expired.
2 properties
2 required
ConditionCookieIsNotSet
object
True if a named cookie is not set.
3 properties
2 required
ConditionCookieIsSet
object
True to see if a named cookie is set.
3 properties
2 required
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
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
ConditionHeader
object
2 properties
2 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
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
ConditionHeadersNotMatch
object
Test to check if the list of named header values does not match their respective specified patterns.
3 properties
2 required
ConditionHeadersMatch
object
Test to check if the list of named header values match their respective specified patterns.
3 properties
2 required
ConditionHeaders
array
Array of headers conditions
ConditionIsCrawler
object
True if the requester's IP address is a known Web Crawler.
1 property
1 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
ConditionMethodIs
object
True if the method name of a request is included in the specified list.
2 properties
2 required
ConditionMethodIsNot
object
True if the method name of a request is not included in the specified list.
2 properties
2 required
ConditionCountryIs
object
True if the country of origin of a request is included in the specified list.
2 properties
2 required
ConditionCountryIsNot
object
True if the country of origin of a request is not in the specified list.
2 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
ConditionRateLimit
object
True when the number of request during a duration is greater than a specified threshold.
5 properties
3 required
ConditionReferrerDoesNotMatch
object
True for a request for which request referrer does not match any referrer pattern from a list
3 properties
2 required
ConditionReferrerIsDefined
object
True for a request for which request referrer hostname matches a hostname for this application
1 property
1 required
ConditionReferrerIsNotDefined
object
True for a request for which request referrer hostname does not match a hostname for this application.
1 property
1 required
ConditionReferrerMatches
object
True for a request for which request referrer matches a referrer pattern from a list
3 properties
2 required
ConditionStatusCodeMatches
object
True if the response code matches the pattern.
2 properties
2 required
ConditionUrl
object
A wildcard or regular expression url definition used for triggering page controls on requests.
ConditionUrlDoesNotMatch
object
True for a request URL that does not match any URL pattern from a list.
3 properties
2 required
ConditionUrlMatches
object
True for a request URL that matches a URL pattern from a list.
3 properties
2 required
ConditionUrls
array
Array of url objects
ConditionUserAgentDoesNotMatch
object
True for a request user-agent that does not match a specified regular expression
3 properties
2 required
ConditionUserAgentMatches
object
True for a request user-agent that matches a specified regular expression
3 properties
2 required
ConnectRepositoryResult
object
Results of a connect repository task
1 property
TagName
string
Name of different tags.
CountryCode
string
Two letter country code defined as per the ISO 3166-1 standard.
CountryCodes
array
A list of country codes
CustomLogId
string
Unique ID for submitted log.
MethodName
string
Name of different HTTP methods.
MethodNames
array
A list of method names.
Currency
number
US currency.
DataPlane
A data plane acts as the proxy between application servers and its users.
DataPlaneConfiguration
object
The configurable attributes of a data plane
6 properties
DataPlaneIdentity
object
Identifier for a data plane.
1 property
DataPlaneState
object
State for a data plane
2 properties
DataTransferBillingMonitorParameters
object
The configuration of a data transfer billing monitor
2 properties
DataTransferBillingThreshold
object
2 properties
2 required
Date
string
An iso8601 formatted date.
DomainName
string
A domain name as specified by RFC1035, RFC1123, and RFC2181 with the exception that no space character or double quote (") can be part of the name
Duration
Duration in seconds, no fractional values.
DurationDisplayUnit
string
Unit to use for displaying the time duration specified.
Email
string
An email address
EmptyObject
object
Entitlement
A generic entitlement
EntitlementConfiguration
object
The configurable parts of an entitlement
2 properties
EntitlementPost
object
1 required
EntitlementPatch
object
1 required
EntitlementIdentity
object
Identifier for a entitlement
1 property
EntitlementState
object
The current state of an entitlement
1 property
EnumValue
object
An enumerated value.
2 properties
2 required
Environment
object
An environment is a collection of resources.
EnvironmentConfiguration
object
Universally configurable attributes for an environment object.
2 properties
EnvironmentIdentity
object
1 property
EnvironmentPatch
EnvironmentPost
object
Representation of new environment.
Error
object
2 properties
2 required
Event
object
9 properties
5 required
EventActionDetails
object
Event log details of type action
2 properties
1 required
EventConfigurationModel
EventCreateDetails
object
Event log details of type create
1 property
1 required
EventDeleteDetails
object
Event log details of type delete
1 property
1 required
EventMessage
string
Text that describes the occurrence of an event.
EventPost
object
7 properties
4 required
Events
array
EventSeverity
string
The severity of the event. There are three levels: info is informational and no action is needed, warning may indicate that an error will occur if action is no…
EventSubjectHref
string
The object that is affected by the event (e.g. A cluster scale out event for cluster w234fs will have a subject of /v2/cluster/w234fs).
EventTypeHref
string
The type of event that has occurred.
EventUpdateDetails
object
Event log details of type update
2 properties
2 required
Field
object
A log field.
6 properties
5 required
File
object
A file object
10 properties
FileArchiveDetails
object
Details for an archive file.
1 property
FileArchiveDirectory
object
Metadata for an archive file.
3 properties
FileConfiguration
object
The configurable attributes of a file.
6 properties
FileHref
string
Endpoint resource reference to a file.
FileVersionHref
string
Endpoint reference to a particular version of a file.
FileInitializer
object
File attributes that cannot be changed after creation.
1 property
FilePatch
object
Used to patch a file.
6 properties
FilePost
object
Used to create a new file
3 required
FileVersion
object
A file version object
6 properties
Filter
object
FilterConfiguration
object
4 properties
FilterIdentity
object
Identifier for a filter
1 property
FilterPatch
object
3 properties
FilterPost
object
Used to create a new filter
4 required
FirewallHref
string
Endpoint resource reference to the firewall rule.
GenericConfigurationModel
object
A generic configuration model object that is to be used when an object specific configuration model schema is not found.
Group
A collection of roles granted to users of an account
GroupConfiguration
object
The configurable parts of a group
3 properties
GroupConfigurationPost
object
1 required
GroupIdentity
object
Identifier for a group
1 property
GroupInvitation
An invitation to a group.
GroupInvitationConfiguration
object
The configurable parts of a group invitation
1 property
GroupInvitationIdentity
object
The identifier for a group invitation.
1 property
GroupInvitationInitializer
object
A group invitation invites a user to a particular group.
2 properties
GroupInvitationPost
object
2 required
GroupInvitationState
object
The current state of a group invitation
4 properties
GroupedRoleState
object
The current state of a group
2 properties
GroupState
object
The states of the distinct groups over which a monitor monitors. A monitor is triggering if any state is triggered.
5 properties
Handler
object
HandlerConfiguration
object
The configurable properties of a handler.
5 properties
HandlerHref
string
A reference to the handler.
HandlerIdentity
object
The properties used to uniquely identify a handler.
1 property
HandlerInitializer
object
Handler properties that are set once at creation.
2 properties
HandlerPost
object
Used to create a new handler.
5 required
HandlerState
object
The properties of a handler that are updated automatically as it modified.
4 properties
Header
object
2 properties
2 required
HostMeasurement
object
Measurements of resource usage for a particular interval
10 properties
2 required
HostMeasurementDisk
object
A measurement of a disk or partition.
5 properties
3 required
Hostname
string
HttpUrl
string
An HTTP URL address.
IdentityConfiguration
object
Configuration of the identity assigned to cluster servers.
3 properties
3 required
Incident
object
Represents a time-bounded condition, typically a failure of some system element or service
9 properties
IncidentHref
string
The identifier for the underlying incident that triggered the event.
InstanceFlavor
string
Specifies the type (size) of instances to be created.
InstanceTemplate
string
The endpoint resource identifier for the instance template.
InvoiceItem
object
3 properties
3 required
JsonPatch
array
An array of JSON patch operations as defined by RFC 6902
JsonPatchOperation
object
A JSON patch operation as defined by RFC 6902
4 properties
2 required
Labeler
object
LabelerConfiguration
object
6 properties
LabelerIdentity
object
Identifier for a labeler
1 property
LabelerPatch
object
LabelerPost
object
Used to create a new labeler
4 required
LogAddress
string
The address of the server that recorded the log.
LogMessage
string
The contents of the log.
LogPost
object
6 properties
6 required
LogSchema
object
A schema describing a particular log.
5 properties
5 required
LogFilename
string
The file where the log was written.
LogHostname
string
The hostname of the machine running the Webscale Monitoring Agent.
LogStream
string
The custom defined category to associate the log with.
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…
MergeSlashes
boolean
Controls whether the server merges consecutive slashes in URLs. By default, consecutive slashes are merged into a single slash.
MetadataEntry
object
A key/value pair to be made available on servers made with this metadata.
2 properties
MetadataFileEntry
object
A file to be created on newly created servers.
3 properties
MetricConfiguration
object
3 properties
1 required
MetricPrototype
A metric prototype that can be used to configure a custom metric
MetricPrototypeConfiguration
object
The configurable attributes of a metric prototype
8 properties
MetricPrototypeIdentity
object
Identifier for a metric prototype
1 property
MetricPrototypePost
object
MetricPrototypeState
object
State values for metric prototype
2 properties
Metrics
object
Metrics for the given specifications.
4 properties
4 required
MetricsMonitorParameters
object
Configuration of a metrics monitor
3 properties
3 required
MultiMetrics
array
An Array of metrics for multiple objects
MetricValues
array
An array of metric values, one per resolution period
MetricSummary
number
A summary value of a metric across the entire returned time range
MicrositeArchiveDetails
object
Details for a microsite archive file
1 property
MicrositeFile
object
A file object
5 properties
MicrositeFileDetails
object
Metadata for a microsite file
3 properties
MonitorPost
object
4 required
Monitor
A generic monitor for monitoring applications, clusters, and other account-level resources and automatically creating and sending notifications
MonitorAction
An action to be executed when the monitor triggers.
MonitorActionEnableShieldMode
object
Enables shield mode for the monitored application(s).
1 property
1 required
MonitorActionLogEvents
object
Publishes monitor activity to the event log.
1 property
1 required
MonitorActionNotify
object
Sends monitor notifications to configured recipients.
3 properties
3 required
MonitorActionReplaceServer
object
Replaces server identified by the monitor
1 property
1 required
MonitorActionManageTickets
object
Manage the tickets through alerts
2 properties
2 required
MonitorConfiguration
object
The configurable attributes of a monitor
8 properties
MonitorIdentity
object
Identifier for a monitor
1 property
MonitorInitializer
object
Monitor attributes that cannot be changed after creation.
1 property
MonitorNotification
string
A notification to enact when monitoring is completed.
MonitorState
object
The state of the monitor.
1 property
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…
Name
string
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…
NonNegativeInteger
integer
An integer of value 0 or more.
LogsMonitorParameters
object
The configuration of a logs monitor
5 properties
3 required
ObjectMonitorParameters
object
The configuration of an object monitor
2 properties
2 required
SignalMonitorParameters
object
The configuration of an signal monitor
1 property
PageControl
Conditionally applies a set of actions to a request based on triggering conditions that are evaluated over request attributes.
WebControl
Conditionally applies a set of actions to a request based on triggering conditions that are evaluated over request attributes.
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…
PageControlAction
An array of actions to enact on the triggering of a page control.
PageControlActionAddIPToList
object
Add IP address of the request to address set
3 properties
2 required
PageControlActionAddLabels
object
Add custom labels to processed traffic. This is a non-final action.
2 properties
2 required
PageControlActionCacheOverrides
object
Update the cache-related headers of responses from backend servers.
2 properties
2 required
PageControlActionContinue
object
Continue execution of traffic controls. Non final action
1 property
1 required
PageControlActionDeny
object
Deny the request with the given status code. Final action
3 properties
3 required
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
PageControlActionDisableSessionTracking
object
Disable Webscale session tracking. No session-tracking cookies will be added to responses.
1 property
1 required
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
PageControlActionDrop
object
Drop the request. Final action
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
PageControlActionRedirect
object
Redirect the request. Final action
3 properties
3 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
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
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
PageControlActionSetContentSecurityPolicy
object
Set a content security policy.
2 properties
2 required
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
PageControlActionSetCookie
object
Set a response cookie.
5 properties
3 required
PageControlActionSetPagespeedOptions
object
Provides options for the pagespeed integration
4 properties
1 required
PageControlActionSetRequestHeader
object
Set a request header before a request is sent to a backend server.
3 properties
3 required
PageControlActionSetRequestTimeout
object
Set timeout for a request
2 properties
2 required
PageControlActionSetResponseHeader
object
Set a response header before a response is returned to a web browser.
3 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
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
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
PageControlActionUseAlternateBackends
object
Use different servers than the default for matching requests. Final action
8 properties
1 required
PageControlActionUserHasRole
object
Limit access to accounts and applications to users belonging to the given role.
2 properties
2 required
PageControlActionSubstitute
object
Substitute a string with an alternate string.
2 properties
2 required
PageControlActionUseServerlessFunction
object
Allows the user to invoke serverless function
2 properties
1 required
PageControlConditionAsnIsIncluded
object
Tests if the ASN of a request is included in the specified list.
1 property
1 required
PageControlConditionAsnIsNotIncluded
object
Tests if the ASN of a request is excluded from the specified list.
1 property
1 required
PageControlConditionAuthCookieIsNotSet
object
Test to see if a named authorization cookie is not set or is expired.
1 property
1 required
PageControlConditionAuthCookieIsSet
object
Test to see if a named authorization cookie is set and not expiredd.
1 property
1 required
PageControlConditionCookieIsNotSet
object
Test to see if a named cookie is not set.
1 property
1 required
PageControlConditionCookieIsSet
object
Test to see if a named cookie is set.
1 property
1 required
PageControlConditionCookieValueDoesNotMatch
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…
2 properties
2 required
PageControlConditionCookieValueMatches
object
Test to check if the named cookie value matches the specified pattern. Cookie value pattern must be a regular expression.
2 properties
2 required
PageControlConditionCountryIsIncluded
object
Tests if the country of origin of a request is included in the specified list.
1 property
1 required
PageControlConditionCountryIsNotIncluded
object
Tests if the country of origin of a request is excluded from the specified list.
1 property
1 required
PageControlConditionRandom
object
A test based on generating a random variable and triggering on a specified probability
1 property
1 required
PageControlConditionRateLimit
object
True when the number of request during a duration is greater than a specified threshold.
4 properties
3 required
PageControlConditions
object
The conditions that cause a page control to trigger
34 properties
PageControlConditionStatusCodeMatches
object
Test to see if the response status code matches the pattern.
1 property
1 required
PageControlConditionAddressInSet
object
Tests if requester's IP address is in the specified address set
1 property
1 required
PageControlConditionAddressNotInSet
object
Tests if requester's IP address is not in the specified address set
1 property
1 required
PageControlConditionUserAgentDoesNotMatch
object
Test if user-agent of a request does not match the given regular expression
1 property
1 required
PageControlConditionUserAgentMatches
object
Test if user-agent of a request matches the given regular expression
1 property
1 required
PageControlConfiguration
object
Configuration for a page control
6 properties
2 required
PageControlIdentity
object
Identifier for a page control
1 property
WebControlIdentity
object
Identifier for a web control
1 property
PageControlState
object
4 properties
WebControlState
object
4 properties
PagespeedFilterName
string
PaymentItem
object
2 properties
2 required
Permissions
object
3 properties
3 required
Plan
Blueprint of a plan for all the applications
PlanAttributes
object
Attribtues of a plan
40 properties
PlanConfiguration
object
The configurable attributes of a plan
4 properties
PlanIdentity
object
Identifier for a plan
1 property
PlanState
object
State values for plan
4 properties
PlanPost
object
3 required
PlanReadWrite
object
1 property
1 required
PositiveInteger
integer
An integer of value 1 or more.
ProcessLog
object
6 properties
Provider
object
5 properties
ProviderAttributes
object
Provider attributes that represent cloud provider attributes and may be queried via the API.
ProviderHref
string
Resource identifier for the provider, must be a URL encoded string.
ProviderResourceHref
string
Resource href that includes the Webscale provider identifier.
ProviderResource
object
Defines the attributes returned when a provider resource is requested from the API.
5 properties
ProviderResourceCollection
array
A collection of provider resources of a particular resource type.
Proxy
Data planes are constructed as a group of proxy servers
ProxyConfiguration
object
The configurable attributes of a proxy
5 properties
ProxyIdentity
object
Identifier for a proxy
1 property
ProxyState
object
The state of this proxy
6 properties
Range
object
Details for a log archive file.
5 properties
3 required
ReferrerPatterns
array
A list of referrer wildcard patterns
Report
A report to track all the resource allocation.
ReportIdentity
object
Identifier for a report.
2 properties
ReportState
object
The current state of a report.
2 properties
SectionedReport
object
A report generated multiple times over time is captured in independent sections.
2 properties
ApplicationTestReport
object
A single application test report generated after the test completes.
5 properties
RepoImage
object
3 properties
3 required
Retention
object
Log retention details.
1 property
Resource
object
An entity that may be manifested in a domain external to the Webscale control plane. Mapping various external and internal entities into a single namespace all…
ResourceCategoryConfiguration
object
1 required
ResourceCore
object
1 property
ResourceHost
ResourceHostConfiguration
object
Attributes available for patching a Host resource.
5 properties
ResourceIdentity
object
1 property
ResourceInitializer
object
1 required
ResourceConfiguration
object
Universally configurable attributes for a resource object.
4 properties
ResourcePatch
object
Data structure for patching a resource.
ResourcePost
object
Representation of new resource.
2 required
ResourcePost_metrics
array
Measurements of resource usage
ResourceReference
object
1 property
1 required
ResourceRepository
Role
A generic role granted to users of an account
RoleConfiguration
object
The configurable parts of a role
6 properties
RoleConfigurationPost
object
1 required
RoleIdentity
object
Identifier for a role
1 property
RoleInvitation
A invitation to a user role
RoleInvitationConfiguration
object
The configurable parts of a role invitation
1 property
RoleInvitationPost
object
2 required
RoleInvitationInitializer
object
The current state of a role invitation
2 properties
RoleInvitationState
object
The current state of a role invitation
4 properties
RoleInvitationIdentity
object
Identifier for a role invitation
1 property
RoleState
object
The current state of a role
2 properties
SearchResult
object
Results of a search task
1 property
SshHostLog
object
4 properties
4 required
Selector
object
2 properties
Stack
object
8 properties
Substitute
object
2 properties
2 required
Substitutes
array
Array of substitutes
SwapSshHostsViaResult
object
Results of a search task
1 property
TaskApproveSshHost
object
Approves the given SSH host target.
3 properties
2 required
TaskBuildImage
object
Build an image using a specified builder.
3 properties
2 required
TaskCancelBuild
object
Cancels an in-progress build.
2 properties
2 required
TaskCancelDeployment
object
Cancel a pending deployment for a specified cluster.
2 properties
2 required
TaskConnectRepository
object
Initiates the authentication process between a source repository and the Webscale account. The behavior of this endpoint depends on the authentication method p…
2 properties
2 required
TaskConnectRepositoryBitBucketAccessToken
object
Parameters to connect to Bitbucket Cloud with an access token.
3 properties
3 required
TaskConnectRepositoryGitHubApp
object
Parameters to connect the repository via GitHub app
1 property
1 required
TaskConnectRepositoryGitLabAccessToken
object
Parameters to connect to GitLab with an access token.
3 properties
3 required
TaskConnectRepositoryOauth
object
Parameters to connect the repository via OAuth
2 properties
2 required
TaskConfigureVarnish
object
Configure a data plane for Varnish application proxies.
2 properties
2 required
TaskCreateClusterServiceUser
object
Creates a cluster service user in the account specified if one does not already exist.
2 properties
2 required
TaskCreateDeployment
object
Create a new deployment for a specified cluster, optionally updating the cluster before deploying.
3 properties
2 required
TaskEnterMaintenance
object
Starts application maintenance
3 properties
2 required
TaskExitMaintenance
object
Exits application from maintenance
3 properties
2 required
TaskGenerateOriginCertificate
object
Generate a certificate issued by the certificate authority belonging to the current account. An origin certificate is trusted by infrastructure created within…
3 properties
2 required
TaskGetRequestAddress
object
Gets the public IP address of the requesting user agent.
1 property
1 required
TaskInvalidateCache
object
Invalidate cached responses for given application. Entries are invalidated in all caches used by the application as specified by the parameters. If neither URL…
3 properties
3 required
TaskOauth2Authorize
object
Complete an Oauth2 authorization
2 properties
2 required
TaskGetSshPublicKeys
object
Returns SSH public keys for the user identified by the given SSH username
2 properties
2 required
TaskGetUserPermissions
object
Gets permissions for the current authentication context. The result is an object whose member names are HTTP method names, given in uppercase and whose values…
1 property
1 required
TaskPrepareForDownload
object
Prepares an archived log for download. Logs that are archived are typically placed on storage that prevents them from being immediately available. The archived…
2 properties
2 required
TaskPrepareSshGatewayConnection
object
Given an SSH username and SSH host, returns information necessary for the SSH Gateway to establish a connection.
2 properties
2 required
TaskRespondToMarketingBanner
object
Applies an account owner's response to a marketing banner.
2 properties
2 required
TaskResumeDeployment
object
Resume a paused deployment for a specified cluster.
2 properties
2 required
TaskRollback
object
Start a rollback to a deployment that is in the running, keeping, retaining, or failed state. A deployment in the keeping state will be made active again, deac…
3 properties
1 required
TaskRunAction
object
Runs the target application
3 properties
3 required
TaskSearch
object
Parameter object for the search task
2 properties
2 required
TaskStart
object
Starts a target application
2 properties
2 required
TaskStop
object
Stops a target application
2 properties
2 required
TaskSubstituteTemplate
object
Process a template file, replacing value template references with processed content.
2 properties
2 required
TaskSwapSshHostsVia
object
Input for SSH host operations.
2 properties
2 required
TaskValidateTLS
object
Validates TLS for target application
2 properties
2 required
TaskUpdateRepository
object
Update an existing repository resource
2 properties
2 required
TaskUploadSshLogs
object
Uploads logs for the given SSH host.
3 properties
3 required
Roles
array
ScalingCondition
object
5 properties
5 required
ScalingOperator
string
Operator to determine scaling condition.
ScalingSeriesName
string
Name identifying the scaling condition type.
Script
string
Url associated with a third-party script
Secret
object
4 properties
3 required
SecretArray
array
SecretContent
string
The contents of the secret.
SecretDescription
string
Description of the resource.
SecretHref
string
The endpoint for the secret resource.
SecretMimeType
string
The mimetype of the secret format.
SecretPost
object
4 properties
2 required
SectionedReportHref
string
The endpoint resource identifier for a sectioned report
SecurityGroupHref
string
The endpoint resource identifier for the security group, must be a URL encoded string.
Server
object
1 property
1 required
ServerGroupHref
string
The endpoint resource identifier for the server group, must be a URL encoded string. Only valid for CenturyLink provider.
ServerMeasurement
object
Measurements of resource usage of a server for a particular interval
10 properties
2 required
ServerMeasurementDisk
object
A measurement of a disk or partition.
5 properties
1 required
ServerMeasurements
array
Measurements of resource usage of a server
ServerNetwork
object
3 properties
3 required
ServerPatch
object
Specifies attributes of a server to update
2 properties
ServicesHref
string
The endpoint for a resource accessible via services available for this account.
ServiceUser
object
ServiceUserIdentity
object
4 properties
ServiceUserConfiguration
object
2 properties
SettingName
string
The name of a configuration setting.
Settings
object
2 properties
SignupPost
object
SignupsResponse
object
3 properties
2 required
SignupWriteOnly
object
7 properties
3 required
SiteCache
object
A configuration for Dynamic Site Cache
2 properties
2 required
SiteCacheCondition
A condition used to match requests for Dynamic Site Cache
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
SshLogPost
object
10 properties
8 required
SshHost
SshHostAuthorizationPost
object
SSH Host authorization request
1 property
SshHostConfiguration
object
The configurable attributes of an SSH host.
3 properties
SshHostIdentity
object
Identifier for an SSH Host.
1 property
SshHostInitializer
object
2 properties
SshHostPost_logs
SshHostPatch
SshHostPost
object
SshHostPost_Logs
SshHostState
object
State for an SSH Host
5 properties
SshPublicKey
object
4 properties
2 required
SshPublicKeyPatch
object
3 properties
SshPublicKeyPost
object
3 properties
1 required
StackPatch
object
2 properties
StackPost
object
5 properties
5 required
StatusElement
An element that describes some element of system status
StatusIncident
object
An incident, in a status context
2 properties
StatusTimeline
object
A sequence of status elements arranged by time
2 properties
StatusTimelineEntry
object
An entry in a timeline, placed at a time and containing some element
2 properties
StatusVersions
object
Version details for components of the Webscale service.
2 properties
Subscription
object
SubscriptionReadOnly
object
2 properties
2 required
SubscriptionReadWrite
object
1 property
1 required
Success
object
1 property
1 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…
Task
object
12 properties
TaskPost
Configuration for a task to be created
Template
A template contains contains markdown that can be formatted to create messages for the alert or event.
TemplateConfiguration
object
The configurable attributes of a template
4 properties
TemplateIdentity
object
Identifier for a template
1 property
Timestamp
string
An iso8601 formatted timestamp
TlsConfiguration
object
9 properties
TlsConfigurationForValidator
object
3 properties
TlsVersion
string
Names of the versions of Transport Layer Security (TLS)
CoveredAlias
object
Certificate information for covered alias
3 properties
Type
object
A log field type.
3 properties
1 required
UrlMap
A URL map contains mappings from source URL to destination URL.
UrlMapConfiguration
object
The configurable attributes of a URL map
3 properties
UrlMapIdentity
object
Identifier for a URL map
1 property
UrlMapState
object
State for a URL map
3 properties
UrlMapEntry
object
Entry for a URL map
2 properties
2 required
User
object
UserPatch
object
5 properties
WebControlCondition
The condition that cause a web control to trigger
WebControlConfiguration
object
Configuration for a web control
6 properties
2 required
Whitelist
array
A list of addresses to which no restrictions will apply.
WhitelistItem
object
2 properties
2 required
WhitelistItemPut
object
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Cloud Hosting#Application Delivery#Content Delivery Network#Web Application Firewall#Edge Computing#Infrastructure#Observability
Where this information came from
This is an independent, third-party profile of Webscale APIs, 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.