Share feedback
Answers are generated based on the documentation.

Experimental

Product manualDownload OpenAPI specificationMarkdown

GetNetworkPolicies returns effective and exact views of the same installed generation.

GET/v1/network-policies
GetNetworkPolicies returns effective and exact views of the same installed generation.

Connection and access

API connection and authentication guidance

https://connect.docker.com/sandboxes — The API base URL. Append the /v1 paths while preserving this URL's path prefix.

Use one of these alternatives. Requirements within an alternative apply together.

  • bearer

Parameters

acceptedSelectorVersions query

Omitted versions accept only destination.v1; an unsupported representation fails closed.

Type: array

Array item

Type: string

All schema constraints and annotations
{
  "description": "",
  "minLength": 1,
  "type": "string"
}
All schema constraints and annotations
{
  "items": {
    "description": "",
    "minLength": 1,
    "type": "string"
  },
  "maxItems": 8,
  "title": "accepted_selector_versions",
  "type": "array",
  "uniqueItems": true
}

Request and responses

Response 200

Success

application/json

Schema: GetNetworkPoliciesResponse

Response default

The structured Error body identifies the failure with a stable code and optional typed details.

application/json

Schema: Error

Schema example

{
  "code": "notFound",
  "details": [],
  "message": "sandbox not found"
}

Referenced schemas

#/components/schemas/Error

#/components/schemas/GetNetworkPoliciesResponse

Complete operation contract
{
  "description": "GetNetworkPolicies returns effective and exact views of the same installed generation.",
  "operationId": "getNetworkPoliciesInOwnerScope",
  "parameters": [
    {
      "description": "Omitted versions accept only destination.v1; an unsupported representation fails closed.",
      "in": "query",
      "name": "acceptedSelectorVersions",
      "required": false,
      "schema": {
        "items": {
          "description": "",
          "minLength": 1,
          "type": "string"
        },
        "maxItems": 8,
        "title": "accepted_selector_versions",
        "type": "array",
        "uniqueItems": true
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/GetNetworkPoliciesResponse"
          }
        }
      },
      "description": "Success"
    },
    "default": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "The structured Error body identifies the failure with a stable code and optional typed details."
    }
  },
  "security": [
    {
      "bearer": []
    }
  ],
  "summary": "GetNetworkPolicies returns effective and exact views of the same installed generation.",
  "tags": [
    "Network policies"
  ],
  "x-sbx-authenticated-only": false,
  "x-sbx-conditional-permissions": [],
  "x-sbx-plane": "control",
  "x-sbx-required-permissions": [
    "networkPoliciesRead"
  ],
  "x-sbx-serving-surface": "management"
}