The Interface group API from Weka — 10 operation(s) for interface group.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/weka:weka-interface-group-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: '@weka-api Interface group API'
version: '5.1'
description: 'The WEKA system provides a RESTful API, enabling efficient
automation and integration into existing workflows or monitoring systems.'
servers:
- url: /api/v2
security:
- bearerAuth: []
tags:
- name: Interface group
paths:
/interfaceGroups:
get:
tags:
- Interface group
summary: Get interface groups
description: Returns a list of all interface groups that manage floating IPs for NFS server resiliency.
operationId: getInterfaceGroups
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/interfaceGroup'
'401':
$ref: '#/components/responses/401'
post:
tags:
- Interface group
summary: Create an interface group
description: 'Creates an interface group to manage floating IPs for NFS resiliency.
An interface group defines a collection of servers, network ports, and
floating IPs that work together to ensure continuous service.'
operationId: createInterfaceGroup
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/interfaceGroup'
'401':
$ref: '#/components/responses/401'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- name
- type
properties:
name:
type: string
description: A unique name for the interface group.
example: default
type:
type: string
description: The group type. Can only be `NFS`.
example: nfs
subnet:
type: string
description: The subnet mask in the `255.255.0.0` format.
example: 255.0.0.0
gateway:
type: string
description: The gateway IP address.
example: 172.31.0.0
/interfaceGroups/{uid}:
get:
tags:
- Interface group
summary: Get interface group details
description: Returns the details of a specific interface group, including its assigned servers, ports, and floating IP ranges.
operationId: getInterfaceGroup
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/interfaceGroup'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
parameters:
- in: path
name: uid
required: true
schema:
type: string
description: The unique identifier of the interface group.
delete:
tags:
- Interface group
summary: Delete an interface group
description: Removes an interface group, including its collection of servers, ports, and floating IPs.
operationId: deleteInterfaceGroup
responses:
'200':
$ref: '#/components/responses/200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
parameters:
- in: path
name: uid
required: true
schema:
type: string
description: The unique identifier of the interface group.
put:
tags:
- Interface group
summary: Update an interface group
description: Modifies the gateway and subnet of an existing interface group.
operationId: updateInterfaceGroup
parameters:
- in: path
name: uid
required: true
schema:
type: string
description: The unique identifier of the interface group.
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/interfaceGroup'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
subnet:
type: string
description: The subnet mask in the `255.255.0.0` format.
example: 255.0.0.0
gateway:
type: string
description: The gateway IP address.
example: 172.31.0.0
/interfaceGroups/{uid}/ips:
post:
tags:
- Interface group
summary: Add IP range to interface group
description: 'Adds a range of floating IP addresses to an interface group.
These IPs can migrate between servers in the group to maintain service availability.'
operationId: crateInterfaceGroupIp
parameters:
- in: path
name: uid
required: true
schema:
type: string
description: The unique identifier of the interface group.
responses:
'200':
$ref: '#/components/responses/200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- ips
properties:
ips:
type: string
description: An IP range, such as `10.0.0.10-20`.
example: 10.222.8.19
/interfaceGroups/{uid}/ports/{host_uid}:
post:
deprecated: true
tags:
- Interface group
summary: Add port to interface group - deprecated, use POST…
operationId: addPortToInterfaceGroupDeprecated
parameters:
- in: path
name: uid
required: true
schema:
type: string
description: Interface group uid.
- in: path
name: host_uid
required: true
schema:
type: string
description: Host uid.
responses:
'200':
$ref: '#/components/responses/200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- port
properties:
port:
type: string
description: Port's device. (e.g. eth1).
example: eth0
/interfaceGroups/{uid}/ports/{container_uid}:
post:
tags:
- Interface group
summary: Add a port to an interface group
description: 'Assigns a network port from a specific container to an interface group,
making that container a potential host for the group''s floating IPs.'
operationId: addPortToInterfaceGroup
parameters:
- in: path
name: uid
required: true
schema:
type: string
description: The unique identifier of the interface group.
- in: path
name: container_uid
required: true
schema:
type: string
description: The unique identifier of the container.
responses:
'200':
$ref: '#/components/responses/200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- port
properties:
port:
type: string
description: The port's device name, for example, `eth1`.
example: eth0
/interfaceGroups/{uid}/ports/{host_uid}/{port}:
delete:
deprecated: true
tags:
- Interface group
summary: Delete port from interface group - deprecated, use DELETE…
operationId: deletePortFromInterfaceGroupDeprecated
parameters:
- in: path
name: uid
required: true
schema:
type: string
description: Interface group uid.
- in: path
name: host_uid
required: true
schema:
type: string
description: Host uid.
- in: path
name: port
required: true
schema:
type: string
example: eth0
description: Host:Port to delete from Interface Group.
responses:
'200':
$ref: '#/components/responses/200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
/interfaceGroups/{uid}/ports/{container_uid}/{port}:
delete:
tags:
- Interface group
summary: Remove a port from an interface group
description: Removes a container's network port from an interface group, preventing it from hosting the group's floating IPs.
operationId: deletePortFromInterfaceGroup
parameters:
- in: path
name: uid
required: true
schema:
type: string
description: The unique identifier of the interface group.
- in: path
name: container_uid
required: true
schema:
type: string
description: The unique identifier of the container.
- in: path
name: port
required: true
schema:
type: string
example: eth0
description: The port to remove from the interface group.
responses:
'200':
$ref: '#/components/responses/200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
/interfaceGroups/{uid}/ips/{ips}:
delete:
tags:
- Interface group
summary: Remove an IP range from an interface group
description: Removes a floating IP address range from an interface group.
operationId: deleteIpRangeFromInterfaceGroup
parameters:
- in: path
name: uid
required: true
schema:
type: string
description: The unique identifier of the interface group.
- in: path
name: ips
required: true
schema:
type: string
example: 172.31.5.5
description: The IP or IP range to remove.
responses:
'200':
$ref: '#/components/responses/200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
/interfaceGroups/listAssignment:
get:
tags:
- Interface group
summary: Get floating IP assignments
description: Returns a list of all floating IPs and shows which container and port in the interface group currently host each IP.
operationId: getInterfaceGroupsListAssignment
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
uid:
type: string
example: 5356a13f-3f0e-8d63-04a8-ba5e5df601b0
group:
type: string
example: DefaultInterfaceGroup
ip:
type: string
example: 10.222.0.1
host_id:
type: string
example: HostId<0>
port:
type: string
example: eth0
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
/interfaceGroups/port:
post:
tags:
- Interface group
summary: Add a port to an interface group
description: 'Assigns a network port from a specific server to an interface group,
making that server a potential host for the group''s floating IPs.'
operationId: interfaceGroupAddPort
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- uid
- host_uid
- port
properties:
uid:
type: string
description: The unique identifier of the interface group.
host_uid:
type: string
description: The unique identifier of the interface group.
port:
type: string
example: eth0
responses:
'200':
$ref: '#/components/responses/200'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
components:
responses:
'400':
description: Bad Request
content:
application/json:
schema:
properties:
message:
type: string
example: error message
data:
type: object
properties:
missing_params:
type: array
items:
type: string
example: param1
param:
type: string
example: param2
error:
type: string
example: param2 has an error
'401':
description: Unauthorized
content:
application/json:
schema:
properties:
data:
type: string
example: Unauthorized
'200':
description: Success
content:
application/json:
schema:
properties:
data:
example: null
'404':
description: Not Found
content:
application/json:
schema:
properties:
message:
type: string
example: error message
schemas:
interfaceGroup:
type: object
properties:
subnet_mask:
type: string
example: 255.0.0.0
ports:
type: array
items:
type: object
properties:
host_uid:
type: string
example: uid_string
host_id:
type: string
example: HostId<0>
port:
type: string
example: eth0
status:
type: string
example: OK
name:
type: string
example: DefaultInterfaceGroup
uid:
type: string
example: uid_string
ips:
type: array
items:
type: string
example: 168.32.0.0
allow_manage_gids:
type: boolean
example: false
type:
type: string
example: NFS
gateway:
type: string
example: 172.31.0.0
status:
type: string
example: OK
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT