{ "opencollection": "1.0.0", "info": { "name": "Cilium bgp endpoint API", "version": "v1beta1" }, "items": [ { "info": { "name": "endpoint", "type": "folder" }, "items": [ { "info": { "name": "Get endpoint by endpoint ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/endpoint/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "String describing an endpoint with the format ``[prefix:]id``. If no prefix\nis specified, a prefix of ``cilium-local:`` is assumed. Not all endpoints\nwill be addressable by all endpoint ID prefixes with the exception of the\nlocal Cilium UUID which is assigned to all endpoints.\n\nSupported endpoint id prefixes:\n - cilium-local: Local Cilium endpoint UUID, e.g. cilium-local:3389595\n - cilium-global: Global Cilium endpoint UUID, e.g. cilium-global:cluster1:nodeX:452343\n - cni-attachment-id: CNI attachment ID, e.g. cni-attachment-id:22222:eth0\n - cep-name: cep name for this container if K8s is enabled, e.g. pod-name:default:foobar-net1\n" } ] }, "docs": "Returns endpoint information\n" }, { "info": { "name": "Create endpoint", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/endpoint/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "String describing an endpoint with the format ``[prefix:]id``. If no prefix\nis specified, a prefix of ``cilium-local:`` is assumed. Not all endpoints\nwill be addressable by all endpoint ID prefixes with the exception of the\nlocal Cilium UUID which is assigned to all endpoints.\n\nSupported endpoint id prefixes:\n - cilium-local: Local Cilium endpoint UUID, e.g. cilium-local:3389595\n - cilium-global: Global Cilium endpoint UUID, e.g. cilium-global:cluster1:nodeX:452343\n - cni-attachment-id: CNI attachment ID, e.g. cni-attachment-id:22222:eth0\n - cep-name: cep name for this container if K8s is enabled, e.g. pod-name:default:foobar-net1\n" } ] }, "docs": "Creates a new endpoint\n" }, { "info": { "name": "Modify existing endpoint", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/endpoint/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "String describing an endpoint with the format ``[prefix:]id``. If no prefix\nis specified, a prefix of ``cilium-local:`` is assumed. Not all endpoints\nwill be addressable by all endpoint ID prefixes with the exception of the\nlocal Cilium UUID which is assigned to all endpoints.\n\nSupported endpoint id prefixes:\n - cilium-local: Local Cilium endpoint UUID, e.g. cilium-local:3389595\n - cilium-global: Global Cilium endpoint UUID, e.g. cilium-global:cluster1:nodeX:452343\n - cni-attachment-id: CNI attachment ID, e.g. cni-attachment-id:22222:eth0\n - cep-name: cep name for this container if K8s is enabled, e.g. pod-name:default:foobar-net1\n" } ] }, "docs": "Applies the endpoint change request to an existing endpoint\n" }, { "info": { "name": "Delete endpoint", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/endpoint/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "String describing an endpoint with the format ``[prefix:]id``. If no prefix\nis specified, a prefix of ``cilium-local:`` is assumed. Not all endpoints\nwill be addressable by all endpoint ID prefixes with the exception of the\nlocal Cilium UUID which is assigned to all endpoints.\n\nSupported endpoint id prefixes:\n - cilium-local: Local Cilium endpoint UUID, e.g. cilium-local:3389595\n - cilium-global: Global Cilium endpoint UUID, e.g. cilium-global:cluster1:nodeX:452343\n - cni-attachment-id: CNI attachment ID, e.g. cni-attachment-id:22222:eth0\n - cep-name: cep name for this container if K8s is enabled, e.g. pod-name:default:foobar-net1\n" } ] }, "docs": "Deletes the endpoint specified by the ID. Deletion is imminent and\natomic, if the deletion request is valid and the endpoint exists,\ndeletion will occur even if errors are encountered in the process. If\nerrors have been encountered, the code 202 will be returned, otherwise\n200 on success.\n\nAll resources associated with the endpoint will be freed and the\nworkload represented by the endpoint will be disconnected.It will no\nlonger be able to initiate or receive communications of any sort.\n" }, { "info": { "name": "Retrieves a list of endpoints that have metadata matching the provided parameters.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/endpoint" }, "docs": "Retrieves a list of endpoints that have metadata matching the provided parameters, or all endpoints if no parameters provided.\n" }, { "info": { "name": "Deletes a list of endpoints", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/endpoint" }, "docs": "Deletes a list of endpoints that have endpoints matching the provided properties\n" }, { "info": { "name": "Retrieve endpoint configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/endpoint/:id/config", "params": [ { "name": "id", "value": "", "type": "path", "description": "String describing an endpoint with the format ``[prefix:]id``. If no prefix\nis specified, a prefix of ``cilium-local:`` is assumed. Not all endpoints\nwill be addressable by all endpoint ID prefixes with the exception of the\nlocal Cilium UUID which is assigned to all endpoints.\n\nSupported endpoint id prefixes:\n - cilium-local: Local Cilium endpoint UUID, e.g. cilium-local:3389595\n - cilium-global: Global Cilium endpoint UUID, e.g. cilium-global:cluster1:nodeX:452343\n - cni-attachment-id: CNI attachment ID, e.g. cni-attachment-id:22222:eth0\n - cep-name: cep name for this container if K8s is enabled, e.g. pod-name:default:foobar-net1\n" } ] }, "docs": "Retrieves the configuration of the specified endpoint.\n" }, { "info": { "name": "Modify mutable endpoint configuration", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/endpoint/:id/config", "params": [ { "name": "id", "value": "", "type": "path", "description": "String describing an endpoint with the format ``[prefix:]id``. If no prefix\nis specified, a prefix of ``cilium-local:`` is assumed. Not all endpoints\nwill be addressable by all endpoint ID prefixes with the exception of the\nlocal Cilium UUID which is assigned to all endpoints.\n\nSupported endpoint id prefixes:\n - cilium-local: Local Cilium endpoint UUID, e.g. cilium-local:3389595\n - cilium-global: Global Cilium endpoint UUID, e.g. cilium-global:cluster1:nodeX:452343\n - cni-attachment-id: CNI attachment ID, e.g. cni-attachment-id:22222:eth0\n - cep-name: cep name for this container if K8s is enabled, e.g. pod-name:default:foobar-net1\n" } ] }, "docs": "Update the configuration of an existing endpoint and regenerates &\nrecompiles the corresponding programs automatically.\n" }, { "info": { "name": "Retrieves the list of labels associated with an endpoint.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/endpoint/:id/labels", "params": [ { "name": "id", "value": "", "type": "path", "description": "String describing an endpoint with the format ``[prefix:]id``. If no prefix\nis specified, a prefix of ``cilium-local:`` is assumed. Not all endpoints\nwill be addressable by all endpoint ID prefixes with the exception of the\nlocal Cilium UUID which is assigned to all endpoints.\n\nSupported endpoint id prefixes:\n - cilium-local: Local Cilium endpoint UUID, e.g. cilium-local:3389595\n - cilium-global: Global Cilium endpoint UUID, e.g. cilium-global:cluster1:nodeX:452343\n - cni-attachment-id: CNI attachment ID, e.g. cni-attachment-id:22222:eth0\n - cep-name: cep name for this container if K8s is enabled, e.g. pod-name:default:foobar-net1\n" } ] }, "docs": "Retrieves the list of labels associated with an endpoint." }, { "info": { "name": "Set label configuration of endpoint", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/endpoint/:id/labels", "params": [ { "name": "id", "value": "", "type": "path", "description": "String describing an endpoint with the format ``[prefix:]id``. If no prefix\nis specified, a prefix of ``cilium-local:`` is assumed. Not all endpoints\nwill be addressable by all endpoint ID prefixes with the exception of the\nlocal Cilium UUID which is assigned to all endpoints.\n\nSupported endpoint id prefixes:\n - cilium-local: Local Cilium endpoint UUID, e.g. cilium-local:3389595\n - cilium-global: Global Cilium endpoint UUID, e.g. cilium-global:cluster1:nodeX:452343\n - cni-attachment-id: CNI attachment ID, e.g. cni-attachment-id:22222:eth0\n - cep-name: cep name for this container if K8s is enabled, e.g. pod-name:default:foobar-net1\n" } ] }, "docs": "Sets labels associated with an endpoint. These can be user provided or\nderived from the orchestration system.\n" }, { "info": { "name": "Retrieves the status logs associated with this endpoint.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/endpoint/:id/log", "params": [ { "name": "id", "value": "", "type": "path", "description": "String describing an endpoint with the format ``[prefix:]id``. If no prefix\nis specified, a prefix of ``cilium-local:`` is assumed. Not all endpoints\nwill be addressable by all endpoint ID prefixes with the exception of the\nlocal Cilium UUID which is assigned to all endpoints.\n\nSupported endpoint id prefixes:\n - cilium-local: Local Cilium endpoint UUID, e.g. cilium-local:3389595\n - cilium-global: Global Cilium endpoint UUID, e.g. cilium-global:cluster1:nodeX:452343\n - cni-attachment-id: CNI attachment ID, e.g. cni-attachment-id:22222:eth0\n - cep-name: cep name for this container if K8s is enabled, e.g. pod-name:default:foobar-net1\n" } ] }, "docs": "Retrieves the status logs associated with this endpoint." }, { "info": { "name": "Retrieves the status logs associated with this endpoint.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/endpoint/:id/healthz", "params": [ { "name": "id", "value": "", "type": "path", "description": "String describing an endpoint with the format ``[prefix:]id``. If no prefix\nis specified, a prefix of ``cilium-local:`` is assumed. Not all endpoints\nwill be addressable by all endpoint ID prefixes with the exception of the\nlocal Cilium UUID which is assigned to all endpoints.\n\nSupported endpoint id prefixes:\n - cilium-local: Local Cilium endpoint UUID, e.g. cilium-local:3389595\n - cilium-global: Global Cilium endpoint UUID, e.g. cilium-global:cluster1:nodeX:452343\n - cni-attachment-id: CNI attachment ID, e.g. cni-attachment-id:22222:eth0\n - cep-name: cep name for this container if K8s is enabled, e.g. pod-name:default:foobar-net1\n" } ] }, "docs": "Retrieves the status logs associated with this endpoint." } ] } ], "bundled": true }