Skip to content

Latest commit

 

History

History
187 lines (114 loc) · 4.34 KB

ObservabilityCustomDashboardsApi.md

File metadata and controls

187 lines (114 loc) · 4.34 KB
Raw

ObservabilityCustomDashboardsApi

Note

All URIs are relative to https://api.fastly.com

Method HTTP request Description
create_dashboard POST /observability/dashboards Create a new dashboard
delete_dashboard DELETE /observability/dashboards/{dashboard_id} Delete an existing dashboard
get_dashboard GET /observability/dashboards/{dashboard_id} Retrieve a dashboard by ID
list_dashboards GET /observability/dashboards List all custom dashboards
update_dashboard PATCH /observability/dashboards/{dashboard_id} Update an existing dashboard

create_dashboard

Create a new dashboard

let cfg = &Configuration::default();
let params = CreateDashboardParams {
    // parameters
};
create_dashboard(cfg, params)

Parameters

Name Type Description Required Notes
create_dashboard_request Option<CreateDashboardRequest>

Return type

crate::models::Dashboard

Authorization

token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to README]

delete_dashboard

Delete an existing dashboard

let cfg = &Configuration::default();
let params = DeleteDashboardParams {
    // parameters
};
delete_dashboard(cfg, params)

Parameters

Name Type Description Required Notes
dashboard_id String [required]

Return type

(empty response body)

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to README]

get_dashboard

Retrieve a dashboard by ID

let cfg = &Configuration::default();
let params = GetDashboardParams {
    // parameters
};
get_dashboard(cfg, params)

Parameters

Name Type Description Required Notes
dashboard_id String [required]

Return type

crate::models::Dashboard

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to README]

list_dashboards

List all custom dashboards

let cfg = &Configuration::default();
let params = ListDashboardsParams {
    // parameters
};
list_dashboards(cfg, params)

Parameters

This endpoint does not need any parameter.

Return type

crate::models::ListDashboardsResponse

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to README]

update_dashboard

Update an existing dashboard

let cfg = &Configuration::default();
let params = UpdateDashboardParams {
    // parameters
};
update_dashboard(cfg, params)

Parameters

Name Type Description Required Notes
dashboard_id String [required]
update_dashboard_request Option<UpdateDashboardRequest>

Return type

crate::models::Dashboard

Authorization

token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to README]