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. |
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. |
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. |
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. |
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