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.

addNetworksToAutoVPNGroup

Adds networks to an Auto VPN group. Returns: [AutoVPNMember!]!

addNetworksToAutoVPNGroup(
  groupUUID: UUID!
  inputs: [AddNetworkToAutoVPNGroupInput!]!
): [AutoVPNMember!]!

Argument	Type	Description
`groupUUID`	UUID!	Unique identifier of the AutoVPN group.
`inputs`	[AddNetworkToAutoVPNGroupInput!]!	List of input data for adding networks to the AutoVPN group.

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 an IDS/IPS config for a network. There can be a single config per network; this is a no-op if one already exists. Returns: IDSIPSConfig!

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

Argument	Type	Description
`input`	CreateIDSIPSConfigInput!	Input parameters to create the 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!	The input data for creating the custom rule.

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.

createSupportCase

Creates a support case that will be published to inbox. For machine principals adding collaborators is restricted to the domain that is configured for your account. If this is not set please contact our support team and we can configure your desired domain. Returns: CreateSupportCaseResponse!

createSupportCase(
  input: CreateSupportCaseInput!
): CreateSupportCaseResponse!

Argument	Type	Description
`input`	CreateSupportCaseInput!	The input fields for creating the new case.

createSupportCaseAttachmentUploadUrl

Generates a pre-signed URL for uploading a file that will be attached to a support case comment. Returns: FileUploadPayload!

createSupportCaseAttachmentUploadUrl(
  fileExtension: String!
  supportCaseUUID: UUID!
): FileUploadPayload!

Argument	Type	Description
`fileExtension`	String!	The extension of the file being uploaded (e.g., 'jpg', 'png', 'pdf').
`supportCaseUUID`	UUID!	The UUID of the support case the attachment will belong to.

createSupportCaseComment

Creates a comment on a support case. Returns: SupportCaseComment!

createSupportCaseComment(
  input: CreateSupportCaseCommentInput!
  supportCaseUUID: UUID!
): SupportCaseComment!

Argument	Type	Description
`input`	CreateSupportCaseCommentInput!	the input for creating a support case comment.
`supportCaseUUID`	UUID!	The UUID of the support case to leave the comment on.

createSupportProvider

Creates a support provider owned by a company. Returns: SupportProvider!

createSupportProvider(
  companyUUID: UUID!
  input: CreateSupportProviderInput
): SupportProvider!

Argument	Type	Description
`companyUUID`	UUID!	The UUID of the company that will own the support provider.
`input`	`CreateSupportProviderInput`	The input to create a support provider

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.

deleteAlertCompanySubscriptions

Delete alert company subscriptions. Returns: [AlertCompanySubscription!]!

deleteAlertCompanySubscriptions(
  UUIDs: [UUID!]!
): [AlertCompanySubscription!]!

Argument	Type	Description
`UUIDs`	[UUID!]!	The UUIDs of the alert subscriptions to delete.

deleteAlertReceiverWithTargets

Deletes an alert receiver and all of its targets. Returns: AlertReceiver!

deleteAlertReceiverWithTargets(
  alertReceiverUUID: UUID!
): AlertReceiver!

Argument	Type	Description
`alertReceiverUUID`	UUID!	Unique identifier of the alert receiver to delete.

deleteAlertTargetWebhook

Deletes a webhook alert target specified by its UUID. Returns: AlertTargetWebhook!

deleteAlertTargetWebhook(
  UUID: UUID!
): AlertTargetWebhook!

Argument	Type	Description
`UUID`	UUID!	The UUID of the webhook alert target to delete.

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.

deleteAutoVPNMember

Removes a network from an Auto VPN group. Returns: AutoVPNMember!

deleteAutoVPNMember(
  memberUUID: UUID!
): AutoVPNMember!

Argument	Type	Description
`memberUUID`	UUID!	Unique identifier of the member to remove.

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 custom rule to delete.

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.

revokeOwnAPIKey

Revoke the API key making this request, along with all of its tokens. Returns: PublicAPIKey!

revokeOwnAPIKey(
  companyUUID: UUID!
): PublicAPIKey!

Argument	Type	Description
`companyUUID`	UUID!	The UUID of the company that owns the API key.

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.

updateAutoVPNMember

Updates an Auto VPN Member. Returns: AutoVPNMember!

updateAutoVPNMember(
  UUID: UUID!
  input: UpdateAutoVPNMemberInput!
): AutoVPNMember!

Argument	Type	Description
`UUID`	UUID!	Unique identifier of the AutoVPN Member to update.
`input`	UpdateAutoVPNMemberInput!	Input data for updating the AutoVPN Member.

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 the 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!	The input data for updating the custom rule.
`ruleUUID`	UUID!	Unique identifier of the custom rule to update.

updateOutletInterface

Update an outlet interface. Returns: OutletInterface!

updateOutletInterface(
  UUID: UUID!
  input: UpdateOutletInterfaceInput!
): OutletInterface!

Argument	Type	Description
`UUID`	UUID!	UUID of the outlet interface to update.
`input`	UpdateOutletInterfaceInput!	Fields to update on the outlet interface.

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.

updateSupportCases

Update support cases. Returns: [SupportCase!]!

updateSupportCases(
  input: UpdateSupportCasesInput!
  uuids: [UUID!]
): [SupportCase!]!

Argument	Type	Description
`input`	UpdateSupportCasesInput!	The bulk update parameters for the selected cases.
`uuids`	[UUID!]	UUIDs to update.

updateSupportProvider

Updates a support provider owned by a company. Returns: SupportProvider!

updateSupportProvider(
  input: UpdateSupportProviderInput!
  uuid: UUID!
): SupportProvider!

Argument	Type	Description
`input`	`UpdateSupportProviderInput!`	The input of the fields to update the support provider with.
`uuid`	UUID!	The UUID of the company that will own the support provider.

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