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

Calico NetworkPolicy API

The NetworkPolicy API from Calico — 2 operation(s) for networkpolicy.

Calico NetworkPolicy API is one of 10 APIs that Calico publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include NetworkPolicy. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.1.0, at version 3.0.0.

Requests are made against a single base URL, https://{kube_apiserver_host}/apis/projectcalico.org/v3.

5 operations 2 paths 7 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.0.0
Server
https://{kube_apiserver_host}/apis/projectcalico.org/v3
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Calico NetworkPolicy API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Kubernetes service account bearer token.

Paths & Operations 5

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

NetworkPolicy 5
GET
/namespaces/{namespace}/networkpolicies
List NetworkPolicy in namespace
listNamespacedNetworkPolicy 3 params → 200401
POST
/namespaces/{namespace}/networkpolicies
Create NetworkPolicy
createNamespacedNetworkPolicy 1 param body → 201409
GET
/namespaces/{namespace}/networkpolicies/{name}
Read NetworkPolicy
readNamespacedNetworkPolicy 2 params → 200404
PUT
/namespaces/{namespace}/networkpolicies/{name}
Replace NetworkPolicy
replaceNamespacedNetworkPolicy 2 params body → 200
DELETE
/namespaces/{namespace}/networkpolicies/{name}
Delete NetworkPolicy
deleteNamespacedNetworkPolicy 2 params → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Rule (9 properties), EntityRule (8 properties), NetworkPolicySpec (7 properties), ObjectMeta (7 properties). Each schema is shown below with its type and property counts.

Rule
object
9 properties 1 required
ObjectMeta
object
7 properties
EntityRule
object
8 properties
NetworkPolicy
object
4 properties 4 required
NetworkPolicySpec
object
7 properties
NetworkPolicyList
object
3 properties
Status
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

calico-networkpolicy-api-openapi.yml Raw ↑

Other APIs Calico publishes across the network.

Calico Client API
calicoctl CLI
Calico Kubernetes CRDs
Calico BGPConfiguration API
Calico BGPPeer API
Calico GlobalNetworkPolicy API
Calico HostEndpoint API
Calico IPPool API
Calico Profile API