Class API

Cockpit API.

This API allows you to manage your Scaleway Cockpit, for storing and visualizing metrics and logs.

Hierarchy

API
- API

Constructors

constructor

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

Methods

activateCockpit

activateCockpit(request?): Promise<Cockpit>
Activate the Cockpit of a given Project specified by the Project ID.
Parameters
- request: Readonly<ActivateCockpitRequest> = {}
  The request ActivateCockpitRequest
Returns Promise<Cockpit>
A Promise of Cockpit
- Defined in packages/clients/src/api/cockpit/v1beta1/api.gen.ts:100

createContactPoint

createContactPoint(request?): Promise<Cockpit.v1beta1.ContactPoint>
Create a contact point associated with the default receiver, to receive alerts.
Parameters
- request: Readonly<CreateContactPointRequest> = {}
  The request CreateContactPointRequest
Returns Promise<Cockpit.v1beta1.ContactPoint>
A Promise of ContactPoint
- Defined in packages/clients/src/api/cockpit/v1beta1/api.gen.ts:343

createDatasource

createDatasource(request): Promise<Datasource>
Create a data source for a given Project specified by the Project ID and the data source type.
Parameters
- request: Readonly<CreateDatasourceRequest>
  The request CreateDatasourceRequest
Returns Promise<Datasource>
A Promise of Datasource
- Defined in packages/clients/src/api/cockpit/v1beta1/api.gen.ts:203

createGrafanaUser

createGrafanaUser(request): Promise<Cockpit.v1beta1.GrafanaUser>
Create a Grafana user for your Cockpit's Grafana. Make sure you save the automatically-generated password and the Grafana user ID.
Parameters
- request: Readonly<CreateGrafanaUserRequest>
  The request CreateGrafanaUserRequest
Returns Promise<Cockpit.v1beta1.GrafanaUser>
A Promise of GrafanaUser
- Defined in packages/clients/src/api/cockpit/v1beta1/api.gen.ts:460

createToken

createToken(request?): Promise<Cockpit.v1beta1.Token>
Create a token in a given Project specified by the Project ID.
Parameters
- request: Readonly<Cockpit.v1beta1.CreateTokenRequest> = {}
  The request CreateTokenRequest
Returns Promise<Cockpit.v1beta1.Token>
A Promise of Token
- Defined in packages/clients/src/api/cockpit/v1beta1/api.gen.ts:267

deactivateCockpit

deactivateCockpit(request?): Promise<Cockpit>
Deactivate the Cockpit of a given Project specified by the Project ID.
Parameters
- request: Readonly<DeactivateCockpitRequest> = {}
  The request DeactivateCockpitRequest
Returns Promise<Cockpit>
A Promise of Cockpit
- Defined in packages/clients/src/api/cockpit/v1beta1/api.gen.ts:183

deleteContactPoint

deleteContactPoint(request?): Promise<void>
Delete a contact point associated with the default receiver.
Parameters
- request: Readonly<DeleteContactPointRequest> = {}
  The request DeleteContactPointRequest
Returns Promise<void>
- Defined in packages/clients/src/api/cockpit/v1beta1/api.gen.ts:393

deleteDatasource

deleteDatasource(request): Promise<void>
Delete a given data source specified by the data source ID.
Parameters
- request: Readonly<DeleteDatasourceRequest>
  The request DeleteDatasourceRequest
Returns Promise<void>
- Defined in packages/clients/src/api/cockpit/v1beta1/api.gen.ts:221

deleteGrafanaUser

deleteGrafanaUser(request): Promise<void>
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<DeleteGrafanaUserRequest>
  The request DeleteGrafanaUserRequest
Returns Promise<void>
- Defined in packages/clients/src/api/cockpit/v1beta1/api.gen.ts:511

deleteToken

deleteToken(request): Promise<void>
Delete a given token specified by the token ID.
Parameters
- request: Readonly<Cockpit.v1beta1.DeleteTokenRequest>
  The request DeleteTokenRequest
Returns Promise<void>
- Defined in packages/clients/src/api/cockpit/v1beta1/api.gen.ts:330

disableManagedAlerts

disableManagedAlerts(request?): Promise<void>
Disable the sending of managed alerts for a given Cockpit, specified by the ID of the Project the Cockpit belongs to.
Parameters
- request: Readonly<DisableManagedAlertsRequest> = {}
  The request DisableManagedAlertsRequest
Returns Promise<void>
- Defined in packages/clients/src/api/cockpit/v1beta1/api.gen.ts:425

enableManagedAlerts

enableManagedAlerts(request?): Promise<void>
Enable the sending of managed alerts for a given Cockpit, specified by the ID of the Project the Cockpit belongs to.
Parameters
- request: Readonly<EnableManagedAlertsRequest> = {}
  The request EnableManagedAlertsRequest
Returns Promise<void>
- Defined in packages/clients/src/api/cockpit/v1beta1/api.gen.ts:409

getCockpit

getCockpit(request?): Promise<Cockpit>
Retrieve the Cockpit of a given Project specified by the Project ID.
Parameters
- request: Readonly<GetCockpitRequest> = {}
  The request GetCockpitRequest
Returns Promise<Cockpit>
A Promise of Cockpit
- Defined in packages/clients/src/api/cockpit/v1beta1/api.gen.ts:119

getCockpitMetrics

getCockpitMetrics(request?): Promise<CockpitMetrics>
Retrieve metrics from your Cockpit specified by the ID of the Project the Cockpit belongs to.
Parameters
- request: Readonly<GetCockpitMetricsRequest> = {}
  The request GetCockpitMetricsRequest
Returns Promise<CockpitMetrics>
A Promise of CockpitMetrics
- Defined in packages/clients/src/api/cockpit/v1beta1/api.gen.ts:159

getGrafanaProductDashboard

getGrafanaProductDashboard(request): Promise<Cockpit.v1beta1.GrafanaProductDashboard>
Get a product dashboard. Get a product dashboard specified by the dashboard ID.
Parameters
- request: Readonly<GetGrafanaProductDashboardRequest>
  The request GetGrafanaProductDashboardRequest
Returns Promise<Cockpit.v1beta1.GrafanaProductDashboard>
A Promise of GrafanaProductDashboard
- Defined in packages/clients/src/api/cockpit/v1beta1/api.gen.ts:634

getToken

getToken(request): Promise<Cockpit.v1beta1.Token>
Retrieve a given token specified by the token ID.
Parameters
- request: Readonly<Cockpit.v1beta1.GetTokenRequest>
  The request GetTokenRequest
Returns Promise<Cockpit.v1beta1.Token>
A Promise of Token
- Defined in packages/clients/src/api/cockpit/v1beta1/api.gen.ts:316

listContactPoints

listContactPoints(request?): Promise<Cockpit.v1beta1.ListContactPointsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Cockpit.v1beta1.ContactPoint[], void, void>);
all: (() => Promise<Cockpit.v1beta1.ContactPoint[]>);
}
Get a list of contact points created for a given Cockpit, specified by the ID of the Project the Cockpit belongs to.
Parameters
- request: Readonly<ListContactPointsRequest> = {}
  The request ListContactPointsRequest
Returns Promise<Cockpit.v1beta1.ListContactPointsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Cockpit.v1beta1.ContactPoint[], void, void>);
all: (() => Promise<Cockpit.v1beta1.ContactPoint[]>);
}
A Promise of ListContactPointsResponse
- Defined in packages/clients/src/api/cockpit/v1beta1/api.gen.ts:385

listDatasources

listDatasources(request?): Promise<ListDatasourcesResponse> & {
[asyncIterator]: (() => AsyncGenerator<Datasource[], void, void>);
all: (() => Promise<Datasource[]>);
}
Get a list of data sources for the specified Project ID.
Parameters
- request: Readonly<ListDatasourcesRequest> = {}
  The request ListDatasourcesRequest
Returns Promise<ListDatasourcesResponse> & {
[asyncIterator]: (() => AsyncGenerator<Datasource[], void, void>);
all: (() => Promise<Datasource[]>);
}
A Promise of ListDatasourcesResponse
- Defined in packages/clients/src/api/cockpit/v1beta1/api.gen.ts:258

listGrafanaProductDashboards

listGrafanaProductDashboards(request?): Promise<Cockpit.v1beta1.ListGrafanaProductDashboardsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Cockpit.v1beta1.GrafanaProductDashboard[], void, void>);
all: (() => Promise<Cockpit.v1beta1.GrafanaProductDashboard[]>);
}
List product dashboards. Get a list of available product dashboards.
Parameters
- request: Readonly<ListGrafanaProductDashboardsRequest> = {}
  The request ListGrafanaProductDashboardsRequest
Returns Promise<Cockpit.v1beta1.ListGrafanaProductDashboardsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Cockpit.v1beta1.GrafanaProductDashboard[], void, void>);
all: (() => Promise<Cockpit.v1beta1.GrafanaProductDashboard[]>);
}
A Promise of ListGrafanaProductDashboardsResponse
- Defined in packages/clients/src/api/cockpit/v1beta1/api.gen.ts:618

listGrafanaUsers

listGrafanaUsers(request?): Promise<Cockpit.v1beta1.ListGrafanaUsersResponse> & {
[asyncIterator]: (() => AsyncGenerator<Cockpit.v1beta1.GrafanaUser[], void, void>);
all: (() => Promise<Cockpit.v1beta1.GrafanaUser[]>);
}
Get a list of all Grafana users created in your Cockpit's Grafana.
Parameters
- request: Readonly<ListGrafanaUsersRequest> = {}
  The request ListGrafanaUsersRequest
Returns Promise<Cockpit.v1beta1.ListGrafanaUsersResponse> & {
[asyncIterator]: (() => AsyncGenerator<Cockpit.v1beta1.GrafanaUser[], void, void>);
all: (() => Promise<Cockpit.v1beta1.GrafanaUser[]>);
}
A Promise of ListGrafanaUsersResponse
- Defined in packages/clients/src/api/cockpit/v1beta1/api.gen.ts:502

listPlans

listPlans(request?): Promise<Cockpit.v1beta1.ListPlansResponse> & {
[asyncIterator]: (() => AsyncGenerator<Cockpit.v1beta1.Plan[], void, void>);
all: (() => Promise<Cockpit.v1beta1.Plan[]>);
}
Get a list of all pricing plans available.
Parameters
- request: Readonly<ListPlansRequest> = {}
  The request ListPlansRequest
Returns Promise<Cockpit.v1beta1.ListPlansResponse> & {
[asyncIterator]: (() => AsyncGenerator<Cockpit.v1beta1.Plan[], void, void>);
all: (() => Promise<Cockpit.v1beta1.Plan[]>);
}
A Promise of ListPlansResponse
- Defined in packages/clients/src/api/cockpit/v1beta1/api.gen.ts:566

listTokens

listTokens(request?): Promise<Cockpit.v1beta1.ListTokensResponse> & {
[asyncIterator]: (() => AsyncGenerator<Cockpit.v1beta1.Token[], void, void>);
all: (() => Promise<Cockpit.v1beta1.Token[]>);
}
Get a list of tokens in a given Project specified by the Project ID.
Parameters
- request: Readonly<Cockpit.v1beta1.ListTokensRequest> = {}
  The request ListTokensRequest
Returns Promise<Cockpit.v1beta1.ListTokensResponse> & {
[asyncIterator]: (() => AsyncGenerator<Cockpit.v1beta1.Token[], void, void>);
all: (() => Promise<Cockpit.v1beta1.Token[]>);
}
A Promise of ListTokensResponse
- Defined in packages/clients/src/api/cockpit/v1beta1/api.gen.ts:307

resetGrafanaUserPassword

resetGrafanaUserPassword(request): Promise<Cockpit.v1beta1.GrafanaUser>
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.
Parameters
- request: Readonly<ResetGrafanaUserPasswordRequest>
  The request ResetGrafanaUserPasswordRequest
Returns Promise<Cockpit.v1beta1.GrafanaUser>
A Promise of GrafanaUser
- Defined in packages/clients/src/api/cockpit/v1beta1/api.gen.ts:528

selectPlan

selectPlan(request): Promise<SelectPlanResponse>
Select your chosen pricing plan for your Cockpit, specifying the Cockpit's Project ID and the pricing plan's ID in the request.
Parameters
- request: Readonly<Cockpit.v1beta1.SelectPlanRequest>
  The request SelectPlanRequest
Returns Promise<SelectPlanResponse>
A Promise of SelectPlanResponse
- Defined in packages/clients/src/api/cockpit/v1beta1/api.gen.ts:576

triggerTestAlert

triggerTestAlert(request?): Promise<void>
Send a test alert to make sure your contact points get notified when an actual alert is triggered.
Parameters
- request: Readonly<TriggerTestAlertRequest> = {}
  The request TriggerTestAlertRequest
Returns Promise<void>
- Defined in packages/clients/src/api/cockpit/v1beta1/api.gen.ts:443

waitForCockpit

waitForCockpit(request?, options?): Promise<Cockpit>
Waits for Cockpit to be in a final state.
Parameters
- request: Readonly<GetCockpitRequest> = {}
  The request GetCockpitRequest
- Optionaloptions: Readonly<WaitForOptions<Cockpit>>
  The waiting options
Returns Promise<Cockpit>
A Promise of Cockpit
- Defined in packages/clients/src/api/cockpit/v1beta1/api.gen.ts:139

Class API

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Cockpit.v1beta1.API

Methods

activateCockpit

Parameters

Returns Promise<Cockpit>

createContactPoint

Parameters

Returns Promise<Cockpit.v1beta1.ContactPoint>

createDatasource

Parameters

Returns Promise<Datasource>

createGrafanaUser

Parameters

Returns Promise<Cockpit.v1beta1.GrafanaUser>

createToken

Parameters

Returns Promise<Cockpit.v1beta1.Token>

deactivateCockpit

Parameters

Returns Promise<Cockpit>

deleteContactPoint

Parameters

Returns Promise<void>

deleteDatasource

Parameters

Returns Promise<void>

deleteGrafanaUser

Parameters

Returns Promise<void>

deleteToken

Parameters

Returns Promise<void>

disableManagedAlerts

Parameters

Returns Promise<void>

enableManagedAlerts

Parameters

Returns Promise<void>

getCockpit

Parameters

Returns Promise<Cockpit>

getCockpitMetrics

Parameters

Returns Promise<CockpitMetrics>

getGrafanaProductDashboard

Parameters

Returns Promise<Cockpit.v1beta1.GrafanaProductDashboard>

getToken

Parameters

Returns Promise<Cockpit.v1beta1.Token>

listContactPoints

Parameters

Returns Promise<Cockpit.v1beta1.ListContactPointsResponse> & { [asyncIterator]: (() => AsyncGenerator<Cockpit.v1beta1.ContactPoint[], void, void>); all: (() => Promise<Cockpit.v1beta1.ContactPoint[]>); }

listDatasources

Parameters

Returns Promise<ListDatasourcesResponse> & { [asyncIterator]: (() => AsyncGenerator<Datasource[], void, void>); all: (() => Promise<Datasource[]>); }

listGrafanaProductDashboards

Parameters

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

listGrafanaUsers

Parameters

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

listPlans

Parameters

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

listTokens

Parameters

Returns Promise<Cockpit.v1beta1.ListTokensResponse> & { [asyncIterator]: (() => AsyncGenerator<Cockpit.v1beta1.Token[], void, void>); all: (() => Promise<Cockpit.v1beta1.Token[]>); }

resetGrafanaUserPassword

Parameters

Returns Promise<Cockpit.v1beta1.GrafanaUser>

selectPlan

Returns Promise<Cockpit.v1beta1.ListContactPointsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Cockpit.v1beta1.ContactPoint[], void, void>);
all: (() => Promise<Cockpit.v1beta1.ContactPoint[]>);
}

Returns Promise<ListDatasourcesResponse> & {
[asyncIterator]: (() => AsyncGenerator<Datasource[], void, void>);
all: (() => Promise<Datasource[]>);
}

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

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

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

Returns Promise<Cockpit.v1beta1.ListTokensResponse> & {
[asyncIterator]: (() => AsyncGenerator<Cockpit.v1beta1.Token[], void, void>);
all: (() => Promise<Cockpit.v1beta1.Token[]>);
}