Class RegionalAPI

constructor

• new RegionalAPI(client): RegionalAPI

• Parameters

  • client: Client

  Returns RegionalAPI

Static ReadonlyLOCALITIES

createContactPoint

• createContactPoint(request?): Promise<Cockpit.v1.ContactPoint>

• Create a contact point. Contact points are email addresses associated with the default receiver, that the Alert manager sends alerts to. The source of the alerts are data sources within the same Project and region as the Alert manager. If you need to receive alerts for other receivers, you can create additional contact points and receivers in Grafana. Make sure that you select the Scaleway Alert manager.

  Parameters

  • request: Readonly<RegionalApiCreateContactPointRequest> = {}

    The request RegionalApiCreateContactPointRequest

  Returns Promise<Cockpit.v1.ContactPoint>

  A Promise of ContactPoint

createDataSource

• createDataSource(request): Promise<DataSource>

• Create a data source. You must specify the data source type upon creation. Available data source types include:

  • Metrics
  • Logs
  • Traces The name of the data source will then be used as reference to name the associated Grafana data source.

  Parameters

  • request: Readonly<Cockpit.v1.RegionalApiCreateDataSourceRequest>

    The request RegionalApiCreateDataSourceRequest

  Returns Promise<DataSource>

  A Promise of DataSource

createToken

• createToken(request): Promise<Cockpit.v1.Token>

• Create a token. Give your token the relevant scopes to ensure it has the right permissions to interact with your data sources and the Alert manager. Make sure that you create your token in the same regions as the data sources you want to use it for. Upon creation, your token's secret key display only once. Make sure that you save it.

  Parameters

  • request: Readonly<Cockpit.v1.RegionalApiCreateTokenRequest>

    The request RegionalApiCreateTokenRequest

  Returns Promise<Cockpit.v1.Token>

  A Promise of Token

deleteContactPoint

• deleteContactPoint(request?): Promise<void>

• Delete a contact point. Delete a contact point associated with the default receiver.

  Parameters

  • request: Readonly<RegionalApiDeleteContactPointRequest> = {}

    The request RegionalApiDeleteContactPointRequest

  Returns Promise<void>

deleteDataSource

• deleteDataSource(request): Promise<void>

• Delete a data source. Delete a given data source, specified by the data source ID. Note that deleting a data source is irreversible, and cannot be undone.

  Parameters

  • request: Readonly<RegionalApiDeleteDataSourceRequest>

    The request RegionalApiDeleteDataSourceRequest

  Returns Promise<void>

deleteToken

• deleteToken(request): Promise<void>

• Delete a token. Delete a given token, specified by the token ID. Deleting a token is irreversible and cannot be undone.

  Parameters

  • request: Readonly<RegionalApiDeleteTokenRequest>

    The request RegionalApiDeleteTokenRequest

  Returns Promise<void>

disableAlertManager

• disableAlertManager(request?): Promise<AlertManager>

• Disable the Alert manager. Disabling the Alert manager deletes the contact points you have created and disables managed alerts in the specified Project and region.

  Parameters

  • request: Readonly<RegionalApiDisableAlertManagerRequest> = {}

    The request RegionalApiDisableAlertManagerRequest

  Returns Promise<AlertManager>

  A Promise of AlertManager

disableManagedAlerts

• disableManagedAlerts(request?): Promise<AlertManager>

• Disable managed alerts. Disable the sending of managed alerts for the specified Project.

  Parameters

  • request: Readonly<RegionalApiDisableManagedAlertsRequest> = {}

    The request RegionalApiDisableManagedAlertsRequest

  Returns Promise<AlertManager>

  A Promise of AlertManager

enableAlertManager

• enableAlertManager(request?): Promise<AlertManager>

• Enable the Alert manager. Enabling the Alert manager allows you to enable managed alerts and create contact points in the specified Project and region, to be notified when your Scaleway resources may require your attention.

  Parameters

  • request: Readonly<RegionalApiEnableAlertManagerRequest> = {}

    The request RegionalApiEnableAlertManagerRequest

  Returns Promise<AlertManager>

  A Promise of AlertManager

enableManagedAlerts

• enableManagedAlerts(request?): Promise<AlertManager>

• Enable managed alerts. Enable the sending of managed alerts for the specified Project. Managed alerts are predefined alerts that apply to Scaleway recources integrated with Cockpit by default.

  Parameters

  • request: Readonly<RegionalApiEnableManagedAlertsRequest> = {}

    The request RegionalApiEnableManagedAlertsRequest

  Returns Promise<AlertManager>

  A Promise of AlertManager

getAlertManager

• getAlertManager(request?): Promise<AlertManager>

• Get the Alert manager. Retrieve information about the Alert manager which is unique per Project and region. By default the Alert manager is disabled. The output returned displays a URL to access the Alert manager, and whether the Alert manager and managed alerts are enabled.

  Parameters

  • request: Readonly<RegionalApiGetAlertManagerRequest> = {}

    The request RegionalApiGetAlertManagerRequest

  Returns Promise<AlertManager>

  A Promise of AlertManager

getConfig

• getConfig(request?): Promise<GetConfigResponse>

• Get the Cockpit configuration.

  Parameters

  • request: Readonly<RegionalApiGetConfigRequest> = {}

    The request RegionalApiGetConfigRequest

  Returns Promise<GetConfigResponse>

  A Promise of GetConfigResponse

getDataSource

• getDataSource(request): Promise<DataSource>

• Get a data source. Retrieve information about a given data source, specified by the data source ID. The data source's information such as its name, type, URL, origin, and retention period, is returned.

  Parameters

  • request: Readonly<RegionalApiGetDataSourceRequest>

    The request RegionalApiGetDataSourceRequest

  Returns Promise<DataSource>

  A Promise of DataSource

getToken

• getToken(request): Promise<Cockpit.v1.Token>

• Get a token. Retrieve information about a given token, specified by the token ID. The token's information such as its scopes, is returned.

  Parameters

  • request: Readonly<RegionalApiGetTokenRequest>

    The request RegionalApiGetTokenRequest

  Returns Promise<Cockpit.v1.Token>

  A Promise of Token

getUsageOverview

• getUsageOverview(request?): Promise<UsageOverview>

• Get data source usage overview. Retrieve the data source usage overview per type for the specified Project.

  Parameters

  • request: Readonly<RegionalApiGetUsageOverviewRequest> = {}

    The request RegionalApiGetUsageOverviewRequest

  Returns Promise<UsageOverview>

  A Promise of UsageOverview

listContactPoints

• listContactPoints(request?): Promise<Cockpit.v1.ListContactPointsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Cockpit.v1.ContactPoint[], void, void>);
      all: (() => Promise<Cockpit.v1.ContactPoint[]>);
  }

• List contact points. Retrieve a list of contact points for the specified Project. The response lists all contact points and receivers created in Grafana or via the API.

  Parameters

  • request: Readonly<Cockpit.v1.RegionalApiListContactPointsRequest> = {}

    The request RegionalApiListContactPointsRequest

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

  A Promise of ListContactPointsResponse

listDataSources

• listDataSources(request?): Promise<ListDataSourcesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<DataSource[], void, void>);
      all: (() => Promise<DataSource[]>);
  }

• List data sources. Retrieve the list of data sources available in the specified region. By default, the data sources returned in the list are ordered by creation date, in ascending order. You can list data sources by Project, type and origin.

  Parameters

  • request: Readonly<Cockpit.v1.RegionalApiListDataSourcesRequest> = {}

    The request RegionalApiListDataSourcesRequest

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

  A Promise of ListDataSourcesResponse

listManagedAlerts

• listManagedAlerts(request?): Promise<ListManagedAlertsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Alert[], void, void>);
      all: (() => Promise<Alert[]>);
  }

• List managed alerts. List all managed alerts for the specified Project.

  Parameters

  • request: Readonly<Cockpit.v1.RegionalApiListManagedAlertsRequest> = {}

    The request RegionalApiListManagedAlertsRequest

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

  A Promise of ListManagedAlertsResponse

listTokens

• listTokens(request?): Promise<Cockpit.v1.ListTokensResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Cockpit.v1.Token[], void, void>);
      all: (() => Promise<Cockpit.v1.Token[]>);
  }

• List tokens. Retrieve a list of all tokens in the specified region. By default, tokens returned in the list are ordered by creation date, in ascending order. You can filter tokens by Project ID and token scopes.

  Parameters

  • request: Readonly<Cockpit.v1.RegionalApiListTokensRequest> = {}

    The request RegionalApiListTokensRequest

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

  A Promise of ListTokensResponse

triggerTestAlert

• triggerTestAlert(request?): Promise<void>

• Trigger a test alert. Send a test alert to the Alert manager to make sure your contact points get notified.

  Parameters

  • request: Readonly<RegionalApiTriggerTestAlertRequest> = {}

    The request RegionalApiTriggerTestAlertRequest

  Returns Promise<void>

updateDataSource

• updateDataSource(request): Promise<DataSource>

• Update a data source. Update a given data source name, specified by the data source ID.

  Parameters

  • request: Readonly<Cockpit.v1.RegionalApiUpdateDataSourceRequest>

    The request RegionalApiUpdateDataSourceRequest

  Returns Promise<DataSource>

  A Promise of DataSource