Appearance
kubernetes.networkpolicy.get ​
Read a single NetworkPolicy (full spec included)
Reads a single NetworkPolicy from the cluster.
If the NetworkPolicy exists, returns it serialised via api_client.sanitize_for_serialization alongside exists=True. If it is not found (404), returns exists=False and networkpolicy=None — no exception is raised.
The full object is returned rather than a summary because the caller of a policy read is usually a drift check: it needs to compare the live rules against the declared ones field-for-field, and a projection would hide the difference it is looking for. Use kubernetes.networkpolicy.list when a namespace overview is enough.
Inputs:
- connection_uuid: UUID of the cloud connection (required)
- namespace: Namespace the NetworkPolicy lives in (required)
- name: NetworkPolicy name (required)
Outputs:
- exists: bool — True when the NetworkPolicy was found
- networkpolicy: JSON — full V1NetworkPolicy serialised for transport, or null
Plugin required: context.get_plugin("connection").kubernetes_runner_clients(connection_uuid, organization_uuid) must expose networking_v1 with read_namespaced_network_policy and api_client with sanitize_for_serialization.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-kubernetes |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
connection_uuid | uuid | Yes | — | — |
namespace | string | Yes | — | — |
name | string | Yes | — | — |
organization_uuid | uuid | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
connection_uuid | uuid | No | — | — |
organization_uuid | uuid | No | — | — |
namespace | string | No | — | — |
name | string | No | — | — |
exists | boolean | No | — | — |
apiVersion | string | No | — | — |
kind | string | No | — | — |
metadata | json | No | — | — |
spec | json | No | — | — |
status | json | No | — | — |
data | json | No | — | — |
binaryData | json | No | — | — |
stringData | json | No | — | — |
immutable | boolean | No | — | — |
type | string | No | — | — |
rules | json | No | — | — |
aggregationRule | json | No | — | — |
roleRef | json | No | — | — |
subjects | json | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "kubernetes.networkpolicy.get",
"initial_data": {
"connection_uuid": "value",
"namespace": "value",
"name": "value"
}
}