Arduino IoT Cloud API

API and SDK Documentation

Version: 2.0

Provides a set of endpoints to manage Arduino IoT Cloud Devices, Things, Properties and Timeseries. This API can be called just with any HTTP Client, or using one of these clients:

Create Auth Token


curl --request POST \
  --url 'https://api2.arduino.cc/iot/v1/clients/token' \
  --header 'content-type: application/x-www-form-urlencoded' \
  --data 'grant_type=client_credentials' \
  --data 'client_id=YOUR_CLIENT_ID' \
  --data 'client_secret=YOUR_SECRET_ID' \
  --data 'audience=https://api2.arduino.cc/iot'

Token generation code for supported clients are available at the following links:

Rate Limiting

Arduino IoT APIs are rate limited, authenticated clients limit is up to 10req/s.

The following code and message are returned from the Arduino servers in case of rate limit error:

Status: 429 - Too Many Requests

You have reached maximum request limit.

DashboardsV2

dashboardsV2Clone

clone dashboards_v2

Clone an existing dashboard

/iot/v2/dashboards/{id}/clone

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/vnd.arduino.dashboardv2+json,application/vnd.goa.error+json" \
 -H "Content-Type: application/json" \
 "https://api2.arduino.cc/iot/v2/dashboards/{id}/clone" \
 -d '{
  "overrides" : [ {
    "old_thing_id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "new_thing_id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  }, {
    "old_thing_id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "new_thing_id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  } ]
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DashboardsV2Api;

import java.io.File;
import java.util.*;

public class DashboardsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DashboardsV2Api apiInstance = new DashboardsV2Api();
        String id = id_example; // String | The id of the dashboard
        Clone clone = ; // Clone | 
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            ArduinoDashboardv2 result = apiInstance.dashboardsV2Clone(id, clone, xOrganization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsV2Api#dashboardsV2Clone");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String id = new String(); // String | The id of the dashboard
final Clone clone = new Clone(); // Clone | 
final String xOrganization = new String(); // String | Organization space identifer (optional)

try {
    final result = await api_instance.dashboardsV2Clone(id, clone, xOrganization);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->dashboardsV2Clone: $e\n');
}

import org.openapitools.client.api.DashboardsV2Api;

public class DashboardsV2ApiExample {
    public static void main(String[] args) {
        DashboardsV2Api apiInstance = new DashboardsV2Api();
        String id = id_example; // String | The id of the dashboard
        Clone clone = ; // Clone | 
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            ArduinoDashboardv2 result = apiInstance.dashboardsV2Clone(id, clone, xOrganization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsV2Api#dashboardsV2Clone");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DashboardsV2Api *apiInstance = [[DashboardsV2Api alloc] init];
String *id = id_example; // The id of the dashboard (default to null)
Clone *clone = ; // 
String *xOrganization = xOrganization_example; // Organization space identifer (optional) (optional) (default to null)

// clone dashboards_v2
[apiInstance dashboardsV2CloneWith:id
    clone:clone
    xOrganization:xOrganization
              completionHandler: ^(ArduinoDashboardv2 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var ArduinoIotClient = require('@arduino/arduino-iot-client');
var defaultClient = ArduinoIotClient.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new ArduinoIotClient.DashboardsV2Api()
var id = id_example; // {String} The id of the dashboard
var clone = ; // {Clone} 
var opts = {
  'xOrganization': xOrganization_example // {String} Organization space identifer (optional)
};
api.dashboardsV2Clone(id, clone, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using iot.Api;
using iot.Client;
using iot.Model;

namespace Example
{
    public class dashboardsV2CloneExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DashboardsV2Api();
            var id = id_example;  // String | The id of the dashboard (default to null)
            var clone = new Clone(); // Clone | 
            var xOrganization = xOrganization_example;  // String | Organization space identifer (optional) (optional)  (default to null)

            try {
                // clone dashboards_v2
                ArduinoDashboardv2 result = apiInstance.dashboardsV2Clone(id, clone, xOrganization);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DashboardsV2Api.dashboardsV2Clone: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DashboardsV2Api();
$id = id_example; // String | The id of the dashboard
$clone = ; // Clone | 
$xOrganization = xOrganization_example; // String | Organization space identifer (optional)

try {
    $result = $api_instance->dashboardsV2Clone($id, $clone, $xOrganization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardsV2Api->dashboardsV2Clone: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DashboardsV2Api;

# Configure OAuth2 access token for authorization: oauth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DashboardsV2Api->new();
my $id = id_example; # String | The id of the dashboard
my $clone = WWW::OPenAPIClient::Object::Clone->new(); # Clone | 
my $xOrganization = xOrganization_example; # String | Organization space identifer (optional)

eval {
    my $result = $api_instance->dashboardsV2Clone(id => $id, clone => $clone, xOrganization => $xOrganization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardsV2Api->dashboardsV2Clone: $@\n";
}

import iot_api_client as iot
from iot_api_client.configuration import Configuration
from iot_api_client.api import DashboardsV2Api
from iot_api_client.models import *
from iot_api_client.exceptions import ApiException

client_config = Configuration(host="https://api2.arduino.cc")
client_config.access_token = "JWT_ACCESS_TOKEN" 
client = iot.ApiClient(client_config)

# Create an instance of the API class
apiInstance = DashboardsV2Api(client)
id = id_example # String object instance | The id of the dashboard (default to null)
clone =  # Clone object instance | 
xOrganization = xOrganization_example # String object instance | Organization space identifer (optional) (optional) (default to null)

try:
    # clone dashboards_v2
    api_response = apiInstance.dashboards_v2_clone(id, clone, xOrganization=xOrganization)
    print(api_response)
except ApiException as e:
    print("Exception when calling DashboardsV2Api->dashboardsV2Clone: %s\n" % e)

extern crate DashboardsV2Api;

pub fn main() {
    let id = id_example; // String
    let clone = ; // Clone
    let xOrganization = xOrganization_example; // String

    let mut context = DashboardsV2Api::Context::default();
    let result = client.dashboardsV2Clone(id, clone, xOrganization, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
id*	String The id of the dashboard Required

Header parameters

Name	Description
X-Organization	String Organization space identifer (optional)

Body parameters

Name	Description
clone *	Add overrides used when performing a clone of a dashboard

Responses

Schema

Schema

Schema

Schema

Schema

dashboardsV2Create

create dashboards_v2

Create a new dashboard

/iot/v2/dashboards

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/vnd.arduino.dashboardv2+json,application/vnd.goa.error+json" \
 -H "Content-Type: application/json" \
 "https://api2.arduino.cc/iot/v2/dashboards" \
 -d '{
  "soft_deleted" : false,
  "name" : "name",
  "cover_image" : "cover_image",
  "widgets" : [ {
    "height_mobile" : 6,
    "y_mobile" : 9,
    "variables" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "type" : "type",
    "x_mobile" : 2,
    "width_mobile" : 5,
    "name" : "name",
    "options" : {
      "key" : ""
    },
    "width" : 1,
    "x" : 5,
    "y" : 7,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "height" : 0
  }, {
    "height_mobile" : 6,
    "y_mobile" : 9,
    "variables" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "type" : "type",
    "x_mobile" : 2,
    "width_mobile" : 5,
    "name" : "name",
    "options" : {
      "key" : ""
    },
    "width" : 1,
    "x" : 5,
    "y" : 7,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "height" : 0
  } ]
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DashboardsV2Api;

import java.io.File;
import java.util.*;

public class DashboardsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DashboardsV2Api apiInstance = new DashboardsV2Api();
        Dashboardv2 dashboardv2 = ; // Dashboardv2 | 
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            ArduinoDashboardv2 result = apiInstance.dashboardsV2Create(dashboardv2, xOrganization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsV2Api#dashboardsV2Create");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Dashboardv2 dashboardv2 = new Dashboardv2(); // Dashboardv2 | 
final String xOrganization = new String(); // String | Organization space identifer (optional)

try {
    final result = await api_instance.dashboardsV2Create(dashboardv2, xOrganization);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->dashboardsV2Create: $e\n');
}

import org.openapitools.client.api.DashboardsV2Api;

public class DashboardsV2ApiExample {
    public static void main(String[] args) {
        DashboardsV2Api apiInstance = new DashboardsV2Api();
        Dashboardv2 dashboardv2 = ; // Dashboardv2 | 
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            ArduinoDashboardv2 result = apiInstance.dashboardsV2Create(dashboardv2, xOrganization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsV2Api#dashboardsV2Create");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DashboardsV2Api *apiInstance = [[DashboardsV2Api alloc] init];
Dashboardv2 *dashboardv2 = ; // 
String *xOrganization = xOrganization_example; // Organization space identifer (optional) (optional) (default to null)

// create dashboards_v2
[apiInstance dashboardsV2CreateWith:dashboardv2
    xOrganization:xOrganization
              completionHandler: ^(ArduinoDashboardv2 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var ArduinoIotClient = require('@arduino/arduino-iot-client');
var defaultClient = ArduinoIotClient.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new ArduinoIotClient.DashboardsV2Api()
var dashboardv2 = ; // {Dashboardv2} 
var opts = {
  'xOrganization': xOrganization_example // {String} Organization space identifer (optional)
};
api.dashboardsV2Create(dashboardv2, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using iot.Api;
using iot.Client;
using iot.Model;

namespace Example
{
    public class dashboardsV2CreateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DashboardsV2Api();
            var dashboardv2 = new Dashboardv2(); // Dashboardv2 | 
            var xOrganization = xOrganization_example;  // String | Organization space identifer (optional) (optional)  (default to null)

            try {
                // create dashboards_v2
                ArduinoDashboardv2 result = apiInstance.dashboardsV2Create(dashboardv2, xOrganization);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DashboardsV2Api.dashboardsV2Create: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DashboardsV2Api();
$dashboardv2 = ; // Dashboardv2 | 
$xOrganization = xOrganization_example; // String | Organization space identifer (optional)

try {
    $result = $api_instance->dashboardsV2Create($dashboardv2, $xOrganization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardsV2Api->dashboardsV2Create: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DashboardsV2Api;

# Configure OAuth2 access token for authorization: oauth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DashboardsV2Api->new();
my $dashboardv2 = WWW::OPenAPIClient::Object::Dashboardv2->new(); # Dashboardv2 | 
my $xOrganization = xOrganization_example; # String | Organization space identifer (optional)

eval {
    my $result = $api_instance->dashboardsV2Create(dashboardv2 => $dashboardv2, xOrganization => $xOrganization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardsV2Api->dashboardsV2Create: $@\n";
}

import iot_api_client as iot
from iot_api_client.configuration import Configuration
from iot_api_client.api import DashboardsV2Api
from iot_api_client.models import *
from iot_api_client.exceptions import ApiException

client_config = Configuration(host="https://api2.arduino.cc")
client_config.access_token = "JWT_ACCESS_TOKEN" 
client = iot.ApiClient(client_config)

# Create an instance of the API class
apiInstance = DashboardsV2Api(client)
dashboardv2 =  # Dashboardv2 object instance | 
xOrganization = xOrganization_example # String object instance | Organization space identifer (optional) (optional) (default to null)

try:
    # create dashboards_v2
    api_response = apiInstance.dashboards_v2_create(dashboardv2, xOrganization=xOrganization)
    print(api_response)
except ApiException as e:
    print("Exception when calling DashboardsV2Api->dashboardsV2Create: %s\n" % e)

extern crate DashboardsV2Api;

pub fn main() {
    let dashboardv2 = ; // Dashboardv2
    let xOrganization = xOrganization_example; // String

    let mut context = DashboardsV2Api::Context::default();
    let result = client.dashboardsV2Create(dashboardv2, xOrganization, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters

Name	Description
X-Organization	String Organization space identifer (optional)

Body parameters

Name	Description
dashboardv2 *	Describes a dashboard

Responses

Schema

Schema

Schema

Schema

Schema

dashboardsV2Delete

delete dashboards_v2

Delete a dashboard

/iot/v2/dashboards/{id}

Usage and SDK Samples

curl -X DELETE \
 \
 -H "Accept: application/vnd.goa.error+json,text/plain" \
 "https://api2.arduino.cc/iot/v2/dashboards/{id}?force=true"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DashboardsV2Api;

import java.io.File;
import java.util.*;

public class DashboardsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DashboardsV2Api apiInstance = new DashboardsV2Api();
        String id = id_example; // String | The id of the dashboard
        Boolean force = true; // Boolean | If true, hard delete the thing
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            apiInstance.dashboardsV2Delete(id, force, xOrganization);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsV2Api#dashboardsV2Delete");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String id = new String(); // String | The id of the dashboard
final Boolean force = new Boolean(); // Boolean | If true, hard delete the thing
final String xOrganization = new String(); // String | Organization space identifer (optional)

try {
    final result = await api_instance.dashboardsV2Delete(id, force, xOrganization);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->dashboardsV2Delete: $e\n');
}

import org.openapitools.client.api.DashboardsV2Api;

public class DashboardsV2ApiExample {
    public static void main(String[] args) {
        DashboardsV2Api apiInstance = new DashboardsV2Api();
        String id = id_example; // String | The id of the dashboard
        Boolean force = true; // Boolean | If true, hard delete the thing
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            apiInstance.dashboardsV2Delete(id, force, xOrganization);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsV2Api#dashboardsV2Delete");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DashboardsV2Api *apiInstance = [[DashboardsV2Api alloc] init];
String *id = id_example; // The id of the dashboard (default to null)
Boolean *force = true; // If true, hard delete the thing (optional) (default to false)
String *xOrganization = xOrganization_example; // Organization space identifer (optional) (optional) (default to null)

// delete dashboards_v2
[apiInstance dashboardsV2DeleteWith:id
    force:force
    xOrganization:xOrganization
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var ArduinoIotClient = require('@arduino/arduino-iot-client');
var defaultClient = ArduinoIotClient.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new ArduinoIotClient.DashboardsV2Api()
var id = id_example; // {String} The id of the dashboard
var opts = {
  'force': true, // {Boolean} If true, hard delete the thing
  'xOrganization': xOrganization_example // {String} Organization space identifer (optional)
};
api.dashboardsV2Delete(id, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using iot.Api;
using iot.Client;
using iot.Model;

namespace Example
{
    public class dashboardsV2DeleteExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DashboardsV2Api();
            var id = id_example;  // String | The id of the dashboard (default to null)
            var force = true;  // Boolean | If true, hard delete the thing (optional)  (default to false)
            var xOrganization = xOrganization_example;  // String | Organization space identifer (optional) (optional)  (default to null)

            try {
                // delete dashboards_v2
                apiInstance.dashboardsV2Delete(id, force, xOrganization);
            } catch (Exception e) {
                Debug.Print("Exception when calling DashboardsV2Api.dashboardsV2Delete: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DashboardsV2Api();
$id = id_example; // String | The id of the dashboard
$force = true; // Boolean | If true, hard delete the thing
$xOrganization = xOrganization_example; // String | Organization space identifer (optional)

try {
    $api_instance->dashboardsV2Delete($id, $force, $xOrganization);
} catch (Exception $e) {
    echo 'Exception when calling DashboardsV2Api->dashboardsV2Delete: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DashboardsV2Api;

# Configure OAuth2 access token for authorization: oauth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DashboardsV2Api->new();
my $id = id_example; # String | The id of the dashboard
my $force = true; # Boolean | If true, hard delete the thing
my $xOrganization = xOrganization_example; # String | Organization space identifer (optional)

eval {
    $api_instance->dashboardsV2Delete(id => $id, force => $force, xOrganization => $xOrganization);
};
if ($@) {
    warn "Exception when calling DashboardsV2Api->dashboardsV2Delete: $@\n";
}

import iot_api_client as iot
from iot_api_client.configuration import Configuration
from iot_api_client.api import DashboardsV2Api
from iot_api_client.models import *
from iot_api_client.exceptions import ApiException

client_config = Configuration(host="https://api2.arduino.cc")
client_config.access_token = "JWT_ACCESS_TOKEN" 
client = iot.ApiClient(client_config)

# Create an instance of the API class
apiInstance = DashboardsV2Api(client)
id = id_example # String object instance | The id of the dashboard (default to null)
force = true # Boolean object instance | If true, hard delete the thing (optional) (default to false)
xOrganization = xOrganization_example # String object instance | Organization space identifer (optional) (optional) (default to null)

try:
    # delete dashboards_v2
    apiInstance.dashboards_v2_delete(id, force=force, xOrganization=xOrganization)
except ApiException as e:
    print("Exception when calling DashboardsV2Api->dashboardsV2Delete: %s\n" % e)

extern crate DashboardsV2Api;

pub fn main() {
    let id = id_example; // String
    let force = true; // Boolean
    let xOrganization = xOrganization_example; // String

    let mut context = DashboardsV2Api::Context::default();
    let result = client.dashboardsV2Delete(id, force, xOrganization, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
id*	String The id of the dashboard Required

Header parameters

Name	Description
X-Organization	String Organization space identifer (optional)

Query parameters

Name	Description
force	Boolean If true, hard delete the thing

Responses

Schema

Schema

Schema

Schema

dashboardsV2DeleteShare

deleteShare dashboards_v2

Delete a user the dashboard has been shared with

/iot/v2/dashboards/{id}/shares/{user_id}

Usage and SDK Samples

curl -X DELETE \
 \
 -H "Accept: application/vnd.goa.error+json,text/plain" \
 "https://api2.arduino.cc/iot/v2/dashboards/{id}/shares/{user_id}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DashboardsV2Api;

import java.io.File;
import java.util.*;

public class DashboardsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DashboardsV2Api apiInstance = new DashboardsV2Api();
        String id = id_example; // String | The id of the dashboard
        String userId = userId_example; // String | The id of the user
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            apiInstance.dashboardsV2DeleteShare(id, userId, xOrganization);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsV2Api#dashboardsV2DeleteShare");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String id = new String(); // String | The id of the dashboard
final String userId = new String(); // String | The id of the user
final String xOrganization = new String(); // String | Organization space identifer (optional)

try {
    final result = await api_instance.dashboardsV2DeleteShare(id, userId, xOrganization);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->dashboardsV2DeleteShare: $e\n');
}

import org.openapitools.client.api.DashboardsV2Api;

public class DashboardsV2ApiExample {
    public static void main(String[] args) {
        DashboardsV2Api apiInstance = new DashboardsV2Api();
        String id = id_example; // String | The id of the dashboard
        String userId = userId_example; // String | The id of the user
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            apiInstance.dashboardsV2DeleteShare(id, userId, xOrganization);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsV2Api#dashboardsV2DeleteShare");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DashboardsV2Api *apiInstance = [[DashboardsV2Api alloc] init];
String *id = id_example; // The id of the dashboard (default to null)
String *userId = userId_example; // The id of the user (default to null)
String *xOrganization = xOrganization_example; // Organization space identifer (optional) (optional) (default to null)

// deleteShare dashboards_v2
[apiInstance dashboardsV2DeleteShareWith:id
    userId:userId
    xOrganization:xOrganization
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var ArduinoIotClient = require('@arduino/arduino-iot-client');
var defaultClient = ArduinoIotClient.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new ArduinoIotClient.DashboardsV2Api()
var id = id_example; // {String} The id of the dashboard
var userId = userId_example; // {String} The id of the user
var opts = {
  'xOrganization': xOrganization_example // {String} Organization space identifer (optional)
};
api.dashboardsV2DeleteShare(id, userId, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using iot.Api;
using iot.Client;
using iot.Model;

namespace Example
{
    public class dashboardsV2DeleteShareExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DashboardsV2Api();
            var id = id_example;  // String | The id of the dashboard (default to null)
            var userId = userId_example;  // String | The id of the user (default to null)
            var xOrganization = xOrganization_example;  // String | Organization space identifer (optional) (optional)  (default to null)

            try {
                // deleteShare dashboards_v2
                apiInstance.dashboardsV2DeleteShare(id, userId, xOrganization);
            } catch (Exception e) {
                Debug.Print("Exception when calling DashboardsV2Api.dashboardsV2DeleteShare: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DashboardsV2Api();
$id = id_example; // String | The id of the dashboard
$userId = userId_example; // String | The id of the user
$xOrganization = xOrganization_example; // String | Organization space identifer (optional)

try {
    $api_instance->dashboardsV2DeleteShare($id, $userId, $xOrganization);
} catch (Exception $e) {
    echo 'Exception when calling DashboardsV2Api->dashboardsV2DeleteShare: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DashboardsV2Api;

# Configure OAuth2 access token for authorization: oauth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DashboardsV2Api->new();
my $id = id_example; # String | The id of the dashboard
my $userId = userId_example; # String | The id of the user
my $xOrganization = xOrganization_example; # String | Organization space identifer (optional)

eval {
    $api_instance->dashboardsV2DeleteShare(id => $id, userId => $userId, xOrganization => $xOrganization);
};
if ($@) {
    warn "Exception when calling DashboardsV2Api->dashboardsV2DeleteShare: $@\n";
}

import iot_api_client as iot
from iot_api_client.configuration import Configuration
from iot_api_client.api import DashboardsV2Api
from iot_api_client.models import *
from iot_api_client.exceptions import ApiException

client_config = Configuration(host="https://api2.arduino.cc")
client_config.access_token = "JWT_ACCESS_TOKEN" 
client = iot.ApiClient(client_config)

# Create an instance of the API class
apiInstance = DashboardsV2Api(client)
id = id_example # String object instance | The id of the dashboard (default to null)
userId = userId_example # String object instance | The id of the user (default to null)
xOrganization = xOrganization_example # String object instance | Organization space identifer (optional) (optional) (default to null)

try:
    # deleteShare dashboards_v2
    apiInstance.dashboards_v2_delete_share(id, userId, xOrganization=xOrganization)
except ApiException as e:
    print("Exception when calling DashboardsV2Api->dashboardsV2DeleteShare: %s\n" % e)

extern crate DashboardsV2Api;

pub fn main() {
    let id = id_example; // String
    let userId = userId_example; // String
    let xOrganization = xOrganization_example; // String

    let mut context = DashboardsV2Api::Context::default();
    let result = client.dashboardsV2DeleteShare(id, userId, xOrganization, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
id*	String The id of the dashboard Required
user_id*	String The id of the user Required

Header parameters

Name	Description
X-Organization	String Organization space identifer (optional)

Responses

Schema

Schema

Schema

Schema

dashboardsV2Link

link dashboards_v2

Link or detach widget variables

/iot/v2/dashboards/{id}/widgets/{widgetId}/variables

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/vnd.arduino.variableslinks+json,application/vnd.goa.error+json" \
 -H "Content-Type: application/json" \
 "https://api2.arduino.cc/iot/v2/dashboards/{id}/widgets/{widgetId}/variables" \
 -d ''

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DashboardsV2Api;

import java.io.File;
import java.util.*;

public class DashboardsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DashboardsV2Api apiInstance = new DashboardsV2Api();
        String id = id_example; // String | The id of the dashboard
        String widgetId = widgetId_example; // String | The id of the widget
        Widgetlink widgetlink = ; // Widgetlink | 
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            ArduinoVariableslinks result = apiInstance.dashboardsV2Link(id, widgetId, widgetlink, xOrganization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsV2Api#dashboardsV2Link");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String id = new String(); // String | The id of the dashboard
final String widgetId = new String(); // String | The id of the widget
final Widgetlink widgetlink = new Widgetlink(); // Widgetlink | 
final String xOrganization = new String(); // String | Organization space identifer (optional)

try {
    final result = await api_instance.dashboardsV2Link(id, widgetId, widgetlink, xOrganization);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->dashboardsV2Link: $e\n');
}

import org.openapitools.client.api.DashboardsV2Api;

public class DashboardsV2ApiExample {
    public static void main(String[] args) {
        DashboardsV2Api apiInstance = new DashboardsV2Api();
        String id = id_example; // String | The id of the dashboard
        String widgetId = widgetId_example; // String | The id of the widget
        Widgetlink widgetlink = ; // Widgetlink | 
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            ArduinoVariableslinks result = apiInstance.dashboardsV2Link(id, widgetId, widgetlink, xOrganization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsV2Api#dashboardsV2Link");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DashboardsV2Api *apiInstance = [[DashboardsV2Api alloc] init];
String *id = id_example; // The id of the dashboard (default to null)
String *widgetId = widgetId_example; // The id of the widget (default to null)
Widgetlink *widgetlink = ; // 
String *xOrganization = xOrganization_example; // Organization space identifer (optional) (optional) (default to null)

// link dashboards_v2
[apiInstance dashboardsV2LinkWith:id
    widgetId:widgetId
    widgetlink:widgetlink
    xOrganization:xOrganization
              completionHandler: ^(ArduinoVariableslinks output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var ArduinoIotClient = require('@arduino/arduino-iot-client');
var defaultClient = ArduinoIotClient.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new ArduinoIotClient.DashboardsV2Api()
var id = id_example; // {String} The id of the dashboard
var widgetId = widgetId_example; // {String} The id of the widget
var widgetlink = ; // {Widgetlink} 
var opts = {
  'xOrganization': xOrganization_example // {String} Organization space identifer (optional)
};
api.dashboardsV2Link(id, widgetId, widgetlink, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using iot.Api;
using iot.Client;
using iot.Model;

namespace Example
{
    public class dashboardsV2LinkExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DashboardsV2Api();
            var id = id_example;  // String | The id of the dashboard (default to null)
            var widgetId = widgetId_example;  // String | The id of the widget (default to null)
            var widgetlink = new Widgetlink(); // Widgetlink | 
            var xOrganization = xOrganization_example;  // String | Organization space identifer (optional) (optional)  (default to null)

            try {
                // link dashboards_v2
                ArduinoVariableslinks result = apiInstance.dashboardsV2Link(id, widgetId, widgetlink, xOrganization);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DashboardsV2Api.dashboardsV2Link: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DashboardsV2Api();
$id = id_example; // String | The id of the dashboard
$widgetId = widgetId_example; // String | The id of the widget
$widgetlink = ; // Widgetlink | 
$xOrganization = xOrganization_example; // String | Organization space identifer (optional)

try {
    $result = $api_instance->dashboardsV2Link($id, $widgetId, $widgetlink, $xOrganization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardsV2Api->dashboardsV2Link: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DashboardsV2Api;

# Configure OAuth2 access token for authorization: oauth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DashboardsV2Api->new();
my $id = id_example; # String | The id of the dashboard
my $widgetId = widgetId_example; # String | The id of the widget
my $widgetlink = WWW::OPenAPIClient::Object::Widgetlink->new(); # Widgetlink | 
my $xOrganization = xOrganization_example; # String | Organization space identifer (optional)

eval {
    my $result = $api_instance->dashboardsV2Link(id => $id, widgetId => $widgetId, widgetlink => $widgetlink, xOrganization => $xOrganization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardsV2Api->dashboardsV2Link: $@\n";
}

import iot_api_client as iot
from iot_api_client.configuration import Configuration
from iot_api_client.api import DashboardsV2Api
from iot_api_client.models import *
from iot_api_client.exceptions import ApiException

client_config = Configuration(host="https://api2.arduino.cc")
client_config.access_token = "JWT_ACCESS_TOKEN" 
client = iot.ApiClient(client_config)

# Create an instance of the API class
apiInstance = DashboardsV2Api(client)
id = id_example # String object instance | The id of the dashboard (default to null)
widgetId = widgetId_example # String object instance | The id of the widget (default to null)
widgetlink =  # Widgetlink object instance | 
xOrganization = xOrganization_example # String object instance | Organization space identifer (optional) (optional) (default to null)

try:
    # link dashboards_v2
    api_response = apiInstance.dashboards_v2_link(id, widgetId, widgetlink, xOrganization=xOrganization)
    print(api_response)
except ApiException as e:
    print("Exception when calling DashboardsV2Api->dashboardsV2Link: %s\n" % e)

extern crate DashboardsV2Api;

pub fn main() {
    let id = id_example; // String
    let widgetId = widgetId_example; // String
    let widgetlink = ; // Widgetlink
    let xOrganization = xOrganization_example; // String

    let mut context = DashboardsV2Api::Context::default();
    let result = client.dashboardsV2Link(id, widgetId, widgetlink, xOrganization, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
id*	String The id of the dashboard Required
widgetId*	String The id of the widget Required

Header parameters

Name	Description
X-Organization	String Organization space identifer (optional)

Body parameters

Name	Description
widgetlink *

Responses

Schema

Schema

Schema

Schema

Schema

dashboardsV2List

list dashboards_v2

Returns the list of dashboards

/iot/v2/dashboards

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/vnd.arduino.dashboardv2+json; type=collection,application/vnd.goa.error+json" \
 "https://api2.arduino.cc/iot/v2/dashboards?name=name_example&user_id=userId_example"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DashboardsV2Api;

import java.io.File;
import java.util.*;

public class DashboardsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DashboardsV2Api apiInstance = new DashboardsV2Api();
        String name = name_example; // String | Filter by name of the dashboard. It support like matching.
        String userId = userId_example; // String | Filter by user_id of the dashboard's owner
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            array[ArduinoDashboardv2] result = apiInstance.dashboardsV2List(name, userId, xOrganization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsV2Api#dashboardsV2List");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String name = new String(); // String | Filter by name of the dashboard. It support like matching.
final String userId = new String(); // String | Filter by user_id of the dashboard's owner
final String xOrganization = new String(); // String | Organization space identifer (optional)

try {
    final result = await api_instance.dashboardsV2List(name, userId, xOrganization);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->dashboardsV2List: $e\n');
}

import org.openapitools.client.api.DashboardsV2Api;

public class DashboardsV2ApiExample {
    public static void main(String[] args) {
        DashboardsV2Api apiInstance = new DashboardsV2Api();
        String name = name_example; // String | Filter by name of the dashboard. It support like matching.
        String userId = userId_example; // String | Filter by user_id of the dashboard's owner
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            array[ArduinoDashboardv2] result = apiInstance.dashboardsV2List(name, userId, xOrganization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsV2Api#dashboardsV2List");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DashboardsV2Api *apiInstance = [[DashboardsV2Api alloc] init];
String *name = name_example; // Filter by name of the dashboard. It support like matching. (optional) (default to null)
String *userId = userId_example; // Filter by user_id of the dashboard's owner (optional) (default to null)
String *xOrganization = xOrganization_example; // Organization space identifer (optional) (optional) (default to null)

// list dashboards_v2
[apiInstance dashboardsV2ListWith:name
    userId:userId
    xOrganization:xOrganization
              completionHandler: ^(array[ArduinoDashboardv2] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var ArduinoIotClient = require('@arduino/arduino-iot-client');
var defaultClient = ArduinoIotClient.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new ArduinoIotClient.DashboardsV2Api()
var opts = {
  'name': name_example, // {String} Filter by name of the dashboard. It support like matching.
  'userId': userId_example, // {String} Filter by user_id of the dashboard's owner
  'xOrganization': xOrganization_example // {String} Organization space identifer (optional)
};
api.dashboardsV2List(opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using iot.Api;
using iot.Client;
using iot.Model;

namespace Example
{
    public class dashboardsV2ListExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DashboardsV2Api();
            var name = name_example;  // String | Filter by name of the dashboard. It support like matching. (optional)  (default to null)
            var userId = userId_example;  // String | Filter by user_id of the dashboard's owner (optional)  (default to null)
            var xOrganization = xOrganization_example;  // String | Organization space identifer (optional) (optional)  (default to null)

            try {
                // list dashboards_v2
                array[ArduinoDashboardv2] result = apiInstance.dashboardsV2List(name, userId, xOrganization);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DashboardsV2Api.dashboardsV2List: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DashboardsV2Api();
$name = name_example; // String | Filter by name of the dashboard. It support like matching.
$userId = userId_example; // String | Filter by user_id of the dashboard's owner
$xOrganization = xOrganization_example; // String | Organization space identifer (optional)

try {
    $result = $api_instance->dashboardsV2List($name, $userId, $xOrganization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardsV2Api->dashboardsV2List: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DashboardsV2Api;

# Configure OAuth2 access token for authorization: oauth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DashboardsV2Api->new();
my $name = name_example; # String | Filter by name of the dashboard. It support like matching.
my $userId = userId_example; # String | Filter by user_id of the dashboard's owner
my $xOrganization = xOrganization_example; # String | Organization space identifer (optional)

eval {
    my $result = $api_instance->dashboardsV2List(name => $name, userId => $userId, xOrganization => $xOrganization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardsV2Api->dashboardsV2List: $@\n";
}

import iot_api_client as iot
from iot_api_client.configuration import Configuration
from iot_api_client.api import DashboardsV2Api
from iot_api_client.models import *
from iot_api_client.exceptions import ApiException

client_config = Configuration(host="https://api2.arduino.cc")
client_config.access_token = "JWT_ACCESS_TOKEN" 
client = iot.ApiClient(client_config)

# Create an instance of the API class
apiInstance = DashboardsV2Api(client)
name = name_example # String object instance | Filter by name of the dashboard. It support like matching. (optional) (default to null)
userId = userId_example # String object instance | Filter by user_id of the dashboard's owner (optional) (default to null)
xOrganization = xOrganization_example # String object instance | Organization space identifer (optional) (optional) (default to null)

try:
    # list dashboards_v2
    api_response = apiInstance.dashboards_v2_list(name=name, userId=userId, xOrganization=xOrganization)
    print(api_response)
except ApiException as e:
    print("Exception when calling DashboardsV2Api->dashboardsV2List: %s\n" % e)

extern crate DashboardsV2Api;

pub fn main() {
    let name = name_example; // String
    let userId = userId_example; // String
    let xOrganization = xOrganization_example; // String

    let mut context = DashboardsV2Api::Context::default();
    let result = client.dashboardsV2List(name, userId, xOrganization, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters

Name	Description
X-Organization	String Organization space identifer (optional)

Query parameters

Name	Description
name	String Filter by name of the dashboard. It support like matching.
user_id	String Filter by user_id of the dashboard's owner

Responses

Schema

Schema

Schema

Schema

Schema

dashboardsV2ListShares

listShares dashboards_v2

List of users the dashboard has been shared with

/iot/v2/dashboards/{id}/shares

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/vnd.arduino.dashboardshare+json; type=collection,application/vnd.goa.error+json" \
 "https://api2.arduino.cc/iot/v2/dashboards/{id}/shares"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DashboardsV2Api;

import java.io.File;
import java.util.*;

public class DashboardsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DashboardsV2Api apiInstance = new DashboardsV2Api();
        String id = id_example; // String | The id of the dashboard
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            array[ArduinoDashboardshare] result = apiInstance.dashboardsV2ListShares(id, xOrganization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsV2Api#dashboardsV2ListShares");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String id = new String(); // String | The id of the dashboard
final String xOrganization = new String(); // String | Organization space identifer (optional)

try {
    final result = await api_instance.dashboardsV2ListShares(id, xOrganization);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->dashboardsV2ListShares: $e\n');
}

import org.openapitools.client.api.DashboardsV2Api;

public class DashboardsV2ApiExample {
    public static void main(String[] args) {
        DashboardsV2Api apiInstance = new DashboardsV2Api();
        String id = id_example; // String | The id of the dashboard
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            array[ArduinoDashboardshare] result = apiInstance.dashboardsV2ListShares(id, xOrganization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsV2Api#dashboardsV2ListShares");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DashboardsV2Api *apiInstance = [[DashboardsV2Api alloc] init];
String *id = id_example; // The id of the dashboard (default to null)
String *xOrganization = xOrganization_example; // Organization space identifer (optional) (optional) (default to null)

// listShares dashboards_v2
[apiInstance dashboardsV2ListSharesWith:id
    xOrganization:xOrganization
              completionHandler: ^(array[ArduinoDashboardshare] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var ArduinoIotClient = require('@arduino/arduino-iot-client');
var defaultClient = ArduinoIotClient.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new ArduinoIotClient.DashboardsV2Api()
var id = id_example; // {String} The id of the dashboard
var opts = {
  'xOrganization': xOrganization_example // {String} Organization space identifer (optional)
};
api.dashboardsV2ListShares(id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using iot.Api;
using iot.Client;
using iot.Model;

namespace Example
{
    public class dashboardsV2ListSharesExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DashboardsV2Api();
            var id = id_example;  // String | The id of the dashboard (default to null)
            var xOrganization = xOrganization_example;  // String | Organization space identifer (optional) (optional)  (default to null)

            try {
                // listShares dashboards_v2
                array[ArduinoDashboardshare] result = apiInstance.dashboardsV2ListShares(id, xOrganization);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DashboardsV2Api.dashboardsV2ListShares: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DashboardsV2Api();
$id = id_example; // String | The id of the dashboard
$xOrganization = xOrganization_example; // String | Organization space identifer (optional)

try {
    $result = $api_instance->dashboardsV2ListShares($id, $xOrganization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardsV2Api->dashboardsV2ListShares: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DashboardsV2Api;

# Configure OAuth2 access token for authorization: oauth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DashboardsV2Api->new();
my $id = id_example; # String | The id of the dashboard
my $xOrganization = xOrganization_example; # String | Organization space identifer (optional)

eval {
    my $result = $api_instance->dashboardsV2ListShares(id => $id, xOrganization => $xOrganization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardsV2Api->dashboardsV2ListShares: $@\n";
}

import iot_api_client as iot
from iot_api_client.configuration import Configuration
from iot_api_client.api import DashboardsV2Api
from iot_api_client.models import *
from iot_api_client.exceptions import ApiException

client_config = Configuration(host="https://api2.arduino.cc")
client_config.access_token = "JWT_ACCESS_TOKEN" 
client = iot.ApiClient(client_config)

# Create an instance of the API class
apiInstance = DashboardsV2Api(client)
id = id_example # String object instance | The id of the dashboard (default to null)
xOrganization = xOrganization_example # String object instance | Organization space identifer (optional) (optional) (default to null)

try:
    # listShares dashboards_v2
    api_response = apiInstance.dashboards_v2_list_shares(id, xOrganization=xOrganization)
    print(api_response)
except ApiException as e:
    print("Exception when calling DashboardsV2Api->dashboardsV2ListShares: %s\n" % e)

extern crate DashboardsV2Api;

pub fn main() {
    let id = id_example; // String
    let xOrganization = xOrganization_example; // String

    let mut context = DashboardsV2Api::Context::default();
    let result = client.dashboardsV2ListShares(id, xOrganization, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
id*	String The id of the dashboard Required

Header parameters

Name	Description
X-Organization	String Organization space identifer (optional)

Responses

Schema

Schema

Schema

Schema

Schema

dashboardsV2Patch

patch dashboards_v2

Updates an existing dashboard field without overwriting the existing data

/iot/v2/dashboards/{id}

Usage and SDK Samples

curl -X PATCH \
 \
 -H "Accept: application/vnd.arduino.dashboardv2+json,application/vnd.goa.error+json" \
 -H "Content-Type: application/json" \
 "https://api2.arduino.cc/iot/v2/dashboards/{id}" \
 -d '{
  "soft_deleted" : false,
  "name" : "name",
  "cover_image" : "cover_image",
  "widgets" : [ {
    "height_mobile" : 6,
    "y_mobile" : 9,
    "variables" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "type" : "type",
    "x_mobile" : 2,
    "width_mobile" : 5,
    "name" : "name",
    "options" : {
      "key" : ""
    },
    "width" : 1,
    "x" : 5,
    "y" : 7,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "height" : 0
  }, {
    "height_mobile" : 6,
    "y_mobile" : 9,
    "variables" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "type" : "type",
    "x_mobile" : 2,
    "width_mobile" : 5,
    "name" : "name",
    "options" : {
      "key" : ""
    },
    "width" : 1,
    "x" : 5,
    "y" : 7,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "height" : 0
  } ]
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DashboardsV2Api;

import java.io.File;
import java.util.*;

public class DashboardsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DashboardsV2Api apiInstance = new DashboardsV2Api();
        String id = id_example; // String | The id of the dashboard
        Dashboardv2 dashboardv2 = ; // Dashboardv2 | 
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            ArduinoDashboardv2 result = apiInstance.dashboardsV2Patch(id, dashboardv2, xOrganization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsV2Api#dashboardsV2Patch");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String id = new String(); // String | The id of the dashboard
final Dashboardv2 dashboardv2 = new Dashboardv2(); // Dashboardv2 | 
final String xOrganization = new String(); // String | Organization space identifer (optional)

try {
    final result = await api_instance.dashboardsV2Patch(id, dashboardv2, xOrganization);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->dashboardsV2Patch: $e\n');
}

import org.openapitools.client.api.DashboardsV2Api;

public class DashboardsV2ApiExample {
    public static void main(String[] args) {
        DashboardsV2Api apiInstance = new DashboardsV2Api();
        String id = id_example; // String | The id of the dashboard
        Dashboardv2 dashboardv2 = ; // Dashboardv2 | 
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            ArduinoDashboardv2 result = apiInstance.dashboardsV2Patch(id, dashboardv2, xOrganization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsV2Api#dashboardsV2Patch");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DashboardsV2Api *apiInstance = [[DashboardsV2Api alloc] init];
String *id = id_example; // The id of the dashboard (default to null)
Dashboardv2 *dashboardv2 = ; // 
String *xOrganization = xOrganization_example; // Organization space identifer (optional) (optional) (default to null)

// patch dashboards_v2
[apiInstance dashboardsV2PatchWith:id
    dashboardv2:dashboardv2
    xOrganization:xOrganization
              completionHandler: ^(ArduinoDashboardv2 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var ArduinoIotClient = require('@arduino/arduino-iot-client');
var defaultClient = ArduinoIotClient.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new ArduinoIotClient.DashboardsV2Api()
var id = id_example; // {String} The id of the dashboard
var dashboardv2 = ; // {Dashboardv2} 
var opts = {
  'xOrganization': xOrganization_example // {String} Organization space identifer (optional)
};
api.dashboardsV2Patch(id, dashboardv2, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using iot.Api;
using iot.Client;
using iot.Model;

namespace Example
{
    public class dashboardsV2PatchExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DashboardsV2Api();
            var id = id_example;  // String | The id of the dashboard (default to null)
            var dashboardv2 = new Dashboardv2(); // Dashboardv2 | 
            var xOrganization = xOrganization_example;  // String | Organization space identifer (optional) (optional)  (default to null)

            try {
                // patch dashboards_v2
                ArduinoDashboardv2 result = apiInstance.dashboardsV2Patch(id, dashboardv2, xOrganization);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DashboardsV2Api.dashboardsV2Patch: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DashboardsV2Api();
$id = id_example; // String | The id of the dashboard
$dashboardv2 = ; // Dashboardv2 | 
$xOrganization = xOrganization_example; // String | Organization space identifer (optional)

try {
    $result = $api_instance->dashboardsV2Patch($id, $dashboardv2, $xOrganization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardsV2Api->dashboardsV2Patch: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DashboardsV2Api;

# Configure OAuth2 access token for authorization: oauth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DashboardsV2Api->new();
my $id = id_example; # String | The id of the dashboard
my $dashboardv2 = WWW::OPenAPIClient::Object::Dashboardv2->new(); # Dashboardv2 | 
my $xOrganization = xOrganization_example; # String | Organization space identifer (optional)

eval {
    my $result = $api_instance->dashboardsV2Patch(id => $id, dashboardv2 => $dashboardv2, xOrganization => $xOrganization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardsV2Api->dashboardsV2Patch: $@\n";
}

import iot_api_client as iot
from iot_api_client.configuration import Configuration
from iot_api_client.api import DashboardsV2Api
from iot_api_client.models import *
from iot_api_client.exceptions import ApiException

client_config = Configuration(host="https://api2.arduino.cc")
client_config.access_token = "JWT_ACCESS_TOKEN" 
client = iot.ApiClient(client_config)

# Create an instance of the API class
apiInstance = DashboardsV2Api(client)
id = id_example # String object instance | The id of the dashboard (default to null)
dashboardv2 =  # Dashboardv2 object instance | 
xOrganization = xOrganization_example # String object instance | Organization space identifer (optional) (optional) (default to null)

try:
    # patch dashboards_v2
    api_response = apiInstance.dashboards_v2_patch(id, dashboardv2, xOrganization=xOrganization)
    print(api_response)
except ApiException as e:
    print("Exception when calling DashboardsV2Api->dashboardsV2Patch: %s\n" % e)

extern crate DashboardsV2Api;

pub fn main() {
    let id = id_example; // String
    let dashboardv2 = ; // Dashboardv2
    let xOrganization = xOrganization_example; // String

    let mut context = DashboardsV2Api::Context::default();
    let result = client.dashboardsV2Patch(id, dashboardv2, xOrganization, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
id*	String The id of the dashboard Required

Header parameters

Name	Description
X-Organization	String Organization space identifer (optional)

Body parameters

Name	Description
dashboardv2 *	Describes a dashboard

Responses

Schema

Schema

Schema

Schema

Schema

dashboardsV2RequestAccess

requestAccess dashboards_v2

Request access to a dashboard

/iot/v2/dashboards/{id}/share_request

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/vnd.goa.error+json,text/plain" \
 -H "Content-Type: application/json" \
 "https://api2.arduino.cc/iot/v2/dashboards/{id}/share_request" \
 -d '{
  "message" : "message"
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DashboardsV2Api;

import java.io.File;
import java.util.*;

public class DashboardsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DashboardsV2Api apiInstance = new DashboardsV2Api();
        String id = id_example; // String | The id of the dashboard
        Sharerequest sharerequest = ; // Sharerequest | 
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            apiInstance.dashboardsV2RequestAccess(id, sharerequest, xOrganization);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsV2Api#dashboardsV2RequestAccess");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String id = new String(); // String | The id of the dashboard
final Sharerequest sharerequest = new Sharerequest(); // Sharerequest | 
final String xOrganization = new String(); // String | Organization space identifer (optional)

try {
    final result = await api_instance.dashboardsV2RequestAccess(id, sharerequest, xOrganization);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->dashboardsV2RequestAccess: $e\n');
}

import org.openapitools.client.api.DashboardsV2Api;

public class DashboardsV2ApiExample {
    public static void main(String[] args) {
        DashboardsV2Api apiInstance = new DashboardsV2Api();
        String id = id_example; // String | The id of the dashboard
        Sharerequest sharerequest = ; // Sharerequest | 
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            apiInstance.dashboardsV2RequestAccess(id, sharerequest, xOrganization);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsV2Api#dashboardsV2RequestAccess");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DashboardsV2Api *apiInstance = [[DashboardsV2Api alloc] init];
String *id = id_example; // The id of the dashboard (default to null)
Sharerequest *sharerequest = ; // 
String *xOrganization = xOrganization_example; // Organization space identifer (optional) (optional) (default to null)

// requestAccess dashboards_v2
[apiInstance dashboardsV2RequestAccessWith:id
    sharerequest:sharerequest
    xOrganization:xOrganization
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var ArduinoIotClient = require('@arduino/arduino-iot-client');
var defaultClient = ArduinoIotClient.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new ArduinoIotClient.DashboardsV2Api()
var id = id_example; // {String} The id of the dashboard
var sharerequest = ; // {Sharerequest} 
var opts = {
  'xOrganization': xOrganization_example // {String} Organization space identifer (optional)
};
api.dashboardsV2RequestAccess(id, sharerequest, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using iot.Api;
using iot.Client;
using iot.Model;

namespace Example
{
    public class dashboardsV2RequestAccessExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DashboardsV2Api();
            var id = id_example;  // String | The id of the dashboard (default to null)
            var sharerequest = new Sharerequest(); // Sharerequest | 
            var xOrganization = xOrganization_example;  // String | Organization space identifer (optional) (optional)  (default to null)

            try {
                // requestAccess dashboards_v2
                apiInstance.dashboardsV2RequestAccess(id, sharerequest, xOrganization);
            } catch (Exception e) {
                Debug.Print("Exception when calling DashboardsV2Api.dashboardsV2RequestAccess: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DashboardsV2Api();
$id = id_example; // String | The id of the dashboard
$sharerequest = ; // Sharerequest | 
$xOrganization = xOrganization_example; // String | Organization space identifer (optional)

try {
    $api_instance->dashboardsV2RequestAccess($id, $sharerequest, $xOrganization);
} catch (Exception $e) {
    echo 'Exception when calling DashboardsV2Api->dashboardsV2RequestAccess: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DashboardsV2Api;

# Configure OAuth2 access token for authorization: oauth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DashboardsV2Api->new();
my $id = id_example; # String | The id of the dashboard
my $sharerequest = WWW::OPenAPIClient::Object::Sharerequest->new(); # Sharerequest | 
my $xOrganization = xOrganization_example; # String | Organization space identifer (optional)

eval {
    $api_instance->dashboardsV2RequestAccess(id => $id, sharerequest => $sharerequest, xOrganization => $xOrganization);
};
if ($@) {
    warn "Exception when calling DashboardsV2Api->dashboardsV2RequestAccess: $@\n";
}

import iot_api_client as iot
from iot_api_client.configuration import Configuration
from iot_api_client.api import DashboardsV2Api
from iot_api_client.models import *
from iot_api_client.exceptions import ApiException

client_config = Configuration(host="https://api2.arduino.cc")
client_config.access_token = "JWT_ACCESS_TOKEN" 
client = iot.ApiClient(client_config)

# Create an instance of the API class
apiInstance = DashboardsV2Api(client)
id = id_example # String object instance | The id of the dashboard (default to null)
sharerequest =  # Sharerequest object instance | 
xOrganization = xOrganization_example # String object instance | Organization space identifer (optional) (optional) (default to null)

try:
    # requestAccess dashboards_v2
    apiInstance.dashboards_v2_request_access(id, sharerequest, xOrganization=xOrganization)
except ApiException as e:
    print("Exception when calling DashboardsV2Api->dashboardsV2RequestAccess: %s\n" % e)

extern crate DashboardsV2Api;

pub fn main() {
    let id = id_example; // String
    let sharerequest = ; // Sharerequest
    let xOrganization = xOrganization_example; // String

    let mut context = DashboardsV2Api::Context::default();
    let result = client.dashboardsV2RequestAccess(id, sharerequest, xOrganization, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
id*	String The id of the dashboard Required

Header parameters

Name	Description
X-Organization	String Organization space identifer (optional)

Body parameters

Name	Description
sharerequest *

Responses

Schema

Schema

Schema

Schema

dashboardsV2Share

share dashboards_v2

Share a dashboard

/iot/v2/dashboards/{id}/shares

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/vnd.goa.error+json,text/plain" \
 -H "Content-Type: application/json" \
 "https://api2.arduino.cc/iot/v2/dashboards/{id}/shares" \
 -d ''

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DashboardsV2Api;

import java.io.File;
import java.util.*;

public class DashboardsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DashboardsV2Api apiInstance = new DashboardsV2Api();
        String id = id_example; // String | The id of the dashboard
        Dashboardshare dashboardshare = ; // Dashboardshare | 
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            apiInstance.dashboardsV2Share(id, dashboardshare, xOrganization);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsV2Api#dashboardsV2Share");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String id = new String(); // String | The id of the dashboard
final Dashboardshare dashboardshare = new Dashboardshare(); // Dashboardshare | 
final String xOrganization = new String(); // String | Organization space identifer (optional)

try {
    final result = await api_instance.dashboardsV2Share(id, dashboardshare, xOrganization);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->dashboardsV2Share: $e\n');
}

import org.openapitools.client.api.DashboardsV2Api;

public class DashboardsV2ApiExample {
    public static void main(String[] args) {
        DashboardsV2Api apiInstance = new DashboardsV2Api();
        String id = id_example; // String | The id of the dashboard
        Dashboardshare dashboardshare = ; // Dashboardshare | 
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            apiInstance.dashboardsV2Share(id, dashboardshare, xOrganization);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsV2Api#dashboardsV2Share");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DashboardsV2Api *apiInstance = [[DashboardsV2Api alloc] init];
String *id = id_example; // The id of the dashboard (default to null)
Dashboardshare *dashboardshare = ; // 
String *xOrganization = xOrganization_example; // Organization space identifer (optional) (optional) (default to null)

// share dashboards_v2
[apiInstance dashboardsV2ShareWith:id
    dashboardshare:dashboardshare
    xOrganization:xOrganization
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var ArduinoIotClient = require('@arduino/arduino-iot-client');
var defaultClient = ArduinoIotClient.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new ArduinoIotClient.DashboardsV2Api()
var id = id_example; // {String} The id of the dashboard
var dashboardshare = ; // {Dashboardshare} 
var opts = {
  'xOrganization': xOrganization_example // {String} Organization space identifer (optional)
};
api.dashboardsV2Share(id, dashboardshare, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using iot.Api;
using iot.Client;
using iot.Model;

namespace Example
{
    public class dashboardsV2ShareExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DashboardsV2Api();
            var id = id_example;  // String | The id of the dashboard (default to null)
            var dashboardshare = new Dashboardshare(); // Dashboardshare | 
            var xOrganization = xOrganization_example;  // String | Organization space identifer (optional) (optional)  (default to null)

            try {
                // share dashboards_v2
                apiInstance.dashboardsV2Share(id, dashboardshare, xOrganization);
            } catch (Exception e) {
                Debug.Print("Exception when calling DashboardsV2Api.dashboardsV2Share: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DashboardsV2Api();
$id = id_example; // String | The id of the dashboard
$dashboardshare = ; // Dashboardshare | 
$xOrganization = xOrganization_example; // String | Organization space identifer (optional)

try {
    $api_instance->dashboardsV2Share($id, $dashboardshare, $xOrganization);
} catch (Exception $e) {
    echo 'Exception when calling DashboardsV2Api->dashboardsV2Share: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DashboardsV2Api;

# Configure OAuth2 access token for authorization: oauth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DashboardsV2Api->new();
my $id = id_example; # String | The id of the dashboard
my $dashboardshare = WWW::OPenAPIClient::Object::Dashboardshare->new(); # Dashboardshare | 
my $xOrganization = xOrganization_example; # String | Organization space identifer (optional)

eval {
    $api_instance->dashboardsV2Share(id => $id, dashboardshare => $dashboardshare, xOrganization => $xOrganization);
};
if ($@) {
    warn "Exception when calling DashboardsV2Api->dashboardsV2Share: $@\n";
}

import iot_api_client as iot
from iot_api_client.configuration import Configuration
from iot_api_client.api import DashboardsV2Api
from iot_api_client.models import *
from iot_api_client.exceptions import ApiException

client_config = Configuration(host="https://api2.arduino.cc")
client_config.access_token = "JWT_ACCESS_TOKEN" 
client = iot.ApiClient(client_config)

# Create an instance of the API class
apiInstance = DashboardsV2Api(client)
id = id_example # String object instance | The id of the dashboard (default to null)
dashboardshare =  # Dashboardshare object instance | 
xOrganization = xOrganization_example # String object instance | Organization space identifer (optional) (optional) (default to null)

try:
    # share dashboards_v2
    apiInstance.dashboards_v2_share(id, dashboardshare, xOrganization=xOrganization)
except ApiException as e:
    print("Exception when calling DashboardsV2Api->dashboardsV2Share: %s\n" % e)

extern crate DashboardsV2Api;

pub fn main() {
    let id = id_example; // String
    let dashboardshare = ; // Dashboardshare
    let xOrganization = xOrganization_example; // String

    let mut context = DashboardsV2Api::Context::default();
    let result = client.dashboardsV2Share(id, dashboardshare, xOrganization, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
id*	String The id of the dashboard Required

Header parameters

Name	Description
X-Organization	String Organization space identifer (optional)

Body parameters

Name	Description
dashboardshare *

Responses

Schema

Schema

Schema

Schema

dashboardsV2Show

show dashboards_v2

Show a dashboard by id

/iot/v2/dashboards/{id}

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/vnd.arduino.dashboardv2+json,application/vnd.goa.error+json" \
 "https://api2.arduino.cc/iot/v2/dashboards/{id}"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DashboardsV2Api;

import java.io.File;
import java.util.*;

public class DashboardsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DashboardsV2Api apiInstance = new DashboardsV2Api();
        String id = id_example; // String | The id of the dashboard
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            ArduinoDashboardv2 result = apiInstance.dashboardsV2Show(id, xOrganization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsV2Api#dashboardsV2Show");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String id = new String(); // String | The id of the dashboard
final String xOrganization = new String(); // String | Organization space identifer (optional)

try {
    final result = await api_instance.dashboardsV2Show(id, xOrganization);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->dashboardsV2Show: $e\n');
}

import org.openapitools.client.api.DashboardsV2Api;

public class DashboardsV2ApiExample {
    public static void main(String[] args) {
        DashboardsV2Api apiInstance = new DashboardsV2Api();
        String id = id_example; // String | The id of the dashboard
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            ArduinoDashboardv2 result = apiInstance.dashboardsV2Show(id, xOrganization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsV2Api#dashboardsV2Show");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DashboardsV2Api *apiInstance = [[DashboardsV2Api alloc] init];
String *id = id_example; // The id of the dashboard (default to null)
String *xOrganization = xOrganization_example; // Organization space identifer (optional) (optional) (default to null)

// show dashboards_v2
[apiInstance dashboardsV2ShowWith:id
    xOrganization:xOrganization
              completionHandler: ^(ArduinoDashboardv2 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var ArduinoIotClient = require('@arduino/arduino-iot-client');
var defaultClient = ArduinoIotClient.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new ArduinoIotClient.DashboardsV2Api()
var id = id_example; // {String} The id of the dashboard
var opts = {
  'xOrganization': xOrganization_example // {String} Organization space identifer (optional)
};
api.dashboardsV2Show(id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using iot.Api;
using iot.Client;
using iot.Model;

namespace Example
{
    public class dashboardsV2ShowExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DashboardsV2Api();
            var id = id_example;  // String | The id of the dashboard (default to null)
            var xOrganization = xOrganization_example;  // String | Organization space identifer (optional) (optional)  (default to null)

            try {
                // show dashboards_v2
                ArduinoDashboardv2 result = apiInstance.dashboardsV2Show(id, xOrganization);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DashboardsV2Api.dashboardsV2Show: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DashboardsV2Api();
$id = id_example; // String | The id of the dashboard
$xOrganization = xOrganization_example; // String | Organization space identifer (optional)

try {
    $result = $api_instance->dashboardsV2Show($id, $xOrganization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardsV2Api->dashboardsV2Show: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DashboardsV2Api;

# Configure OAuth2 access token for authorization: oauth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DashboardsV2Api->new();
my $id = id_example; # String | The id of the dashboard
my $xOrganization = xOrganization_example; # String | Organization space identifer (optional)

eval {
    my $result = $api_instance->dashboardsV2Show(id => $id, xOrganization => $xOrganization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardsV2Api->dashboardsV2Show: $@\n";
}

import iot_api_client as iot
from iot_api_client.configuration import Configuration
from iot_api_client.api import DashboardsV2Api
from iot_api_client.models import *
from iot_api_client.exceptions import ApiException

client_config = Configuration(host="https://api2.arduino.cc")
client_config.access_token = "JWT_ACCESS_TOKEN" 
client = iot.ApiClient(client_config)

# Create an instance of the API class
apiInstance = DashboardsV2Api(client)
id = id_example # String object instance | The id of the dashboard (default to null)
xOrganization = xOrganization_example # String object instance | Organization space identifer (optional) (optional) (default to null)

try:
    # show dashboards_v2
    api_response = apiInstance.dashboards_v2_show(id, xOrganization=xOrganization)
    print(api_response)
except ApiException as e:
    print("Exception when calling DashboardsV2Api->dashboardsV2Show: %s\n" % e)

extern crate DashboardsV2Api;

pub fn main() {
    let id = id_example; // String
    let xOrganization = xOrganization_example; // String

    let mut context = DashboardsV2Api::Context::default();
    let result = client.dashboardsV2Show(id, xOrganization, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
id*	String The id of the dashboard Required

Header parameters

Name	Description
X-Organization	String Organization space identifer (optional)

Responses

Schema

Schema

Schema

Schema

dashboardsV2Template

template dashboards_v2

Get a template of the dashboard

/iot/v2/dashboards/{id}/template

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/vnd.arduino.dashboardv2template+json,application/vnd.goa.error+json" \
 "https://api2.arduino.cc/iot/v2/dashboards/{id}/template"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DashboardsV2Api;

import java.io.File;
import java.util.*;

public class DashboardsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DashboardsV2Api apiInstance = new DashboardsV2Api();
        String id = id_example; // String | The id of the dashboard
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            ArduinoDashboardv2template result = apiInstance.dashboardsV2Template(id, xOrganization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsV2Api#dashboardsV2Template");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String id = new String(); // String | The id of the dashboard
final String xOrganization = new String(); // String | Organization space identifer (optional)

try {
    final result = await api_instance.dashboardsV2Template(id, xOrganization);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->dashboardsV2Template: $e\n');
}

import org.openapitools.client.api.DashboardsV2Api;

public class DashboardsV2ApiExample {
    public static void main(String[] args) {
        DashboardsV2Api apiInstance = new DashboardsV2Api();
        String id = id_example; // String | The id of the dashboard
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            ArduinoDashboardv2template result = apiInstance.dashboardsV2Template(id, xOrganization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsV2Api#dashboardsV2Template");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DashboardsV2Api *apiInstance = [[DashboardsV2Api alloc] init];
String *id = id_example; // The id of the dashboard (default to null)
String *xOrganization = xOrganization_example; // Organization space identifer (optional) (optional) (default to null)

// template dashboards_v2
[apiInstance dashboardsV2TemplateWith:id
    xOrganization:xOrganization
              completionHandler: ^(ArduinoDashboardv2template output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var ArduinoIotClient = require('@arduino/arduino-iot-client');
var defaultClient = ArduinoIotClient.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new ArduinoIotClient.DashboardsV2Api()
var id = id_example; // {String} The id of the dashboard
var opts = {
  'xOrganization': xOrganization_example // {String} Organization space identifer (optional)
};
api.dashboardsV2Template(id, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using iot.Api;
using iot.Client;
using iot.Model;

namespace Example
{
    public class dashboardsV2TemplateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DashboardsV2Api();
            var id = id_example;  // String | The id of the dashboard (default to null)
            var xOrganization = xOrganization_example;  // String | Organization space identifer (optional) (optional)  (default to null)

            try {
                // template dashboards_v2
                ArduinoDashboardv2template result = apiInstance.dashboardsV2Template(id, xOrganization);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DashboardsV2Api.dashboardsV2Template: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DashboardsV2Api();
$id = id_example; // String | The id of the dashboard
$xOrganization = xOrganization_example; // String | Organization space identifer (optional)

try {
    $result = $api_instance->dashboardsV2Template($id, $xOrganization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardsV2Api->dashboardsV2Template: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DashboardsV2Api;

# Configure OAuth2 access token for authorization: oauth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DashboardsV2Api->new();
my $id = id_example; # String | The id of the dashboard
my $xOrganization = xOrganization_example; # String | Organization space identifer (optional)

eval {
    my $result = $api_instance->dashboardsV2Template(id => $id, xOrganization => $xOrganization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardsV2Api->dashboardsV2Template: $@\n";
}

import iot_api_client as iot
from iot_api_client.configuration import Configuration
from iot_api_client.api import DashboardsV2Api
from iot_api_client.models import *
from iot_api_client.exceptions import ApiException

client_config = Configuration(host="https://api2.arduino.cc")
client_config.access_token = "JWT_ACCESS_TOKEN" 
client = iot.ApiClient(client_config)

# Create an instance of the API class
apiInstance = DashboardsV2Api(client)
id = id_example # String object instance | The id of the dashboard (default to null)
xOrganization = xOrganization_example # String object instance | Organization space identifer (optional) (optional) (default to null)

try:
    # template dashboards_v2
    api_response = apiInstance.dashboards_v2_template(id, xOrganization=xOrganization)
    print(api_response)
except ApiException as e:
    print("Exception when calling DashboardsV2Api->dashboardsV2Template: %s\n" % e)

extern crate DashboardsV2Api;

pub fn main() {
    let id = id_example; // String
    let xOrganization = xOrganization_example; // String

    let mut context = DashboardsV2Api::Context::default();
    let result = client.dashboardsV2Template(id, xOrganization, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
id*	String The id of the dashboard Required

Header parameters

Name	Description
X-Organization	String Organization space identifer (optional)

Responses

Schema

Schema

Schema

Schema

Schema

dashboardsV2Update

update dashboards_v2

Updates an existing dashboard

/iot/v2/dashboards/{id}

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/vnd.arduino.dashboardv2+json,application/vnd.goa.error+json" \
 -H "Content-Type: application/json" \
 "https://api2.arduino.cc/iot/v2/dashboards/{id}" \
 -d '{
  "soft_deleted" : false,
  "name" : "name",
  "cover_image" : "cover_image",
  "widgets" : [ {
    "height_mobile" : 6,
    "y_mobile" : 9,
    "variables" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "type" : "type",
    "x_mobile" : 2,
    "width_mobile" : 5,
    "name" : "name",
    "options" : {
      "key" : ""
    },
    "width" : 1,
    "x" : 5,
    "y" : 7,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "height" : 0
  }, {
    "height_mobile" : 6,
    "y_mobile" : 9,
    "variables" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
    "type" : "type",
    "x_mobile" : 2,
    "width_mobile" : 5,
    "name" : "name",
    "options" : {
      "key" : ""
    },
    "width" : 1,
    "x" : 5,
    "y" : 7,
    "id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "height" : 0
  } ]
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DashboardsV2Api;

import java.io.File;
import java.util.*;

public class DashboardsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DashboardsV2Api apiInstance = new DashboardsV2Api();
        String id = id_example; // String | The id of the dashboard
        Dashboardv2 dashboardv2 = ; // Dashboardv2 | 
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            ArduinoDashboardv2 result = apiInstance.dashboardsV2Update(id, dashboardv2, xOrganization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsV2Api#dashboardsV2Update");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String id = new String(); // String | The id of the dashboard
final Dashboardv2 dashboardv2 = new Dashboardv2(); // Dashboardv2 | 
final String xOrganization = new String(); // String | Organization space identifer (optional)

try {
    final result = await api_instance.dashboardsV2Update(id, dashboardv2, xOrganization);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->dashboardsV2Update: $e\n');
}

import org.openapitools.client.api.DashboardsV2Api;

public class DashboardsV2ApiExample {
    public static void main(String[] args) {
        DashboardsV2Api apiInstance = new DashboardsV2Api();
        String id = id_example; // String | The id of the dashboard
        Dashboardv2 dashboardv2 = ; // Dashboardv2 | 
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            ArduinoDashboardv2 result = apiInstance.dashboardsV2Update(id, dashboardv2, xOrganization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsV2Api#dashboardsV2Update");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DashboardsV2Api *apiInstance = [[DashboardsV2Api alloc] init];
String *id = id_example; // The id of the dashboard (default to null)
Dashboardv2 *dashboardv2 = ; // 
String *xOrganization = xOrganization_example; // Organization space identifer (optional) (optional) (default to null)

// update dashboards_v2
[apiInstance dashboardsV2UpdateWith:id
    dashboardv2:dashboardv2
    xOrganization:xOrganization
              completionHandler: ^(ArduinoDashboardv2 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var ArduinoIotClient = require('@arduino/arduino-iot-client');
var defaultClient = ArduinoIotClient.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new ArduinoIotClient.DashboardsV2Api()
var id = id_example; // {String} The id of the dashboard
var dashboardv2 = ; // {Dashboardv2} 
var opts = {
  'xOrganization': xOrganization_example // {String} Organization space identifer (optional)
};
api.dashboardsV2Update(id, dashboardv2, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using iot.Api;
using iot.Client;
using iot.Model;

namespace Example
{
    public class dashboardsV2UpdateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DashboardsV2Api();
            var id = id_example;  // String | The id of the dashboard (default to null)
            var dashboardv2 = new Dashboardv2(); // Dashboardv2 | 
            var xOrganization = xOrganization_example;  // String | Organization space identifer (optional) (optional)  (default to null)

            try {
                // update dashboards_v2
                ArduinoDashboardv2 result = apiInstance.dashboardsV2Update(id, dashboardv2, xOrganization);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DashboardsV2Api.dashboardsV2Update: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DashboardsV2Api();
$id = id_example; // String | The id of the dashboard
$dashboardv2 = ; // Dashboardv2 | 
$xOrganization = xOrganization_example; // String | Organization space identifer (optional)

try {
    $result = $api_instance->dashboardsV2Update($id, $dashboardv2, $xOrganization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardsV2Api->dashboardsV2Update: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DashboardsV2Api;

# Configure OAuth2 access token for authorization: oauth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DashboardsV2Api->new();
my $id = id_example; # String | The id of the dashboard
my $dashboardv2 = WWW::OPenAPIClient::Object::Dashboardv2->new(); # Dashboardv2 | 
my $xOrganization = xOrganization_example; # String | Organization space identifer (optional)

eval {
    my $result = $api_instance->dashboardsV2Update(id => $id, dashboardv2 => $dashboardv2, xOrganization => $xOrganization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardsV2Api->dashboardsV2Update: $@\n";
}

import iot_api_client as iot
from iot_api_client.configuration import Configuration
from iot_api_client.api import DashboardsV2Api
from iot_api_client.models import *
from iot_api_client.exceptions import ApiException

client_config = Configuration(host="https://api2.arduino.cc")
client_config.access_token = "JWT_ACCESS_TOKEN" 
client = iot.ApiClient(client_config)

# Create an instance of the API class
apiInstance = DashboardsV2Api(client)
id = id_example # String object instance | The id of the dashboard (default to null)
dashboardv2 =  # Dashboardv2 object instance | 
xOrganization = xOrganization_example # String object instance | Organization space identifer (optional) (optional) (default to null)

try:
    # update dashboards_v2
    api_response = apiInstance.dashboards_v2_update(id, dashboardv2, xOrganization=xOrganization)
    print(api_response)
except ApiException as e:
    print("Exception when calling DashboardsV2Api->dashboardsV2Update: %s\n" % e)

extern crate DashboardsV2Api;

pub fn main() {
    let id = id_example; // String
    let dashboardv2 = ; // Dashboardv2
    let xOrganization = xOrganization_example; // String

    let mut context = DashboardsV2Api::Context::default();
    let result = client.dashboardsV2Update(id, dashboardv2, xOrganization, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
id*	String The id of the dashboard Required

Header parameters

Name	Description
X-Organization	String Organization space identifer (optional)

Body parameters

Name	Description
dashboardv2 *	Describes a dashboard

Responses

Schema

Schema

Schema

Schema

Schema

DevicesV2

devicesV2Create

create devices_v2

Creates a new device associated to the user.

/iot/v2/devices

Usage and SDK Samples

curl -X PUT \
 \
 -H "Accept: application/vnd.arduino.devicev2+json,application/vnd.goa.error+json" \
 -H "Content-Type: application/json" \
 "https://api2.arduino.cc/iot/v2/devices" \
 -d '{
  "soft_deleted" : false,
  "connection_type" : "wifi",
  "serial" : "serial",
  "user_id" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "fqbn" : "fqbn",
  "name" : "name",
  "wifi_fw_version" : "wifi_fw_version",
  "type" : "mkrwifi1010"
}'

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DevicesV2Api;

import java.io.File;
import java.util.*;

public class DevicesV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DevicesV2Api apiInstance = new DevicesV2Api();
        CreateDevicesV2Payload createDevicesV2Payload = ; // CreateDevicesV2Payload | 
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            ArduinoDevicev2 result = apiInstance.devicesV2Create(createDevicesV2Payload, xOrganization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesV2Api#devicesV2Create");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final CreateDevicesV2Payload createDevicesV2Payload = new CreateDevicesV2Payload(); // CreateDevicesV2Payload | 
final String xOrganization = new String(); // String | Organization space identifer (optional)

try {
    final result = await api_instance.devicesV2Create(createDevicesV2Payload, xOrganization);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->devicesV2Create: $e\n');
}

import org.openapitools.client.api.DevicesV2Api;

public class DevicesV2ApiExample {
    public static void main(String[] args) {
        DevicesV2Api apiInstance = new DevicesV2Api();
        CreateDevicesV2Payload createDevicesV2Payload = ; // CreateDevicesV2Payload | 
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            ArduinoDevicev2 result = apiInstance.devicesV2Create(createDevicesV2Payload, xOrganization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesV2Api#devicesV2Create");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DevicesV2Api *apiInstance = [[DevicesV2Api alloc] init];
CreateDevicesV2Payload *createDevicesV2Payload = ; // 
String *xOrganization = xOrganization_example; // Organization space identifer (optional) (optional) (default to null)

// create devices_v2
[apiInstance devicesV2CreateWith:createDevicesV2Payload
    xOrganization:xOrganization
              completionHandler: ^(ArduinoDevicev2 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var ArduinoIotClient = require('@arduino/arduino-iot-client');
var defaultClient = ArduinoIotClient.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new ArduinoIotClient.DevicesV2Api()
var createDevicesV2Payload = ; // {CreateDevicesV2Payload} 
var opts = {
  'xOrganization': xOrganization_example // {String} Organization space identifer (optional)
};
api.devicesV2Create(createDevicesV2Payload, opts).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using iot.Api;
using iot.Client;
using iot.Model;

namespace Example
{
    public class devicesV2CreateExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DevicesV2Api();
            var createDevicesV2Payload = new CreateDevicesV2Payload(); // CreateDevicesV2Payload | 
            var xOrganization = xOrganization_example;  // String | Organization space identifer (optional) (optional)  (default to null)

            try {
                // create devices_v2
                ArduinoDevicev2 result = apiInstance.devicesV2Create(createDevicesV2Payload, xOrganization);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DevicesV2Api.devicesV2Create: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DevicesV2Api();
$createDevicesV2Payload = ; // CreateDevicesV2Payload | 
$xOrganization = xOrganization_example; // String | Organization space identifer (optional)

try {
    $result = $api_instance->devicesV2Create($createDevicesV2Payload, $xOrganization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DevicesV2Api->devicesV2Create: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DevicesV2Api;

# Configure OAuth2 access token for authorization: oauth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DevicesV2Api->new();
my $createDevicesV2Payload = WWW::OPenAPIClient::Object::CreateDevicesV2Payload->new(); # CreateDevicesV2Payload | 
my $xOrganization = xOrganization_example; # String | Organization space identifer (optional)

eval {
    my $result = $api_instance->devicesV2Create(createDevicesV2Payload => $createDevicesV2Payload, xOrganization => $xOrganization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicesV2Api->devicesV2Create: $@\n";
}

import iot_api_client as iot
from iot_api_client.configuration import Configuration
from iot_api_client.api import DevicesV2Api
from iot_api_client.models import *
from iot_api_client.exceptions import ApiException

client_config = Configuration(host="https://api2.arduino.cc")
client_config.access_token = "JWT_ACCESS_TOKEN" 
client = iot.ApiClient(client_config)

# Create an instance of the API class
apiInstance = DevicesV2Api(client)
createDevicesV2Payload =  # CreateDevicesV2Payload object instance | 
xOrganization = xOrganization_example # String object instance | Organization space identifer (optional) (optional) (default to null)

try:
    # create devices_v2
    api_response = apiInstance.devices_v2_create(createDevicesV2Payload, xOrganization=xOrganization)
    print(api_response)
except ApiException as e:
    print("Exception when calling DevicesV2Api->devicesV2Create: %s\n" % e)

extern crate DevicesV2Api;

pub fn main() {
    let createDevicesV2Payload = ; // CreateDevicesV2Payload
    let xOrganization = xOrganization_example; // String

    let mut context = DevicesV2Api::Context::default();
    let result = client.devicesV2Create(createDevicesV2Payload, xOrganization, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters

Name	Description
X-Organization	String Organization space identifer (optional)

Body parameters

Name	Description
createDevicesV2Payload *	DeviceV2 describes a device.

Responses

Schema

Schema

Schema

Schema

Schema

devicesV2Delete

delete devices_v2

Removes a device associated to the user

/iot/v2/devices/{id}

Usage and SDK Samples

curl -X DELETE \
 \
 -H "Accept: application/vnd.goa.error+json,text/plain" \
 "https://api2.arduino.cc/iot/v2/devices/{id}?force=true"

import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DevicesV2Api;

import java.io.File;
import java.util.*;

public class DevicesV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: oauth2
        OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
        oauth2.setAccessToken("YOUR ACCESS TOKEN");

        // Create an instance of the API class
        DevicesV2Api apiInstance = new DevicesV2Api();
        String id = id_example; // String | The id of the device
        Boolean force = true; // Boolean | If true, hard delete the device
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            apiInstance.devicesV2Delete(id, force, xOrganization);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesV2Api#devicesV2Delete");
            e.printStackTrace();
        }
    }
}

import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String id = new String(); // String | The id of the device
final Boolean force = new Boolean(); // Boolean | If true, hard delete the device
final String xOrganization = new String(); // String | Organization space identifer (optional)

try {
    final result = await api_instance.devicesV2Delete(id, force, xOrganization);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->devicesV2Delete: $e\n');
}

import org.openapitools.client.api.DevicesV2Api;

public class DevicesV2ApiExample {
    public static void main(String[] args) {
        DevicesV2Api apiInstance = new DevicesV2Api();
        String id = id_example; // String | The id of the device
        Boolean force = true; // Boolean | If true, hard delete the device
        String xOrganization = xOrganization_example; // String | Organization space identifer (optional)

        try {
            apiInstance.devicesV2Delete(id, force, xOrganization);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesV2Api#devicesV2Delete");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth2)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];


// Create an instance of the API class
DevicesV2Api *apiInstance = [[DevicesV2Api alloc] init];
String *id = id_example; // The id of the device (default to null)
Boolean *force = true; // If true, hard delete the device (optional) (default to false)
String *xOrganization = xOrganization_example; // Organization space identifer (optional) (optional) (default to null)

// delete devices_v2
[apiInstance devicesV2DeleteWith:id
    force:force
    xOrganization:xOrganization
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];

var ArduinoIotClient = require('@arduino/arduino-iot-client');
var defaultClient = ArduinoIotClient.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new ArduinoIotClient.DevicesV2Api()
var id = id_example; // {String} The id of the device
var opts = {
  'force': true, // {Boolean} If true, hard delete the device
  'xOrganization': xOrganization_example // {String} Organization space identifer (optional)
};
api.devicesV2Delete(id, opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

using System;
using System.Diagnostics;
using iot.Api;
using iot.Client;
using iot.Model;

namespace Example
{
    public class devicesV2DeleteExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: oauth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            // Create an instance of the API class
            var apiInstance = new DevicesV2Api();
            var id = id_example;  // String | The id of the device (default to null)
            var force = true;  // Boolean | If true, hard delete the device (optional)  (default to false)
            var xOrganization = xOrganization_example;  // String | Organization space identifer (optional) (optional)  (default to null)

            try {
                // delete devices_v2
                apiInstance.devicesV2Delete(id, force, xOrganization);
            } catch (Exception e) {
                Debug.Print("Exception when calling DevicesV2Api.devicesV2Delete: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DevicesV2Api();
$id = id_example; // String | The id of the device
$force = true; // Boolean | If true, hard delete the device
$xOrganization = xOrganization_example; // String | Organization space identifer (optional)

try {
    $api_instance->devicesV2Delete($id, $force, $xOrganization);
} catch (Exception $e) {
    echo 'Exception when calling DevicesV2Api->devicesV2Delete: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DevicesV2Api;

# Configure OAuth2 access token for authorization: oauth2
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DevicesV2Api->new();
my $id = id_example; # String | The id of the device
my $force = true; # Boolean | If true, hard delete the device
my $xOrganization = xOrganization_example; # String | Organization space identifer (optional)

eval {
    $api_instance->devicesV2Delete(id => $id, force => $force, xOrganization => $xOrganization);
};
if ($@) {
    warn "Exception when calling DevicesV2Api->devicesV2Delete: $@\n";
}

import iot_api_client as iot
from iot_api_client.configuration import Configuration
from iot_api_client.api import DevicesV2Api
from iot_api_client.models import *
from iot_api_client.exceptions import ApiException

client_config = Configuration(host="https://api2.arduino.cc")
client_config.access_token = "JWT_ACCESS_TOKEN" 
client = iot.ApiClient(client_config)

# Create an instance of the API class
apiInstance = DevicesV2Api(client)
id = id_example # String object instance | The id of the device (default to null)
force = true # Boolean object instance | If true, hard delete the device (optional) (default to false)
xOrganization = xOrganization_example # String object instance | Organization space identifer (optional) (optional) (default to null)

try:
    # delete devices_v2
    apiInstance.devices_v2_delete(id, force=force, xOrganization=xOrganization)
except ApiException as e:
    print("Exception when calling DevicesV2Api->devicesV2Delete: %s\n" % e)

extern crate DevicesV2Api;

pub fn main() {
    let id = id_example; // String
    let force = true; // Boolean
    let xOrganization = xOrganization_example; // String

    let mut context = DevicesV2Api::Context::default();
    let result = client.devicesV2Delete(id, force, xOrganization, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters

Name	Description
id*	String The id of the device Required

Header parameters

Name	Description
X-Organization	String Organization space identifer (optional)

Query parameters

Name	Description
force	Boolean If true, hard delete the device

Responses

Schema