Share feedback
Answers are generated based on the documentation.

Experimental

Product manualDownload OpenAPI specificationMarkdown

ListPolicyLogEntries lists observed policy decisions.

GET/v1/sandboxes/{sandbox}/policy-logs
ListPolicyLogEntries lists observed policy decisions.

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

sandbox path Required

The sandbox id.

Type: string

All schema constraints and annotations
{
  "type": "string"
}

pageSize query

page_size is an optional page size.

Omitted or zero uses the backend default. Unless the operation states otherwise, page-size limits and handling of larger requests are backend-specific; use the backend support guide. Continue with nextPageToken until it is empty.

Type: integer

All schema constraints and annotations
{
  "title": "page_size",
  "type": "integer"
}

pageToken query

page_token is an opaque continuation token.

Type: string

All schema constraints and annotations
{
  "title": "page_token",
  "type": "string"
}

filter query

filter is comma-separated exact-match field=value terms; the portable field is domain.

Type: string

All schema constraints and annotations
{
  "title": "filter",
  "type": "string"
}

since query

An RFC 3339 timestamp, for example 2026-01-01T12:00:00Z. Fractional seconds may contain up to nine digits. The supported range is 0001-01-01T00:00:00Z through 9999-12-31T23:59:59.999999999Z.

Type: string

All schema constraints and annotations
{
  "examples": [
    "2023-01-15T01:30:15.01Z",
    "2024-12-25T12:00:00Z"
  ],
  "format": "date-time",
  "type": "string"
}

until query

An RFC 3339 timestamp, for example 2026-01-01T12:00:00Z. Fractional seconds may contain up to nine digits. The supported range is 0001-01-01T00:00:00Z through 9999-12-31T23:59:59.999999999Z.

Type: string

All schema constraints and annotations
{
  "examples": [
    "2023-01-15T01:30:15.01Z",
    "2024-12-25T12:00:00Z"
  ],
  "format": "date-time",
  "type": "string"
}

Request and responses

Response 200

Success

application/json

Schema: ListPolicyLogEntriesResponse

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/ListPolicyLogEntriesResponse

Complete operation contract
{
  "description": "ListPolicyLogEntries lists observed policy decisions.",
  "operationId": "listPolicyLogEntries",
  "parameters": [
    {
      "description": "The sandbox id.",
      "in": "path",
      "name": "sandbox",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "description": "page_size is an optional page size.\n\nOmitted or zero uses the backend default. Unless the operation states otherwise, page-size limits and handling of larger requests are backend-specific; use the backend support guide. Continue with nextPageToken until it is empty.",
      "in": "query",
      "name": "pageSize",
      "required": false,
      "schema": {
        "title": "page_size",
        "type": "integer"
      }
    },
    {
      "description": "page_token is an opaque continuation token.",
      "in": "query",
      "name": "pageToken",
      "required": false,
      "schema": {
        "title": "page_token",
        "type": "string"
      }
    },
    {
      "description": "filter is comma-separated exact-match field=value terms; the portable field is\ndomain.",
      "in": "query",
      "name": "filter",
      "required": false,
      "schema": {
        "title": "filter",
        "type": "string"
      }
    },
    {
      "description": "An RFC 3339 timestamp, for example 2026-01-01T12:00:00Z. Fractional seconds may contain up to nine digits. The supported range is 0001-01-01T00:00:00Z through 9999-12-31T23:59:59.999999999Z.",
      "in": "query",
      "name": "since",
      "required": false,
      "schema": {
        "examples": [
          "2023-01-15T01:30:15.01Z",
          "2024-12-25T12:00:00Z"
        ],
        "format": "date-time",
        "type": "string"
      }
    },
    {
      "description": "An RFC 3339 timestamp, for example 2026-01-01T12:00:00Z. Fractional seconds may contain up to nine digits. The supported range is 0001-01-01T00:00:00Z through 9999-12-31T23:59:59.999999999Z.",
      "in": "query",
      "name": "until",
      "required": false,
      "schema": {
        "examples": [
          "2023-01-15T01:30:15.01Z",
          "2024-12-25T12:00:00Z"
        ],
        "format": "date-time",
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ListPolicyLogEntriesResponse"
          }
        }
      },
      "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": "ListPolicyLogEntries lists observed policy decisions.",
  "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"
}