Cilium Agent API

---
swagger: '2.0'
info:
  title: Cilium API
  description: Cilium
  version: v1beta1
x-schemes:
- unix
basePath: "/v1"
produces:
- application/json
consumes:
- application/json
paths:
  "/cluster/nodes":
    get:
      summary: Get nodes information stored in the cilium-agent
      tags:
      - daemon
      parameters:
      - name: client-id
        description: |
          Client UUID should be used when the client wants to request
          a diff of nodes added and / or removed since the last time
          that client has made a request.
        in: header
        required: false
        type: integer
      responses:
        '200':
          description: Success
          schema:
            "$ref": "#/definitions/ClusterNodeStatus"
  "/healthz":
    get:
      summary: Get health of Cilium daemon
      description: |
        Returns health and status information of the Cilium daemon and related
        components such as the connected datastore, Kubernetes integration and
        Hubble.
      tags:
      - daemon
      parameters:
      - name: brief
        description: |
          Brief will return a brief representation of the Cilium status.
        in: header
        required: false
        type: boolean
      - name: require-k8s-connectivity
        description: |
          If set to true, failure of the agent to connect to the Kubernetes control plane will cause the agent's health status to also fail.
        in: header
        required: false
        type: boolean
        default: true
      responses:
        '200':
          description: Success
          schema:
            "$ref": "#/definitions/StatusResponse"
  "/config":
    get:
      summary: Get configuration of Cilium daemon
      description: |
        Returns the configuration of the Cilium daemon.
      tags:
      - daemon
      responses:
        '200':
          description: Success
          schema:
            "$ref": "#/definitions/DaemonConfiguration"
    patch:
      summary: Modify daemon configuration
      description: |
        Updates the daemon configuration by applying the provided
        ConfigurationMap and regenerates & recompiles all required datapath
        components.
      tags:
      - daemon
      parameters:
      - name: configuration
        in: body
        required: true
        schema:
          "$ref": "#/definitions/DaemonConfigurationSpec"
      responses:
        '200':
          description: Success
        '400':
          description: Bad configuration parameters
          schema:
            "$ref": "#/definitions/Error"
        '403':
          description: Forbidden
        '500':
          description: Recompilation failed
          x-go-name: Failure
          schema:
            "$ref": "#/definitions/Error"
  "/endpoint/{id}":
    get:
      summary: Get endpoint by endpoint ID
      description: |
        Returns endpoint information
      tags:
      - endpoint
      parameters:
      - "$ref": "#/parameters/endpoint-id"
      responses:
        '200':
          description: Success
          schema:
            "$ref": "#/definitions/Endpoint"
        '400':
          description: Invalid endpoint ID format for specified type
          x-go-name: Invalid
          schema:
            "$ref": "#/definitions/Error"
        '404':
          description: Endpoint not found
        '429':
          description: Rate-limiting too many requests in the given time frame
    put:
      summary: Create endpoint
      description: |
        Creates a new endpoint
      tags:
      - endpoint
      parameters:
      - "$ref": "#/parameters/endpoint-id"
      - "$ref": "#/parameters/endpoint-change-request"
      responses:
        '201':
          description: Created
          schema:
            "$ref": "#/definitions/Endpoint"
        '400':
          description: Invalid endpoint in request
          x-go-name: Invalid
          schema:
            "$ref": "#/definitions/Error"
        '403':
          description: Forbidden
        '409':
          description: Endpoint already exists
          x-go-name: Exists
        '500':
          description: Endpoint creation failed
          x-go-name: Failed
          schema:
            "$ref": "#/definitions/Error"
        '429':
          description: Rate-limiting too many requests in the given time frame
        '503':
          description: Service Unavailable
    patch:
      summary: Modify existing endpoint
      deprecated: true
      description: |
        Applies the endpoint change request to an existing endpoint
      tags:
      - endpoint
      parameters:
      - "$ref": "#/parameters/endpoint-id"
      - "$ref": "#/parameters/endpoint-change-request"
      responses:
        '200':
          description: Success
        '400':
          description: Invalid modify endpoint request
          x-go-name: Invalid
          schema:
            "$ref": "#/definitions/Error"
        '403':
          description: Forbidden
        '404':
          description: Endpoint does not exist
        '500':
          description: Endpoint update failed
          x-go-name: Failed
          schema:
            "$ref": "#/definitions/Error"
        '429':
          description: Rate-limiting too many requests in the given time frame
        '503':
          description: Service Unavailable
    delete:
      summary: Delete endpoint
      description: |
        Deletes the endpoint specified by the ID. Deletion is imminent and
        atomic, if the deletion request is valid and the endpoint exists,
        deletion will occur even if errors are encountered in the process. If
        errors have been encountered, the code 202 will be returned, otherwise
        200 on success.

        All resources associated with the endpoint will be freed and the
        workload represented by the endpoint will be disconnected.It will no
        longer be able to initiate or receive communications of any sort.
      tags:
      - endpoint
      parameters:
      - "$ref": "#/parameters/endpoint-id"
      responses:
        '200':
          description: Success
        '206':
          description: Deleted with a number of errors encountered
          x-go-name: Errors
          schema:
            type: integer
        '400':
          description: |
            Invalid endpoint ID format for specified type. Details in error
            message
          x-go-name: Invalid
          schema:
            "$ref": "#/definitions/Error"
        '403':
          description: Forbidden
        '404':
          description: Endpoint not found
        '429':
          description: Rate-limiting too many requests in the given time frame
        '503':
          description: Service Unavailable
  "/endpoint":
    get:
      summary: Retrieves a list of endpoints that have metadata matching the provided parameters.
      description: |
        Retrieves a list of endpoints that have metadata matching the provided parameters, or all endpoints if no parameters provided.
      tags:
      - endpoint
      parameters:
      - "$ref": "#/parameters/labels"
      responses:
        '200':
          description: Success
          schema:
            type: array
            items:
              "$ref": "#/definitions/Endpoint"
        '404':
          description: Endpoints with provided parameters not found
        '429':
          description: Rate-limiting too many requests in the given time frame
    delete:
      summary: Deletes a list of endpoints
      description: |
        Deletes a list of endpoints that have endpoints matching the provided properties
      tags:
        - endpoint
      parameters:
        - "$ref": "#/parameters/endpoint-batch-delete-request"
      responses:
        '200':
          description: Success
        '206':
          description: Deleted with a number of errors encountered
          x-go-name: Errors
          schema:
            type: integer
        '400':
          description: Invalid endpoint delete request
          x-go-name: Invalid
        '404':
          description: No endpoints with provided parameters found
        '429':
          description: Rate-limiting too many requests in the given time frame
        '503':
          description: Service Unavailable
  "/endpoint/{id}/config":
    get:
      summary: Retrieve endpoint configuration
      description: |
        Retrieves the configuration of the specified endpoint.
      tags:
      - endpoint
      parameters:
      - "$ref": "#/parameters/endpoint-id"
      responses:
        '200':
          description: Success
          schema:
            "$ref": "#/definitions/EndpointConfigurationStatus"
        '404':
          description: Endpoint not found
        '429':
          description: Rate-limiting too many requests in the given time frame
    patch:
      summary: Modify mutable endpoint configuration
      description: |
        Update the configuration of an existing endpoint and regenerates &
        recompiles the corresponding programs automatically.
      tags:
      - endpoint
      parameters:
      - "$ref": "#/parameters/endpoint-id"
      - name: endpoint-configuration
        in: body
        required: true
        schema:
          "$ref": "#/definitions/EndpointConfigurationSpec"
      responses:
        '200':
          description: Success
        '400':
          description: Invalid configuration request
          x-go-name: Invalid
        '403':
          description: Forbidden
        '404':
          description: Endpoint not found
        '500':
          description: Update failed. Details in message.
          x-go-name: Failed
          schema:
            "$ref": "#/definitions/Error"
        '429':
          description: Rate-limiting too many requests in the given time frame
        '503':
          description: Service Unavailable
  "/endpoint/{id}/labels":
    get:
      summary: Retrieves the list of labels associated with an endpoint.
      tags:
      - endpoint
      parameters:
      - "$ref": "#/parameters/endpoint-id"
      responses:
        '200':
          description: Success
          schema:
            "$ref": "#/definitions/LabelConfiguration"
        '404':
          description: Endpoint not found
        '429':
          description: Rate-limiting too many requests in the given time frame
    patch:
      summary: Set label configuration of endpoint
      description: |
        Sets labels associated with an endpoint. These can be user provided or
        derived from the orchestration system.
      tags:
      - endpoint
      parameters:
      - "$ref": "#/parameters/endpoint-id"
      - name: configuration
        in: body
        required: true
        schema:
          "$ref": "#/definitions/LabelConfigurationSpec"
      responses:
        '200':
          description: Success
        '403':
          description: Forbidden
        '404':
          description: Endpoint not found
        '500':
          description: Error while updating labels
          x-go-name: UpdateFailed
          schema:
            "$ref": "#/definitions/Error"
        '429':
          description: Rate-limiting too many requests in the given time frame
        '503':
          description: Service Unavailable
  "/endpoint/{id}/log":
    get:
      summary: Retrieves the status logs associated with this endpoint.
      tags:
      - endpoint
      parameters:
      - "$ref": "#/parameters/endpoint-id"
      responses:
        '200':
          description: Success
          schema:
            "$ref": "#/definitions/EndpointStatusLog"
        '400':
          description: Invalid identity provided
          x-go-name: Invalid
        '404':
          description: Endpoint not found
        '429':
          description: Rate-limiting too many requests in the given time frame

  "/endpoint/{id}/healthz":
    get:
      summary: Retrieves the status logs associated with this endpoint.
      tags:
      - endpoint
      parameters:
      - "$ref": "#/parameters/endpoint-id"
      responses:
        '200':
          description: Success
          schema:
            "$ref": "#/definitions/EndpointHealth"
        '400':
          description: Invalid identity provided
          x-go-name: Invalid
        '404':
          description: Endpoint not found
        '429':
          description: Rate-limiting too many requests in the given time frame
  "/identity":
    get:
      summary: Retrieves a list of identities that have metadata matching the provided parameters.
      description: |
        Retrieves a list of identities that have metadata matching the provided parameters, or all identities if no parameters are provided.
      tags:
      - policy
      parameters:
      - "$ref": "#/parameters/labels"
      responses:
        '200':
          description: Success
          schema:
            type: array
            items:
              "$ref": "#/definitions/Identity"
        '404':
          description: Identities with provided parameters not found
        '520':
          description: Identity storage unreachable. Likely a network problem.
          x-go-name: Unreachable
          schema:
            "$ref": "#/definitions/Error"
        '521':
          description: Invalid identity format in storage
          x-go-name: InvalidStorageFormat
          schema:
            "$ref": "#/definitions/Error"
  "/identity/{id}":
    get:
      summary: Retrieve identity
      tags:
      - policy
      parameters:
      - "$ref": "#/parameters/identity-id"
      responses:
        '200':
          description: Success
          schema:
            "$ref": "#/definitions/Identity"
        '400':
          description: Invalid identity provided
        '404':
          description: Identity not found
        '520':
          description: Identity storage unreachable. Likely a network problem.
          x-go-name: Unreachable
          schema:
            "$ref": "#/definitions/Error"
        '521':
          description: Invalid identity format in storage
          x-go-name: InvalidStorageFormat
          schema:
            "$ref": "#/definitions/Error"
  "/identity/endpoints":
    get:
      summary: Retrieve identities which are being used by local endpoints
      tags:
      - policy
      responses:
        '200':
          description: Success
          schema:
            type: array
            items:
              "$ref": "#/definitions/IdentityEndpoints"
        '404':
          description: Set of identities which are being used by local endpoints could not be found.
  "/ipam":
    post:
      summary: Allocate an IP address
      tags:
      - ipam
      parameters:
      - "$ref": "#/parameters/ipam-family"
      - "$ref": "#/parameters/ipam-owner"
      - "$ref": "#/parameters/ipam-pool"
      - "$ref": "#/parameters/ipam-expiration"
      responses:
        '201':
          description: Success
          schema:
            "$ref": "#/definitions/IPAMResponse"
        '403':
          description: Forbidden
        '502':
          description: Allocation failure
          x-go-name: Failure
          schema:
            "$ref": "#/definitions/Error"
  "/ipam/{ip}":
    post:
      summary: Allocate an IP address
      tags:
      - ipam
      parameters:
      - "$ref": "#/parameters/ipam-ip"
      - "$ref": "#/parameters/ipam-owner"
      - "$ref": "#/parameters/ipam-pool"
      responses:
        '200':
          description: Success
        '400':
          description: Invalid IP address
          x-go-name: Invalid
        '403':
          description: Forbidden
        '409':
          description: IP already allocated
          x-go-name: Exists
        '500':
          description: IP allocation failure. Details in message.
          x-go-name: Failure
          schema:
            "$ref": "#/definitions/Error"
        '501':
          description: Allocation for address family disabled
          x-go-name: Disabled
    delete:
      summary: Release an allocated IP address
      tags:
      - ipam
      parameters:
      - "$ref": "#/parameters/ipam-ip"
      - "$ref": "#/parameters/ipam-pool"
      responses:
        '200':
          description: Success
        '400':
          description: Invalid IP address
          x-go-name: Invalid
        '403':
          description: Forbidden
        '404':
          description: IP address not found
        '500':
          description: Address release failure
          x-go-name: Failure
          schema:
            "$ref": "#/definitions/Error"
        '501':
          description: Allocation for address family disabled
          x-go-name: Disabled
  "/policy":
    get:
      summary: Retrieve entire policy tree
      description: |
        Returns the entire policy tree with all children.

        Deprecated: will be removed in v1.19
      deprecated: true
      tags:
      - policy
      responses:
        '200':
          description: Success
          schema:
            "$ref": "#/definitions/Policy"
        '404':
          description: No policy rules found
  "/policy/selectors":
    get:
      summary: See what selectors match which identities
      tags:
      - policy
      responses:
        '200':
          description: Success
          schema:
            "$ref": "#/definitions/SelectorCache"
  "/policy/subject-selectors":
    get:
      summary: See what subject selectors match which identities on the local node
      tags:
        - policy
      responses:
        '200':
          description: Success
          schema:
            "$ref": "#/definitions/SelectorCache"
  "/lrp":
    get:
      summary: Retrieve list of all local redirect policies
      tags:
      - service
      responses:
        '200':
          description: Success
          schema:
            type: array
            items:
              "$ref": "#/definitions/LRPSpec"
  "/service":
    get:
      summary: Retrieve list of all services
      tags:
      - service
      responses:
        '200':
          description: Success
          schema:
            type: array
            items:
              "$ref": "#/definitions/Service"
  "/prefilter":
    get:
      summary: Retrieve list of CIDRs
      tags:
      - prefilter
      responses:
        '200':
          description: Success
          schema:
            "$ref": "#/definitions/Prefilter"
        '500':
          description: Prefilter get failed
          x-go-name: Failure
          schema:
            "$ref": "#/definitions/Error"
    patch:
      summary: Update list of CIDRs
      tags:
      - prefilter
      parameters:
      - "$ref": "#/parameters/prefilter-spec"
      responses:
        '200':
          description: Updated
          schema:
            "$ref": "#/definitions/Prefilter"
        '403':
          description: Forbidden
        '461':
          description: Invalid CIDR prefix
          x-go-name: InvalidCIDR
          schema:
            "$ref": "#/definitions/Error"
        '500':
          description: Prefilter update failed
          x-go-name: Failure
          schema:
            "$ref": "#/definitions/Error"
    delete:
      summary: Delete list of CIDRs
      tags:
      - prefilter
      parameters:
      - "$ref": "#/parameters/prefilter-spec"
      responses:
        '200':
          description: Deleted
          schema:
            "$ref": "#/definitions/Prefilter"
        '403':
          description: Forbidden
        '461':
          description: Invalid CIDR prefix
          x-go-name: InvalidCIDR
          schema:
            "$ref": "#/definitions/Error"
        '500':
          description: Prefilter delete failed
          x-go-name: Failure
          schema:
            "$ref": "#/definitions/Error"
  "/debuginfo":
    get:
      summary: Retrieve information about the agent and environment for debugging
      tags:
      - daemon
      responses:
        '200':
          description: Success
          schema:
            "$ref": "#/definitions/DebugInfo"
        '500':
          description: DebugInfo get failed
          x-go-name: Failure
          schema:
            "$ref": "#/definitions/Error"
  "/cgroup-dump-metadata":
    get:
      summary: Retrieve cgroup metadata for all pods
      tags:
      - daemon
      responses:
        '200':
          description: Success
          schema:
            "$ref": "#/definitions/CgroupDumpMetadata"
        '500':
          description: CgroupDumpMetadata get failed
          x-go-name: Failure
          schema:
            "$ref": "#/definitions/Error"
  "/map":
    get:
      summary: List all open maps
      tags:
      - daemon
      responses:
        '200':
          description: Success
          schema:
            "$ref": "#/definitions/BPFMapList"
  "/map/{name}":
    get:
      summary: Retrieve contents of BPF map
      tags:
      - daemon
      parameters:
      - "$ref": "#/parameters/map-name"
      responses:
        '200':
          description: Success
          schema:
            "$ref": "#/definitions/BPFMap"
        '404':
          description: Map not found
  "/map/{name}/events":
    get:
      summary: Retrieves the recent event logs associated with this endpoint.
      tags:
      - daemon
      parameters:
      - "$ref": "#/parameters/map-name"
      - "$ref": "#/parameters/follow"
      responses:
        '200':
          description: Success
          schema:
            type: string
            format: binary
        '404':
          description: Map not found

  "/fqdn/cache":
    get:
      summary: Retrieves the list of DNS lookups intercepted from all endpoints.
      description: |
        Retrieves the list of DNS lookups intercepted from endpoints,
        optionally filtered by DNS name, CIDR IP range or source.
      tags:
      - policy
      parameters:
      - "$ref": "#/parameters/matchpattern"
      - "$ref": "#/parameters/cidr"
      - "$ref": "#/parameters/source"
      responses:
        '200':
          description: Success
          schema:
            type: array
            items:
              "$ref": "#/definitions/DNSLookup"
        '400':
          description: Invalid request (error parsing parameters)
          schema:
            "$ref": "#/definitions/Error"
        '404':
          description: No DNS data with provided parameters found
    delete:
      summary: Deletes matching DNS lookups from the policy-generation cache.
      description: |
        Deletes matching DNS lookups from the cache, optionally restricted by
        DNS name. The removed IP data will no longer be used in generated
        policies.
      tags:
      - policy
      parameters:
      - "$ref": "#/parameters/matchpattern"
      responses:
        '200':
          description: Success
        '403':
          description: Forbidden
        '400':
          description: Invalid request (error parsing parameters)
          schema:
            "$ref": "#/definitions/Error"

  "/fqdn/cache/{id}":
    get:
      summary: Retrieves the list of DNS lookups intercepted from an endpoint.
      description: |
        Retrieves the list of DNS lookups intercepted from the specific endpoint,
        optionally filtered by endpoint id, DNS name, CIDR IP range or source.
      tags:
      - policy
      parameters:
      - "$ref": "#/parameters/endpoint-id"
      - "$ref": "#/parameters/matchpattern"
      - "$ref": "#/parameters/cidr"
      - "$ref": "#/parameters/source"
      responses:
        '200':
          description: Success
          schema:
            type: array
            items:
              "$ref": "#/definitions/DNSLookup"
        '400':
          description: Invalid request (error parsing parameters)
          schema:
            "$ref": "#/definitions/Error"
        '404':
          description: No DNS data with provided parameters found
  "/fqdn/names":
    get:
      summary: List internal DNS selector representations
      description: |
        Retrieves the list of DNS-related fields (names to poll, selectors and
        their corresponding regexes).
      tags:
      - policy
      responses:
        '200':
          description: Success
          schema:
            "$ref": "#/definitions/NameManager"
        '400':
          description: Invalid request (error parsing parameters)
          schema:
            "$ref": "#/definitions/Error"
  "/ip":
    get:
      summary: Lists information about known IP addresses
      description: |
        Retrieves a list of IPs with known associated information such as
        their identities, host addresses, Kubernetes pod names, etc.
        The list can optionally filtered by a CIDR IP range.
      tags:
      - policy
      parameters:
      - "$ref": "#/parameters/cidr"
      - "$ref": "#/parameters/labels"
      responses:
        '200':
          description: Success
          schema:
            type: array
            items:
              "$ref": "#/definitions/IPListEntry"
        '400':
          description: Invalid request (error parsing parameters)
          schema:
            "$ref": "#/definitions/Error"
        '404':
          description: No IP cache entries with provided parameters found
  "/node/ids":
    get:
      summary: List information about known node IDs
      description: |
        Retrieves a list of node IDs allocated by the agent and their
        associated node IP addresses.
      tags:
      - daemon
      responses:
        '200':
          description: Success
          schema:
            type: array
            items:
              "$ref": "#/definitions/NodeID"
  "/bgp/peers":
    get:
      summary: Lists operational state of BGP peers
      description: |
        Retrieves current operational state of BGP peers created by
        Cilium BGP virtual router. This includes session state, uptime,
        information per address family, etc.
        Deprecated: This will be removed in the future.
      deprecated: true
      tags:
        - bgp
      responses:
        '200':
          description: Success
          schema:
            type: array
            items:
              "$ref": "#/definitions/BgpPeer"
        '500':
          description: Internal Server Error
          schema:
            "$ref": "#/definitions/Error"
        '501':
          description: BGP Control Plane disabled
          x-go-name: Disabled
          schema:
            "$ref": "#/definitions/Error"
  "/bgp/routes":
    get:
      summary: Lists BGP routes from BGP Control Plane RIB.
      description: |
        Retrieves routes from BGP Control Plane RIB filtered by parameters you specify.
        Deprecated: This will be removed in the future.
      deprecated: true
      tags:
        - bgp
      parameters:
        - "$ref": "#/parameters/bgp-table-type"
        - "$ref": "#/parameters/bgp-afi"
        - "$ref": "#/parameters/bgp-safi"
        - "$ref": "#/parameters/bgp-router-asn"
        - "$ref": "#/parameters/bgp-neighbor-address"
      responses:
        '200':
          description: Success
          schema:
            type: array
            items:
              "$ref": "#/definitions/BgpRoute"
        '500':
          description: Internal Server Error
          schema:
            "$ref": "#/definitions/Error"
        '501':
          description: BGP Control Plane disabled
          x-go-name: Disabled
          schema:
            "$ref": "#/definitions/Error"
  "/bgp/route-policies":
    get:
      summary: Lists BGP route policies configured in BGP Control Plane.
      description: |
        Retrieves route policies from BGP Control Plane.
        Deprecated: This will be removed in the future.
      deprecated: true
      tags:
        - bgp
      parameters:
        - "$ref": "#/parameters/bgp-router-asn"
      responses:
        '200':
          description: Success
          schema:
            type: array
            items:
              "$ref": "#/definitions/BgpRoutePolicy"
        '500':
          description: Internal Server Error
          schema:
            "$ref": "#/definitions/Error"
        '501':
          description: BGP Control Plane disabled
          x-go-name: Disabled
          schema:
            "$ref": "#/definitions/Error"
parameters:
  endpoint-id:
    name: id
    description: |
      String describing an endpoint with the format ``[prefix:]id``. If no prefix
      is specified, a prefix of ``cilium-local:`` is assumed. Not all endpoints
      will be addressable by all endpoint ID prefixes with the exception of the
      local Cilium UUID which is assigned to all endpoints.

      Supported endpoint id prefixes:
        - cilium-local: Local Cilium endpoint UUID, e.g. cilium-local:3389595
        - cilium-global: Global Cilium endpoint UUID, e.g. cilium-global:cluster1:nodeX:452343
        - cni-attachment-id: CNI attachment ID, e.g. cni-attachment-id:22222:eth0
        - cep-name: cep name for this container if K8s is enabled, e.g. pod-name:default:foobar-net1
    in: path
    required: true
    type: string
  endpoint-change-request:
    name: endpoint
    in: body
    required: true
    schema:
      "$ref": "#/definitions/EndpointChangeRequest"
  endpoint-batch-delete-request:
    name: endpoint
    in: body
    required: true
    schema:
      "$ref": "#/definitions/EndpointBatchDeleteRequest"
  identity-id:
    name: id
    description: |
      Cluster wide unique identifier of a security identity.
    in: path
    required: true
    type: string
  labels:
    name: labels
    description: |
      List of labels
    in: body
    required: false
    schema:
      "$ref": "#/definitions/Labels"
  policy-rules:
    name: policy
    description: Policy rules
    required: true
    in: body
    schema:
      type: string
  policy-replace:
    name: replace
    description: If true, indicates that existing rules with identical labels should be replaced.
    required: false
    in: query
    type: boolean
  policy-replace-with-labels:
    name: replace-with-labels
    description: If present, indicates that existing rules with the given labels should be deleted.
    required: false
    in: query
    type: array
    items:
      type: string
  pod-name:
    name: pod
    description: |
      K8s pod name
    required: true
    in: path
    type: string
  trace-selector:
    name: trace-selector
    description: Context to provide policy evaluation on
    in: body
    schema:
      "$ref": "#/definitions/TraceSelector"
  service-id:
    name: id
    description: ID of service
    required: true
    in: path
    type: integer
  service-address:
    name: address
    description: Service address configuration
    in: body
    schema:
      "$ref": "#/definitions/FrontendAddress"
  service-config:
    name: config
    description: Service configuration
    in: body
    required: true
    schema:
      "$ref": "#/definitions/ServiceSpec"
  prefilter-spec:
    name: prefilter-spec
    description: List of CIDR ranges for filter table
    required: true
    in: body
    schema:
      "$ref": "#/definitions/PrefilterSpec"
  ipam-ip:
    name: ip
    description: IP address
    in: path
    required: true
    type: string
  ipam-family:
    name: family
    in: query
    type: string
    enum:
    - ipv4
    - ipv6
  ipam-owner:
    name: owner
    in: query
    type: string
  ipam-pool:
    name: pool
    in: query
    type: string
  ipam-expiration:
    name: expiration
    in: header
    type: boolean
  map-name:
    name: name
    description: Name of map
    required: true
    in: path
    type: string
  follow:
    name: follow
    description: Whether to follow streamed requests
    required: false
    in: query
    type: boolean
  matchpattern:
    name: matchpattern
    description: A toFQDNs compatible matchPattern expression
    required: false
    in: query
    type: string
  cidr:
    name: cidr
    description: A CIDR range of IPs
    required: false
    in: query
    type: string
  source:
    name: source
    description: Source from which FQDN entries come from
    required: false
    in: query
    type: string
  bgp-table-type:
    name: table_type
    description: BGP Routing Information Base (RIB) table type
    required: true
    in: query
    type: string
    enum:
    - loc-rib
    - adj-rib-in
    - adj-rib-out
  bgp-afi:
    name: afi
    description: Address Family Indicator (AFI) of a BGP route
    required: true
    in: query
    type: string
  bgp-safi:
    name: safi
    description: Subsequent Address Family Indicator (SAFI) of a BGP route
    required: true
    in: query
    type: string
  bgp-router-asn:
    name: router_asn
    description: |
      Autonomous System Num

# --- truncated at 32 KB (114 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/isovalent/refs/heads/main/openapi/isovalent-cilium-agent-openapi.yml