Networking and ingress¶
Generated from the gateway schema. Do not edit.
Queries¶
externalService¶
query { externalService(id: ID!): ExternalService! }
Requires: an authenticated member of the tenant
| Argument | Type | Description |
|---|---|---|
id |
ID! |
Returns: ExternalService!
externalServices¶
query { externalServices(list: List): ExternalServiceListResult! }
Requires: platform USER
| Argument | Type | Description |
|---|---|---|
list |
List |
Returns: ExternalServiceListResult!
ingressByCluster¶
query { ingressByCluster(clusterId: ID!, name: String!, namespace: String): Ingress }
Requires: an authenticated member of the tenant
| Argument | Type | Description |
|---|---|---|
clusterId |
ID! |
|
name |
String! |
|
namespace |
String |
Returns: Ingress
ingressRoute¶
query { ingressRoute(id: ID!): IngressRoute! }
Requires: an authenticated member of the tenant
| Argument | Type | Description |
|---|---|---|
id |
ID! |
Returns: IngressRoute!
ingressRoutes¶
query { ingressRoutes(list: List): IngressRouteListResult! }
Requires: platform USER
| Argument | Type | Description |
|---|---|---|
list |
List |
Returns: IngressRouteListResult!
ingressesByCluster¶
query { ingressesByCluster(clusterId: ID!, namespace: String): IngressListResult! }
Requires: an authenticated member of the tenant
| Argument | Type | Description |
|---|---|---|
clusterId |
ID! |
|
namespace |
String |
Returns: IngressListResult!
networkInterface¶
query { networkInterface(id: ID!): NetworkInterface! }
Requires: an authenticated member of the tenant
| Argument | Type | Description |
|---|---|---|
id |
ID! |
Returns: NetworkInterface!
networkInterfaces¶
query { networkInterfaces(list: List, id: ID!): NetworkInterfaceListResult! }
Requires: platform ADMIN
| Argument | Type | Description |
|---|---|---|
list |
List |
|
id |
ID! |
Returns: NetworkInterfaceListResult!
subnets¶
query { subnets(vnetId: String!): [Subnet!]! }
Requires: an authenticated member of the tenant
| Argument | Type | Description |
|---|---|---|
vnetId |
String! |
Returns: [Subnet!]!
traefikMiddleware¶
query { traefikMiddleware(id: ID!): TraefikMiddleware! }
Requires: an authenticated member of the tenant
| Argument | Type | Description |
|---|---|---|
id |
ID! |
Returns: TraefikMiddleware!
traefikMiddlewares¶
query { traefikMiddlewares(list: List): TraefikMiddlewareListResult! }
Requires: platform USER
| Argument | Type | Description |
|---|---|---|
list |
List |
Returns: TraefikMiddlewareListResult!
vnet¶
query { vnet(id: ID!): Vnet! }
Requires: platform ADMIN
| Argument | Type | Description |
|---|---|---|
id |
ID! |
Returns: Vnet!
vnets¶
query { vnets(list: List): VnetListResult! }
Requires: platform ADMIN
| Argument | Type | Description |
|---|---|---|
list |
List |
Returns: VnetListResult!
zone¶
query { zone(id: ID!): Zone! }
Requires: platform ADMIN
| Argument | Type | Description |
|---|---|---|
id |
ID! |
Returns: Zone!
zones¶
query { zones(list: List): ZoneListResult! }
Requires: platform ADMIN
| Argument | Type | Description |
|---|---|---|
list |
List |
Returns: ZoneListResult!
Mutations¶
createExternalService¶
mutation { createExternalService(input: CreateExternalServiceInput!): ExternalService! }
Requires: tenant EDITOR
| Argument | Type | Description |
|---|---|---|
input |
CreateExternalServiceInput! |
Returns: ExternalService!
createIngressRoute¶
mutation { createIngressRoute(input: CreateIngressRouteInput!): IngressRoute! }
Requires: tenant EDITOR
| Argument | Type | Description |
|---|---|---|
input |
CreateIngressRouteInput! |
Returns: IngressRoute!
createSubnet¶
mutation { createSubnet(vnetId: String!, input: CreateSubnetInput!): Subnet! }
Requires: tenant EDITOR
| Argument | Type | Description |
|---|---|---|
vnetId |
String! |
|
input |
CreateSubnetInput! |
Returns: Subnet!
createTraefikMiddleware¶
mutation { createTraefikMiddleware(input: CreateTraefikMiddlewareInput!): TraefikMiddleware! }
Requires: tenant EDITOR
| Argument | Type | Description |
|---|---|---|
input |
CreateTraefikMiddlewareInput! |
Returns: TraefikMiddleware!
createVnet¶
mutation { createVnet(input: CreateVnetInput!): Vnet! }
Requires: platform ADMIN
| Argument | Type | Description |
|---|---|---|
input |
CreateVnetInput! |
Returns: Vnet!
createVpc¶
Creates a Proxmox SDN zone+vnet+subnet with the platform admin token. Tenant VPCs are provisioned at tenant creation; this is an operator tool.
mutation { createVpc(name: String!, cidr: String!): VPC! }
Requires: platform ADMIN
| Argument | Type | Description |
|---|---|---|
name |
String! |
|
cidr |
String! |
Returns: VPC!
createZone¶
mutation { createZone(input: CreateZoneInput!): Zone! }
Requires: platform ADMIN
| Argument | Type | Description |
|---|---|---|
input |
CreateZoneInput! |
Returns: Zone!
deleteExternalService¶
mutation { deleteExternalService(id: ID!): Boolean! }
Requires: tenant EDITOR
| Argument | Type | Description |
|---|---|---|
id |
ID! |
Returns: Boolean!
deleteIngressRoute¶
mutation { deleteIngressRoute(id: ID!): Boolean! }
Requires: tenant EDITOR
| Argument | Type | Description |
|---|---|---|
id |
ID! |
Returns: Boolean!
deleteSubnet¶
mutation { deleteSubnet(vnetId: String!, id: ID!): Boolean! }
Requires: tenant EDITOR
| Argument | Type | Description |
|---|---|---|
vnetId |
String! |
|
id |
ID! |
Returns: Boolean!
deleteTraefikMiddleware¶
mutation { deleteTraefikMiddleware(id: ID!): Boolean! }
Requires: tenant EDITOR
| Argument | Type | Description |
|---|---|---|
id |
ID! |
Returns: Boolean!
deleteVnet¶
mutation { deleteVnet(id: ID!): Boolean! }
Requires: platform ADMIN
| Argument | Type | Description |
|---|---|---|
id |
ID! |
Returns: Boolean!
deleteZone¶
mutation { deleteZone(id: ID!): Boolean! }
Requires: platform ADMIN
| Argument | Type | Description |
|---|---|---|
id |
ID! |
Returns: Boolean!
updateSubnet¶
mutation { updateSubnet(vnetId: String!, id: ID!, input: UpdateSubnetInput!): Subnet! }
Requires: tenant EDITOR
| Argument | Type | Description |
|---|---|---|
vnetId |
String! |
|
id |
ID! |
|
input |
UpdateSubnetInput! |
Returns: Subnet!
updateVnet¶
mutation { updateVnet(input: UpdateVnetInput!, id: ID!): Vnet! }
Requires: platform ADMIN
| Argument | Type | Description |
|---|---|---|
input |
UpdateVnetInput! |
|
id |
ID! |
Returns: Vnet!
updateZone¶
mutation { updateZone(input: UpdateZoneInput!, id: ID!): Zone! }
Requires: platform ADMIN
| Argument | Type | Description |
|---|---|---|
input |
UpdateZoneInput! |
|
id |
ID! |
Returns: Zone!