Mutations

Overview

GraphQL mutations are used to create, update, or delete data through the Meter API. Like queries, you specify exactly which fields you want returned after the mutation completes.

Every mutation listed below accepts typed arguments and returns a typed response. For example, actionCaptivePortalEntry accepts a action and entryUUID argument and returns a CaptivePortalEntry with only the fields you select. Arguments marked with ! are required.

actionCaptivePortalEntry

Performs an action on a captive portal entry. Returns: CaptivePortalEntry!

actionCaptivePortalEntry(
  action: CaptivePortalEntryAction!
  entryUUID: UUID!
): CaptivePortalEntry!
ArgumentTypeDescription
actionCaptivePortalEntryAction!The action to perform on the captive portal entry.
entryUUIDUUID!The UUID of the captive portal entry to act on.

createClientVPNClient

Creates a Client VPN client on a Client VPN server. Returns: ClientVPNClient!

createClientVPNClient(
  input: CreateClientVPNClientInput!
  serverUUID: UUID!
): ClientVPNClient!
ArgumentTypeDescription
inputCreateClientVPNClientInput!Input parameters for creating a Client VPN client.
serverUUIDUUID!Unique identifier of the Client VPN server on which to create the client.

createSSID

Create an SSID for a network. Returns: SSID!

createSSID(
  input: CreateSSIDInput!
  networkUUID: UUID!
): SSID!
ArgumentTypeDescription
inputCreateSSIDInput!Input fields for creating the SSID.
networkUUIDUUID!UUID of the network where the SSID will be created.

createVLAN

Create a new VLAN. Returns: VLAN!

createVLAN(
  input: CreateVLANInput!
  networkUUID: UUID!
): VLAN!
ArgumentTypeDescription
inputCreateVLANInput!The input data for creating the VLAN.
networkUUIDUUID!The UUID of the network where the VLAN will be created.

deleteSSID

Delete an SSID. Returns: SSID!

deleteSSID(
  uuid: UUID!
): SSID!
ArgumentTypeDescription
uuidUUID!UUID of the SSID to delete.

deleteVLAN

Delete a VLAN. Returns: Boolean!

deleteVLAN(
  UUID: UUID!
): Boolean!
ArgumentTypeDescription
UUIDUUID!The UUID of the VLAN to delete.

updateSSID

Update an SSID. Returns: SSID!

updateSSID(
  input: UpdateSSIDInput!
  uuid: UUID!
): SSID!
ArgumentTypeDescription
inputUpdateSSIDInput!Input fields for updating the SSID.
uuidUUID!UUID of the SSID to update.

updateVLAN

Update an existing VLAN. Returns: VLAN!

updateVLAN(
  UUID: UUID!
  input: UpdateVLANInput!
): VLAN!
ArgumentTypeDescription
UUIDUUID!The UUID of the VLAN to update.
inputUpdateVLANInput!The input data for updating the VLAN.

Need help?

If you run into any issues or have questions, please reach out to our Support Engineering team by opening a ticket via the Dashboard: https://dashboard.meter.com/support

Was this helpful?