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!

Argument	Type	Description
`action`	CaptivePortalEntryAction!	The action to perform on the captive portal entry.
`entryUUID`	UUID!	The UUID of the captive portal entry to act on.

createApplicationDNSFirewallRule

Creates a new application DNS firewall rule for a DHCP rule. Returns: ApplicationDNSFirewallRule!

createApplicationDNSFirewallRule(
  dhcpRuleUUID: UUID
  input: CreateApplicationDNSFirewallRuleInput!
  networkUUID: UUID
): ApplicationDNSFirewallRule!

Argument	Type	Description
`dhcpRuleUUID`	UUID	The UUID of the DHCP rule to associate with the new DNS firewall rule.
`input`	CreateApplicationDNSFirewallRuleInput!	The input data for creating the DNS firewall rule.
`networkUUID`	UUID	The UUID of the network to associate with the new DNS firewall rule.

createClientVPNClient

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

createClientVPNClient(
  input: CreateClientVPNClientInput!
  serverUUID: UUID!
): ClientVPNClient!

Argument	Type	Description
`input`	CreateClientVPNClientInput!	Input parameters for creating a Client VPN client.
`serverUUID`	UUID!	Unique identifier of the Client VPN server on which to create the client.

createFirewallRule

Create a new firewall rule. Returns: FirewallRule!

createFirewallRule(
  input: CreateFirewallRuleInput!
  networkUUID: UUID!
): FirewallRule!

Argument	Type	Description
`input`	CreateFirewallRuleInput!	Input data for creating the firewall rule.
`networkUUID`	UUID!	UUID of the network where the firewall rule will be created.

createIDSIPSConfig

Creates a IDS IPS config for a network. There can be a single config for the network. No-op if one already exists. Returns: IDSIPSConfig!

createIDSIPSConfig(
  input: CreateIDSIPSConfigInput!
  networkUUID: UUID!
): IDSIPSConfig!

Argument	Type	Description
`input`	CreateIDSIPSConfigInput!	Input parameters to create IDS IPS config.
`networkUUID`	UUID!	UUID of the network to create the config for.

createIDSIPSCustomRule

Create a custom rule for an IDS configuration. Returns: IDSIPSCustomRule!

createIDSIPSCustomRule(
  idsIPSConfigUUID: UUID!
  input: CreateIDSIPSCustomRuleInput!
): IDSIPSCustomRule!

Argument	Type	Description
`idsIPSConfigUUID`	UUID!	Unique identifier of the IDS/IPS configuration.
`input`	CreateIDSIPSCustomRuleInput!	Input type.

createSSID

Create an SSID for a network. Returns: SSID!

createSSID(
  input: CreateSSIDInput!
  networkUUID: UUID!
): SSID!

Argument	Type	Description
`input`	CreateSSIDInput!	Input fields for creating the SSID.
`networkUUID`	UUID!	UUID of the network where the SSID will be created.

createVLAN

Create a new VLAN. Returns: VLAN!

createVLAN(
  input: CreateVLANInput!
  networkUUID: UUID!
): VLAN!

Argument	Type	Description
`input`	CreateVLANInput!	The input data for creating the VLAN.
`networkUUID`	UUID!	The UUID of the network where the VLAN will be created.

deleteApplicationDNSFirewallRule

Deletes an application DNS firewall rule. Returns: ApplicationDNSFirewallRule!

deleteApplicationDNSFirewallRule(
  UUID: UUID!
): ApplicationDNSFirewallRule!

Argument	Type	Description
`UUID`	UUID!	The UUID of the DNS firewall rule to delete.

deleteFirewallRule

Delete a firewall rule. Returns: FirewallRule!

deleteFirewallRule(
  UUID: UUID!
): FirewallRule!

Argument	Type	Description
`UUID`	UUID!	UUID of the firewall rule to delete.

deleteIDSIPSConfig

Deletes the IDS IPS config for a network. Returns: IDSIPSConfig!

deleteIDSIPSConfig(
  UUID: UUID!
): IDSIPSConfig!

Argument	Type	Description
`UUID`	UUID!	UUID of the IDS IPS config to delete.

deleteIDSIPSCustomRule

Delete a custom rule for an IDS configuration. Returns: IDSIPSCustomRule!

deleteIDSIPSCustomRule(
  UUID: UUID!
): IDSIPSCustomRule!

Argument	Type	Description
`UUID`	UUID!	Unique identifier of the IDS/IPS configuration.

deleteSSID

Delete an SSID. Returns: SSID!

deleteSSID(
  uuid: UUID!
): SSID!

Argument	Type	Description
`uuid`	UUID!	UUID of the SSID to delete.

deleteVLAN

Delete a VLAN. Returns: Boolean!

deleteVLAN(
  UUID: UUID!
): Boolean!

Argument	Type	Description
`UUID`	UUID!	The UUID of the VLAN to delete.

updateApplicationDNSFirewallRule

Updates an existing application DNS firewall rule. Returns: ApplicationDNSFirewallRule!

updateApplicationDNSFirewallRule(
  UUID: UUID!
  input: UpdateApplicationDNSFirewallRuleInput!
): ApplicationDNSFirewallRule!

Argument	Type	Description
`UUID`	UUID!	The UUID of the DNS firewall rule to update.
`input`	UpdateApplicationDNSFirewallRuleInput!	The input data for updating the DNS firewall rule.

updateFirewallRule

Update a firewall rule. Returns: FirewallRule!

updateFirewallRule(
  UUID: UUID!
  input: UpdateFirewallRuleInput!
): FirewallRule!

Argument	Type	Description
`UUID`	UUID!	UUID of the firewall rule to update.
`input`	UpdateFirewallRuleInput!	Input data for updating the firewall rule.

updateIDSIPSConfig

Updates the IDS IPS config for a network. Returns: IDSIPSConfig!

updateIDSIPSConfig(
  UUID: UUID!
  input: UpdateIDSIPSConfigInput!
): IDSIPSConfig!

Argument	Type	Description
`UUID`	UUID!	UUID of the IDS IPS config to update.
`input`	UpdateIDSIPSConfigInput!	Input parameters to update IDS IPS config.

updateIDSIPSCustomRule

Update a custom rule for an IDS configuration. Returns: IDSIPSCustomRule!

updateIDSIPSCustomRule(
  input: UpdateIDSIPSCustomRuleInput!
  ruleUUID: UUID!
): IDSIPSCustomRule!

Argument	Type	Description
`input`	UpdateIDSIPSCustomRuleInput!	Input type.
`ruleUUID`	UUID!	Unique identifier of the IDS/IPS configuration.

updateSSID

Update an SSID. Returns: SSID!

updateSSID(
  input: UpdateSSIDInput!
  uuid: UUID!
): SSID!

Argument	Type	Description
`input`	UpdateSSIDInput!	Input fields for updating the SSID.
`uuid`	UUID!	UUID of the SSID to update.

updateVLAN

Update an existing VLAN. Returns: VLAN!

updateVLAN(
  UUID: UUID!
  input: UpdateVLANInput!
): VLAN!

Argument	Type	Description
`UUID`	UUID!	The UUID of the VLAN to update.
`input`	UpdateVLANInput!	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?

PreviousInput types NextQueries