Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kubescape Network Policies API

Generated NetworkPolicies and seccomp profiles.

Kubescape Network Policies API is one of 7 APIs that Kubescape publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Network Policies. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 3 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://api.armosec.io/api/v1.

3 operations 3 paths 2 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.armosec.io/api/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Kubescape Network Policies API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-KEY (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — Agent Access Key generated in ARMO Platform under Settings Agent Access Keys, sent in the X-API-KEY request header.

Paths & Operations 3

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

Network Policies 3

Generated NetworkPolicies and seccomp profiles.

GET
/networkPolicies
Retrieve generated network policies
getNetworkPolicies → 200401
POST
/networkPolicies/generate
Generate least-privilege NetworkPolicies
generateNetworkPolicies body → 200401
POST
/seccompProfiles/generate
Generate seccomp profiles
generateSeccompProfiles body → 200401

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are ListRequest (4 properties), Error (2 properties). Each schema is shown below with its type and property counts.

Error
object
2 properties
ListRequest
object
Query body used across ARMO list endpoints.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kubescape-network-policies-api-openapi.yml Raw ↑

Other APIs Kubescape publishes across the network.

Kubescape In-Cluster Component API (Open Source)
Kubescape Access Keys API
Kubescape Posture & Compliance API
Kubescape Registry & Repository API
Kubescape Runtime Security API
Kubescape Vulnerabilities API