How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Webscale Networks Clusters API

The Clusters API from Webscale Networks — 4 operation(s) for clusters.

Webscale Networks Clusters 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 Cluster. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and authentication docs.

This API exposes 7 operations across 4 paths, and defines 52 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.

7 operations 4 paths 52 schemas 1 DELETE4 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2026.273
Base URL
https://api.webscale.com/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Webscale Networks Clusters 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 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Clusters 7
GET
/clusters
Read cluster collection
getClusters → 200
POST
/clusters
Create a cluster
postClusters body → 201
GET
/clusters/{id}
Read a cluster
getClustersById 1 param → 200
PATCH
/clusters/{id}
Update a cluster
patchClustersById 1 param body → 200
DELETE
/clusters/{id}
Delete a cluster
deleteClustersById 1 param → 200202
GET
/clusters/{id}/metrics
Read cluster metrics
getClustersByIdMetrics 6 params → 200
GET
/clusters/metrics
Read cluster collection metrics
getClustersMetrics 4 params → 200

Schemas 52

The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are ClusterConfiguration (27 properties), Blueprint (22 properties), Task (12 properties), Check (10 properties). Each schema is shown below with its type and property counts.

MultiMetrics
array
An Array of metrics for multiple objects
ClusterState
object
6 properties 4 required
SecurityGroupHref
string
The endpoint resource identifier for the security group, must be a URL encoded string.
Task
object
12 properties
ProviderHref
string
Resource identifier for the provider, must be a URL encoded string.
AccountHref
string
A reference to an account
Check
object
10 properties 1 required
ApplicationHref
string
The endpoint for the application resource.
ClusterConfiguration
object
27 properties
Metrics
object
Metrics for the given specifications.
4 properties 4 required
Blueprint
object
The endpoint resource reference to the blueprint of the servers.
22 properties
HttpUrl
string
An HTTP URL address.
MetricValues
array
An array of metric values, one per resolution period
Timestamp
string
An iso8601 formatted timestamp
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…
PositiveInteger
integer
An integer of value 1 or more.
AddressWithPort
string
IP address with port number(optional).
AccountConfiguration
object
4 properties
ClusterPost
object
ProviderResourceHref
string
Resource href that includes the Webscale provider identifier.
MetricSummary
number
A summary value of a metric across the entire returned time range
InstanceTemplate
string
The endpoint resource identifier for the instance template.
Server
object
1 property 1 required
Provider
object
5 properties
ClusterAccess
object
Describes a method for accessing a service deployment.
1 property 1 required
Header
object
2 properties 2 required
NonNegativeInteger
integer
An integer of value 0 or more.
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…
Account
object
BlueprintLogsApplication
object
The application logs config object to specify which cluster logs are sent to custom logs.
2 properties 2 required
Duration
Duration in seconds, no fractional values.
IdentityConfiguration
object
Configuration of the identity assigned to cluster servers.
3 properties 3 required
ProviderAttributes
object
Provider attributes that represent cloud provider attributes and may be queried via the API.
AccountState
object
1 property
AccountLogRetention
object
5 properties 1 required
MetadataEntry
object
A key/value pair to be made available on servers made with this metadata.
2 properties
Hostname
string
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.
ClusterHref
stringnull
The endpoint for the cluster resource.
ScalingOperator
string
Operator to determine scaling condition.
MetadataFileEntry
object
A file to be created on newly created servers.
3 properties
SearchResult
object
Results of a search task
1 property
ClusterPatch
object
ServerNetwork
object
3 properties 3 required
ScalingSeriesName
string
Name identifying the scaling condition type.
FileHref
string
Endpoint resource reference to a file.
DurationDisplayUnit
string
Unit to use for displaying the time duration specified.
ClusterServer
object
AccountIdentity
object
2 properties 2 required
BlueprintLogStream
object
A log stream configuration for use with Webscale Monitoring Agent.
5 properties 2 required
Name
string
ScalingCondition
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webscale-networks-clusters-api-openapi.yml Raw ↑

Other APIs Webscale Networks publishes across the network.

Webscale Networks Accounts API
Webscale Networks Address sets API
Webscale Networks Application test API
Webscale Networks Applications API
Webscale Networks Builders 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
Where this information came from

This is an independent, third-party profile of Webscale Networks Clusters 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.