Class GlobalAPI

Cockpit Global API.

The Cockpit Global API allows you to manage your Cockpit's Grafana and plans.

Hierarchy

API
- GlobalAPI

Index

Constructors

Methods

createGrafanaUser deleteGrafanaUser getCurrentPlan getGrafana getGrafanaProductDashboard listGrafanaProductDashboards listGrafanaUsers listPlans resetGrafanaUserPassword selectPlan syncGrafanaDataSources

Constructors

constructor

new GlobalAPI(client): GlobalAPI
Parameters
- client: Client
Returns GlobalAPI
Inherited from ParentAPI.constructor
- Defined in packages/clients/src/scw/api.ts:9

Methods

createGrafanaUser

createGrafanaUser(request): Promise<Cockpit.v1.GrafanaUser>
Create a Grafana user. Create a Grafana user to connect to your Cockpit's Grafana. Upon creation, your user password displays only once, so make sure that you save it. Each Grafana user is associated with a role: viewer or editor. A viewer can only view dashboards, whereas an editor can create and edit dashboards. Note that the admin username is not available for creation.
Parameters
- request: Readonly<GlobalApiCreateGrafanaUserRequest>
  The request GlobalApiCreateGrafanaUserRequest
Returns Promise<Cockpit.v1.GrafanaUser>
A Promise of GrafanaUser
- Defined in packages/clients/src/api/cockpit/v1/api.gen.ts:159

deleteGrafanaUser

deleteGrafanaUser(request): Promise<void>
Delete a Grafana user. Delete a Grafana user from your Cockpit's Grafana, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user.
Parameters
- request: Readonly<GlobalApiDeleteGrafanaUserRequest>
  The request GlobalApiDeleteGrafanaUserRequest
Returns Promise<void>
- Defined in packages/clients/src/api/cockpit/v1/api.gen.ts:217

getCurrentPlan

getCurrentPlan(request?): Promise<Cockpit.v1.Plan>
Get current plan. Retrieve a pricing plan for the given Project, specified by the ID of the Project. Deprecated, retention is now managed at the data source level.
Parameters
- request: Readonly<GlobalApiGetCurrentPlanRequest> = {}
  The request GlobalApiGetCurrentPlanRequest
Returns Promise<Cockpit.v1.Plan>
A Promise of Plan

Deprecated
- Defined in packages/clients/src/api/cockpit/v1/api.gen.ts:381

getGrafana

getGrafana(request?): Promise<Grafana>
Get your Cockpit's Grafana. Retrieve information on your Cockpit's Grafana, specified by the ID of the Project the Cockpit belongs to. The output returned displays the URL to access your Cockpit's Grafana.
Parameters
- request: Readonly<GlobalApiGetGrafanaRequest> = {}
  The request GlobalApiGetGrafanaRequest
Returns Promise<Grafana>
A Promise of Grafana
- Defined in packages/clients/src/api/cockpit/v1/api.gen.ts:113

getGrafanaProductDashboard

getGrafanaProductDashboard(request): Promise<Cockpit.v1.GrafanaProductDashboard>
Get Scaleway resource dashboard. Retrieve information about the dashboard of a Scaleway resource in Grafana, specified by the ID of the Project the Cockpit belongs to, and the name of the dashboard.
Parameters
- request: Readonly<GlobalApiGetGrafanaProductDashboardRequest>
  The request GlobalApiGetGrafanaProductDashboardRequest
Returns Promise<Cockpit.v1.GrafanaProductDashboard>
A Promise of GrafanaProductDashboard
- Defined in packages/clients/src/api/cockpit/v1/api.gen.ts:304

listGrafanaProductDashboards

listGrafanaProductDashboards(request?): Promise<Cockpit.v1.ListGrafanaProductDashboardsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Cockpit.v1.GrafanaProductDashboard[], void, void>);
all: (() => Promise<Cockpit.v1.GrafanaProductDashboard[]>);
}
List Scaleway resources dashboards. Retrieve a list of available dashboards in Grafana, for all Scaleway resources which are integrated with Cockpit.
Parameters
- request: Readonly<GlobalApiListGrafanaProductDashboardsRequest> = {}
  The request GlobalApiListGrafanaProductDashboardsRequest
Returns Promise<Cockpit.v1.ListGrafanaProductDashboardsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Cockpit.v1.GrafanaProductDashboard[], void, void>);
all: (() => Promise<Cockpit.v1.GrafanaProductDashboard[]>);
}
A Promise of ListGrafanaProductDashboardsResponse
- Defined in packages/clients/src/api/cockpit/v1/api.gen.ts:286

listGrafanaUsers

listGrafanaUsers(request?): Promise<Cockpit.v1.ListGrafanaUsersResponse> & {
[asyncIterator]: (() => AsyncGenerator<Cockpit.v1.GrafanaUser[], void, void>);
all: (() => Promise<Cockpit.v1.GrafanaUser[]>);
}
List Grafana users. List all Grafana users created in your Cockpit's Grafana. By default, the Grafana users returned in the list are ordered in ascending order.
Parameters
- request: Readonly<GlobalApiListGrafanaUsersRequest> = {}
  The request GlobalApiListGrafanaUsersRequest
Returns Promise<Cockpit.v1.ListGrafanaUsersResponse> & {
[asyncIterator]: (() => AsyncGenerator<Cockpit.v1.GrafanaUser[], void, void>);
all: (() => Promise<Cockpit.v1.GrafanaUser[]>);
}
A Promise of ListGrafanaUsersResponse
- Defined in packages/clients/src/api/cockpit/v1/api.gen.ts:206

listPlans

listPlans(request?): Promise<Cockpit.v1.ListPlansResponse> & {
[asyncIterator]: (() => AsyncGenerator<Cockpit.v1.Plan[], void, void>);
all: (() => Promise<Cockpit.v1.Plan[]>);
}
List plan types. Retrieve a list of available pricing plan types. Deprecated, retention is now managed at the data source level.
Parameters
- request: Readonly<GlobalApiListPlansRequest> = {}
  The request GlobalApiListPlansRequest
Returns Promise<Cockpit.v1.ListPlansResponse> & {
[asyncIterator]: (() => AsyncGenerator<Cockpit.v1.Plan[], void, void>);
all: (() => Promise<Cockpit.v1.Plan[]>);
}
A Promise of ListPlansResponse

Deprecated
- Defined in packages/clients/src/api/cockpit/v1/api.gen.ts:346

resetGrafanaUserPassword

resetGrafanaUserPassword(request): Promise<Cockpit.v1.GrafanaUser>
Reset a Grafana user password. Reset the password of a Grafana user, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user. A new password regenerates and only displays once. Make sure that you save it.
Parameters
- request: Readonly<GlobalApiResetGrafanaUserPasswordRequest>
  The request GlobalApiResetGrafanaUserPasswordRequest
Returns Promise<Cockpit.v1.GrafanaUser>
A Promise of GrafanaUser
- Defined in packages/clients/src/api/cockpit/v1/api.gen.ts:237

selectPlan

selectPlan(request?): Promise<Cockpit.v1.Plan>
Apply a pricing plan. Apply a pricing plan on a given Project. You must specify the ID of the pricing plan type. Note that you will be billed for the plan you apply. Deprecated, retention is now managed at the data source level.
Parameters
- request: Readonly<GlobalApiSelectPlanRequest> = {}
  The request GlobalApiSelectPlanRequest
Returns Promise<Cockpit.v1.Plan>
A Promise of Plan

Deprecated
- Defined in packages/clients/src/api/cockpit/v1/api.gen.ts:359

syncGrafanaDataSources

syncGrafanaDataSources(request?): Promise<void>
Synchronize Grafana data sources. Trigger the synchronization of all your data sources and the alert manager in the relevant regions. The alert manager will only be synchronized if you have enabled it.
Parameters
- request: Readonly<GlobalApiSyncGrafanaDataSourcesRequest> = {}
  The request GlobalApiSyncGrafanaDataSourcesRequest
Returns Promise<void>
- Defined in packages/clients/src/api/cockpit/v1/api.gen.ts:133

Class GlobalAPI

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns GlobalAPI

Methods

createGrafanaUser

Parameters

Returns Promise<Cockpit.v1.GrafanaUser>

deleteGrafanaUser

Parameters

Returns Promise<void>

getCurrentPlan

Parameters

Returns Promise<Cockpit.v1.Plan>

Deprecated

getGrafana

Parameters

Returns Promise<Grafana>

getGrafanaProductDashboard

Parameters

Returns Promise<Cockpit.v1.GrafanaProductDashboard>

listGrafanaProductDashboards

Parameters

Returns Promise<Cockpit.v1.ListGrafanaProductDashboardsResponse> & { [asyncIterator]: (() => AsyncGenerator<Cockpit.v1.GrafanaProductDashboard[], void, void>); all: (() => Promise<Cockpit.v1.GrafanaProductDashboard[]>); }

listGrafanaUsers

Parameters

Returns Promise<Cockpit.v1.ListGrafanaUsersResponse> & { [asyncIterator]: (() => AsyncGenerator<Cockpit.v1.GrafanaUser[], void, void>); all: (() => Promise<Cockpit.v1.GrafanaUser[]>); }

listPlans

Parameters

Returns Promise<Cockpit.v1.ListPlansResponse> & { [asyncIterator]: (() => AsyncGenerator<Cockpit.v1.Plan[], void, void>); all: (() => Promise<Cockpit.v1.Plan[]>); }

Deprecated

resetGrafanaUserPassword

Parameters

Returns Promise<Cockpit.v1.GrafanaUser>

selectPlan

Parameters

Returns Promise<Cockpit.v1.Plan>

Deprecated

syncGrafanaDataSources

Parameters

Returns Promise<void>

Settings

On This Page

Returns Promise<Cockpit.v1.ListGrafanaProductDashboardsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Cockpit.v1.GrafanaProductDashboard[], void, void>);
all: (() => Promise<Cockpit.v1.GrafanaProductDashboard[]>);
}

Returns Promise<Cockpit.v1.ListGrafanaUsersResponse> & {
[asyncIterator]: (() => AsyncGenerator<Cockpit.v1.GrafanaUser[], void, void>);
all: (() => Promise<Cockpit.v1.GrafanaUser[]>);
}

Returns Promise<Cockpit.v1.ListPlansResponse> & {
[asyncIterator]: (() => AsyncGenerator<Cockpit.v1.Plan[], void, void>);
all: (() => Promise<Cockpit.v1.Plan[]>);
}