Skip to content

Latest commit

 

History

History
188 lines (137 loc) · 10.2 KB

README.md

File metadata and controls

188 lines (137 loc) · 10.2 KB
Raw

dashboards

Dashboards API

  • API version: 7.0.25

Manage ThousandEyes Dashboards.

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

  1. Java 11+
  2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependencies>
    <dependency>
        <groupId>com.thousandeyes.sdk</groupId>
        <artifactId>dashboards</artifactId>
        <version>version</version>
    </dependency>
    <dependency>
        <groupId>com.thousandeyes.sdk</groupId>
        <artifactId>client</artifactId>
        <version>version</version>
    </dependency>

    <!-- Example only, you can use your own client implementation -->
    <dependency>
        <groupId>com.thousandeyes.sdk</groupId>
        <artifactId>client-native</artifactId>
        <version>version</version>
    </dependency>
</dependencies>

Gradle users

Add this dependency to your project's build file:

implementation "com.thousandeyes.sdk:client:<version>"
implementation "com.thousandeyes.sdk:client-native:<version>" #Example only, you can use your own client implementation
implementation "com.thousandeyes.sdk:dashboards:<version>"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/dashboards-version.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import com.thousandeyes.sdk.*;
import com.thousandeyes.sdk.client.*;
import com.thousandeyes.sdk.dashboards.model.*;
import com.thousandeyes.sdk.dashboards.DashboardSnapshotsApi;

public class DashboardSnapshotsApiExample {

    public static void main(String[] args) {
        // Configure clients using the `defaultClient` object, such as
        // overriding the host and port, timeout, etc. In this example we are using the NativeApiClient
        // but you can use your own client implementation
        ApiClient defaultClient = NativeApiClient
                .builder()
                .baseUri("https://api.thousandeyes.com/v7")
                .bearerToken("<bearer-token>")
                .build();

        DashboardSnapshotsApi apiInstance = new DashboardSnapshotsApi(defaultClient);
        GenerateDashboardSnapshotRequest generateDashboardSnapshotRequest = new GenerateDashboardSnapshotRequest(); // GenerateDashboardSnapshotRequest | Request body schema to create a dashboard snapshot.
        String aid = "1234"; // String | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.
        try {
            DashboardSnapshotResponse result = apiInstance.createDashboardSnapshot(generateDashboardSnapshotRequest, aid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardSnapshotsApi#createDashboardSnapshot");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://api.thousandeyes.com/v7

Class Method HTTP request Description
DashboardSnapshotsApi createDashboardSnapshot POST /dashboard-snapshots Create dashboard snapshot
DashboardSnapshotsApi createDashboardSnapshotWithHttpInfo POST /dashboard-snapshots Create dashboard snapshot
DashboardSnapshotsApi deleteDashboardSnapshot DELETE /dashboard-snapshots/{snapshotId} Delete dashboard snapshot
DashboardSnapshotsApi deleteDashboardSnapshotWithHttpInfo DELETE /dashboard-snapshots/{snapshotId} Delete dashboard snapshot
DashboardSnapshotsApi getDashboardSnapshot GET /dashboard-snapshots/{snapshotId} Retrieve dashboard snapshot
DashboardSnapshotsApi getDashboardSnapshotWithHttpInfo GET /dashboard-snapshots/{snapshotId} Retrieve dashboard snapshot
DashboardSnapshotsApi getDashboardSnapshotWidgetData GET /dashboard-snapshots/{snapshotId}/widgets/{widgetId} Retrieve dashboard snapshot data
DashboardSnapshotsApi getDashboardSnapshotWidgetDataWithHttpInfo GET /dashboard-snapshots/{snapshotId}/widgets/{widgetId} Retrieve dashboard snapshot data
DashboardSnapshotsApi getDashboardSnapshots GET /dashboard-snapshots List dashboard snapshots
DashboardSnapshotsApi getDashboardSnapshotsWithHttpInfo GET /dashboard-snapshots List dashboard snapshots
DashboardSnapshotsApi updateDashboardSnapshotExpirationDate PATCH /dashboard-snapshots/{snapshotId} Update snapshot expiration
DashboardSnapshotsApi updateDashboardSnapshotExpirationDateWithHttpInfo PATCH /dashboard-snapshots/{snapshotId} Update snapshot expiration
DashboardsApi createDashboard POST /dashboards Create dashboard
DashboardsApi createDashboardWithHttpInfo POST /dashboards Create dashboard
DashboardsApi deleteDashboard DELETE /dashboards/{dashboardId} Delete dashboard
DashboardsApi deleteDashboardWithHttpInfo DELETE /dashboards/{dashboardId} Delete dashboard
DashboardsApi getDashboard GET /dashboards/{dashboardId} Retrieve dashboard
DashboardsApi getDashboardWithHttpInfo GET /dashboards/{dashboardId} Retrieve dashboard
DashboardsApi getDashboardWidgetData GET /dashboards/{dashboardId}/widgets/{widgetId} Retrieve dashboard widget data
DashboardsApi getDashboardWidgetDataWithHttpInfo GET /dashboards/{dashboardId}/widgets/{widgetId} Retrieve dashboard widget data
DashboardsApi getDashboards GET /dashboards List dashboards
DashboardsApi getDashboardsWithHttpInfo GET /dashboards List dashboards
DashboardsApi updateDashboard PUT /dashboards/{dashboardId} Update dashboard
DashboardsApi updateDashboardWithHttpInfo PUT /dashboards/{dashboardId} Update dashboard
DashboardsFiltersApi createDashboardFilter POST /dashboards/filters Create dashboard filter
DashboardsFiltersApi createDashboardFilterWithHttpInfo POST /dashboards/filters Create dashboard filter
DashboardsFiltersApi deleteDashboardFilter DELETE /dashboards/filters/{id} Delete dashboard filter
DashboardsFiltersApi deleteDashboardFilterWithHttpInfo DELETE /dashboards/filters/{id} Delete dashboard filter
DashboardsFiltersApi getDashboardFilter GET /dashboards/filters/{id} Get dashboard filter
DashboardsFiltersApi getDashboardFilterWithHttpInfo GET /dashboards/filters/{id} Get dashboard filter
DashboardsFiltersApi getDashboardsFilters GET /dashboards/filters List dashboard filters
DashboardsFiltersApi getDashboardsFiltersWithHttpInfo GET /dashboards/filters List dashboard filters
DashboardsFiltersApi updateDashboardFilter PUT /dashboards/filters/{id} Update dashboard filter
DashboardsFiltersApi updateDashboardFilterWithHttpInfo PUT /dashboards/filters/{id} Update dashboard filter

Documentation for Authorization

Authentication schemes defined for the API:

BearerAuth

  • Type: HTTP Bearer Token authentication

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues. However, the instances of the api clients created from the ApiClient are thread-safe and can be re-used.

Author