How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
NetBird

NetBird Ingress Ports API

Interact with and view information about the ingress peers and ports.

Documentation Provider Profile APIs.io OpenAPI GitHub

NetBird Ingress Ports API is one of 39 APIs that NetBird publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Ingress Ports. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 10 operations across 4 paths, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version 0.0.1.

Requests are made against a single base URL, https://api.netbird.io.

10 operations 4 paths 9 schemas 2 DELETE4 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.0.1
Base URL
https://api.netbird.io
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

NetBird Ingress Ports API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). An API key is passed in the header as Authorization (TokenAuth). By default, every request must be authenticated.

  • TokenAuth — Enter the token with the Token prefix, e.g. "Token nbpF3f0d.....".

Paths & Operations 10

Across 4 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Ingress Ports 10

Interact with and view information about the ingress peers and ports.

GET
/api/peers/{peerId}/ingress/ports
List all Port Allocations
2 params → 200400401403500
POST
/api/peers/{peerId}/ingress/ports
Create a Port Allocation
1 param body → 200400401403500
GET
/api/peers/{peerId}/ingress/ports/{allocationId}
Retrieve a Port Allocation
2 params → 200400401403500
PUT
/api/peers/{peerId}/ingress/ports/{allocationId}
Update a Port Allocation
2 params body → 200400401403500
DELETE
/api/peers/{peerId}/ingress/ports/{allocationId}
Delete a Port Allocation
2 params → 200400401403500
GET
/api/ingress/peers
List all Ingress Peers
→ 200400401403500
POST
/api/ingress/peers
Create a Ingress Peer
body → 200400401403500
GET
/api/ingress/peers/{ingressPeerId}
Retrieve a Ingress Peer
1 param → 200400401403500
PUT
/api/ingress/peers/{ingressPeerId}
Update a Ingress Peer
1 param body → 200400401403500
DELETE
/api/ingress/peers/{ingressPeerId}
Delete a Ingress Peer
1 param → 200400401403500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are IngressPeer (8 properties), IngressPortAllocation (7 properties), IngressPortAllocationPortMapping (5 properties), IngressPortAllocationRequest (4 properties). Each schema is shown below with its type and property counts.

IngressPortAllocationRequestDirectPort
object
2 properties 2 required
IngressPortAllocationRequestPortRange
object
3 properties 3 required
AvailablePorts
object
2 properties 2 required
IngressPeer
object
8 properties 8 required
IngressPortAllocation
object
7 properties 7 required
IngressPortAllocationRequest
object
4 properties 2 required
IngressPeerCreateRequest
object
3 properties 3 required
IngressPortAllocationPortMapping
object
5 properties 5 required
IngressPeerUpdateRequest
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netbird-ingress-ports-api-openapi.yml Raw ↑

Other APIs NetBird publishes across the network.

NetBird Accounts API
AE Profile APIs.io
NetBird AWS Marketplace API
AE Profile APIs.io
NetBird Checkout API
AE Profile APIs.io
NetBird DNS API
AE Profile APIs.io
NetBird DNS Zones API
AE Profile APIs.io
NetBird EDR Falcon Integrations API
AE Profile APIs.io
NetBird EDR FleetDM Integrations API
AE Profile APIs.io
NetBird EDR Huntress Integrations API
AE Profile APIs.io
NetBird EDR Intune Integrations API
AE Profile APIs.io
NetBird EDR Peers API
AE Profile APIs.io
NetBird EDR SentinelOne Integrations API
AE Profile APIs.io
NetBird Event Streaming Integrations API
AE Profile APIs.io
#Ingress Ports
← Back to N APIs
API Details
ID
netbird:netbird-ingress-ports-api
Base URL
https://api.netbird.io
Docs
https://docs.netbird.io/
Provider
NetBird
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=netbird-ingress-ports-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/netbird-ingress-ports-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of NetBird Ingress Ports API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.