Ctrlk
APIGitHubYouTubeCommunityWebsite
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Egress

List Egress Resources

get
Authorizations
Query parameters
networkstringRequired

Network identifier

Responses
200

OK

application/json
created_atstringOptional
created_bystringOptional
descriptionstringOptional
domainstringOptional
domain_ansstring[]Optional
idstringOptional
modestring · enumOptionalPossible values:
namestringOptional
natbooleanOptional
networkstringOptional
rangestringOptional
statusbooleanOptional

IsInetGw bool gorm:"is_inet_gw" json:"is_internet_gateway"

updated_atstringOptional
virtual_rangestringOptional
get/api/v1/egress
GET /api/v1/egress?network=text HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

[
  {
    "created_at": "text",
    "created_by": "text",
    "description": "text",
    "domain": "text",
    "domain_ans": [
      "text"
    ],
    "id": "text",
    "mode": "virtual_nat",
    "name": "text",
    "nat": true,
    "network": "text",
    "nodes": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "range": "text",
    "status": true,
    "tags": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "updated_at": "text",
    "virtual_range": "text"
  }
]

Create Egress Resource

post
Authorizations
Body
descriptionstringOptional
domainstringOptional
idstringOptional
is_internet_gatewaybooleanOptional
modestring · enumOptionalPossible values:
namestringOptional
natbooleanOptional
networkstringOptional
rangestringOptional
statusbooleanOptional
Responses
200

OK

application/json
created_atstringOptional
created_bystringOptional
descriptionstringOptional
domainstringOptional
domain_ansstring[]Optional
idstringOptional
modestring · enumOptionalPossible values:
namestringOptional
natbooleanOptional
networkstringOptional
rangestringOptional
statusbooleanOptional

IsInetGw bool gorm:"is_inet_gw" json:"is_internet_gateway"

updated_atstringOptional
virtual_rangestringOptional
post/api/v1/egress
POST /api/v1/egress HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 244

{
  "description": "text",
  "domain": "text",
  "id": "text",
  "is_internet_gateway": true,
  "mode": "virtual_nat",
  "name": "text",
  "nat": true,
  "network": "text",
  "nodes": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "range": "text",
  "status": true,
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": 1
  }
}
{
  "created_at": "text",
  "created_by": "text",
  "description": "text",
  "domain": "text",
  "domain_ans": [
    "text"
  ],
  "id": "text",
  "mode": "virtual_nat",
  "name": "text",
  "nat": true,
  "network": "text",
  "nodes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "range": "text",
  "status": true,
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "updated_at": "text",
  "virtual_range": "text"
}

Update Egress Resource

put
Authorizations
Body
descriptionstringOptional
domainstringOptional
idstringOptional
is_internet_gatewaybooleanOptional
modestring · enumOptionalPossible values:
namestringOptional
natbooleanOptional
networkstringOptional
rangestringOptional
statusbooleanOptional
Responses
200

OK

application/json
created_atstringOptional
created_bystringOptional
descriptionstringOptional
domainstringOptional
domain_ansstring[]Optional
idstringOptional
modestring · enumOptionalPossible values:
namestringOptional
natbooleanOptional
networkstringOptional
rangestringOptional
statusbooleanOptional

IsInetGw bool gorm:"is_inet_gw" json:"is_internet_gateway"

updated_atstringOptional
virtual_rangestringOptional
put/api/v1/egress
PUT /api/v1/egress HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 244

{
  "description": "text",
  "domain": "text",
  "id": "text",
  "is_internet_gateway": true,
  "mode": "virtual_nat",
  "name": "text",
  "nat": true,
  "network": "text",
  "nodes": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "range": "text",
  "status": true,
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": 1
  }
}
{
  "created_at": "text",
  "created_by": "text",
  "description": "text",
  "domain": "text",
  "domain_ans": [
    "text"
  ],
  "id": "text",
  "mode": "virtual_nat",
  "name": "text",
  "nat": true,
  "network": "text",
  "nodes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "range": "text",
  "status": true,
  "tags": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "updated_at": "text",
  "virtual_range": "text"
}

Delete Egress Resource

delete
Authorizations
Query parameters
idstringRequired

Egress resource ID

Responses
200

OK

application/json
codeintegerOptional
messagestringOptional
responseanyOptional
delete/api/v1/egress
DELETE /api/v1/egress?id=text HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*

{
  "code": 1,
  "message": "text",
  "response": null
}
PreviousActivity
NextEnrollment Keys

Last updated

Was this helpful?