Data sources

Download schema

Data sources are regional backends that allow you to store and query metrics, logs and traces. Data sources for Scaleway metrics and logs are enabled by default if you are using Scaleway resources which are integrated into Cockpit. You can create additional data sources to store and query metrics, logs and traces to push custom data.

List data sources

GET

https://api.scaleway.com

/cockpit/v1/regions/{region}/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.

List data sources › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

List data sources › query Parameters

project_id

string · required

Project ID to filter for, only data sources from this Project will be returned.

origin

string · enum

Origin to filter for, only data sources with matching origin will be returned. If omitted, all types will be returned.

Enum values:

unknown_origin

scaleway

external

custom

Default: unknown_origin

types

scaleway.cockpit.v1.DataSource.Type[]

Types to filter for (metrics, logs, traces), only data sources with matching types will be returned. If omitted, all types will be returned.

Enum values:

unknown_type

metrics

logs

traces

page

integer · int32

Page number to return, from the paginated results.

page_size

integer · uint32

Number of data sources to return per page.

order_by

string · enum

Sort order for data sources in the response.

Enum values:

created_at_asc

created_at_desc

name_asc

name_desc

type_asc

type_desc

Default: created_at_asc

List data sources › Responses

200

scaleway.cockpit.v1.ListDataSourcesResponse

total_count

integer · uint64

Total count of data sources matching the request.

scaleway.cockpit.v1.DataSource[]

Data sources matching the request within the pagination.

Create a data source

POST

https://api.scaleway.com

/cockpit/v1/regions/{region}/data-sources

You must specify the data source name and type (metrics, logs, traces) upon creation. The name of the data source will then be used as reference to name the associated Grafana data source.

Create a data source › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

Create a data source › Request Body

project_id

string · required

ID of the Project the data source belongs to.

name

string · required

Data source name.

type

string · enum · required

Data source type.

Enum values:

unknown_type

metrics

logs

traces

Default: unknown_type

retention_days

integer · uint32

Duration for which the data will be retained in the data source. Default values are 31 days for metrics, 7 days for logs and traces.

Create a data source › Responses

200

scaleway.cockpit.v1.DataSource

id

string

ID of the data source. (UUID format)

project_id

string

ID of the Project the data source belongs to. (UUID format)

name

string

Data source name.

url

string

Data source URL.

type

string · enum

Data source type.

Enum values:

unknown_type

metrics

logs

traces

Default: unknown_type

origin

string · enum

Data source origin.

Enum values:

unknown_origin

scaleway

external

custom

Default: unknown_origin

created_at

string · date-time

Date the data source was created. (RFC 3339 format)

updated_at

string · date-time

Date the data source was last updated. (RFC 3339 format)

synchronized_with_grafana

boolean

Indicates whether the data source is synchronized with Grafana.

retention_days

integer · uint32

Duration for which the data will be retained in the data source.

region

string

Region of the data source.

current_month_usage

integer · uint64

Usage of the month in bytes. (in bytes)

POST/cockpit/v1/regions/{region}/data-sources

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "project_id": "string",
    "type": "unknown_type"
  }' \
  "https://api.scaleway.com/cockpit/v1/regions/{region}/data-sources"

Example Request Body

{
  "project_id": "project_id",
  "name": "name",
  "type": "unknown_type",
  "retention_days": 0
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "url": "url",
  "type": "unknown_type",
  "origin": "unknown_origin",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "synchronized_with_grafana": true,
  "retention_days": 0,
  "region": "region",
  "current_month_usage": 0
}

json

application/json

Get a data source

GET

https://api.scaleway.com

/cockpit/v1/regions/{region}/data-sources/{data_source_id}

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.

Get a data source › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

data_source_id

string · required

ID of the relevant data source.

Get a data source › Responses

200

scaleway.cockpit.v1.DataSource

id

string

ID of the data source. (UUID format)

project_id

string

ID of the Project the data source belongs to. (UUID format)

name

string

Data source name.

url

string

Data source URL.

type

string · enum

Data source type.

Enum values:

unknown_type

metrics

logs

traces

Default: unknown_type

origin

string · enum

Data source origin.

Enum values:

unknown_origin

scaleway

external

custom

Default: unknown_origin

created_at

string · date-time

Date the data source was created. (RFC 3339 format)

updated_at

string · date-time

Date the data source was last updated. (RFC 3339 format)

synchronized_with_grafana

boolean

Indicates whether the data source is synchronized with Grafana.

retention_days

integer · uint32

Duration for which the data will be retained in the data source.

region

string

Region of the data source.

current_month_usage

integer · uint64

Usage of the month in bytes. (in bytes)

Delete a data source

DELETE

https://api.scaleway.com

/cockpit/v1/regions/{region}/data-sources/{data_source_id}

Delete a given data source. Note that this action will permanently delete this data source and any data associated with it.

Delete a data source › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

data_source_id

string · required

ID of the data source to delete.

Delete a data source › Responses

No data returned

Update a data source

PATCH

https://api.scaleway.com

/cockpit/v1/regions/{region}/data-sources/{data_source_id}

Update a given data source attributes (name and/or retention_days).

Update a data source › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

data_source_id

string · required

ID of the data source to update.

Update a data source › Request Body

name

string

Updated name of the data source.

retention_days

integer · uint32

Duration for which the data will be retained in the data source.

Update a data source › Responses

200

scaleway.cockpit.v1.DataSource

id

string

ID of the data source. (UUID format)

project_id

string

ID of the Project the data source belongs to. (UUID format)

name

string

Data source name.

url

string

Data source URL.

type

string · enum

Data source type.

Enum values:

unknown_type

metrics

logs

traces

Default: unknown_type

origin

string · enum

Data source origin.

Enum values:

unknown_origin

scaleway

external

custom

Default: unknown_origin

created_at

string · date-time

Date the data source was created. (RFC 3339 format)

updated_at

string · date-time

Date the data source was last updated. (RFC 3339 format)

synchronized_with_grafana

boolean

Indicates whether the data source is synchronized with Grafana.

retention_days

integer · uint32

Duration for which the data will be retained in the data source.

region

string

Region of the data source.

current_month_usage

integer · uint64

Usage of the month in bytes. (in bytes)

Get data source usage overview

GET

https://api.scaleway.com

/cockpit/v1/regions/{region}/usage-overview

Retrieve the volume of data ingested for each of your data sources in the specified project and region.

Get data source usage overview › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

Get data source usage overview › query Parameters

project_id

string · required

interval

string

(in seconds)

Get data source usage overview › Responses

200

scaleway.cockpit.v1.UsageOverview

scaleway.cockpit.v1.Usage

GET/cockpit/v1/regions/{region}/usage-overview

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/cockpit/v1/regions/{region}/usage-overview?project_id=string"

Example Responses

{
  "scaleway_metrics_usage": {
    "data_source_id": "data_source_id",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d",
    "data_source_origin": "unknown_origin",
    "data_source_type": "unknown_type",
    "unit": "unknown_unit",
    "interval": "2.5s",
    "quantity_over_interval": 0,
    "region": "region"
  },
  "scaleway_logs_usage": {
    "data_source_id": "data_source_id",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d",
    "data_source_origin": "unknown_origin",
    "data_source_type": "unknown_type",
    "unit": "unknown_unit",
    "interval": "2.5s",
    "quantity_over_interval": 0,
    "region": "region"
  },
  "external_metrics_usage": {
    "data_source_id": "data_source_id",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d",
    "data_source_origin": "unknown_origin",
    "data_source_type": "unknown_type",
    "unit": "unknown_unit",
    "interval": "2.5s",
    "quantity_over_interval": 0,
    "region": "region"
  },
  "external_logs_usage": {
    "data_source_id": "data_source_id",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d",
    "data_source_origin": "unknown_origin",
    "data_source_type": "unknown_type",
    "unit": "unknown_unit",
    "interval": "2.5s",
    "quantity_over_interval": 0,
    "region": "region"
  },
  "external_traces_usage": {
    "data_source_id": "data_source_id",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d",
    "data_source_origin": "unknown_origin",
    "data_source_type": "unknown_type",
    "unit": "unknown_unit",
    "interval": "2.5s",
    "quantity_over_interval": 0,
    "region": "region"
  }
}

json

application/json

Tokens

List data sources

GET

https://api.scaleway.com

/cockpit/v1/regions/{region}/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.

List data sources › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

List data sources › query Parameters

project_id

string · required

Project ID to filter for, only data sources from this Project will be returned.

origin

string · enum

Origin to filter for, only data sources with matching origin will be returned. If omitted, all types will be returned.

Enum values:

unknown_origin

scaleway

external

custom

Default: unknown_origin

types

scaleway.cockpit.v1.DataSource.Type[]

Types to filter for (metrics, logs, traces), only data sources with matching types will be returned. If omitted, all types will be returned.

Enum values:

unknown_type

metrics

logs

traces

page

integer · int32

Page number to return, from the paginated results.

page_size

integer · uint32

Number of data sources to return per page.

order_by

string · enum

Sort order for data sources in the response.

Enum values:

created_at_asc

created_at_desc

name_asc

name_desc

type_asc

type_desc

Default: created_at_asc

List data sources › Responses

200

scaleway.cockpit.v1.ListDataSourcesResponse

total_count

integer · uint64

Total count of data sources matching the request.

scaleway.cockpit.v1.DataSource[]

Data sources matching the request within the pagination.

Create a data source

POST

https://api.scaleway.com

/cockpit/v1/regions/{region}/data-sources

You must specify the data source name and type (metrics, logs, traces) upon creation. The name of the data source will then be used as reference to name the associated Grafana data source.

Create a data source › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

Create a data source › Request Body

project_id

string · required

ID of the Project the data source belongs to.

name

string · required

Data source name.

type

string · enum · required

Data source type.

Enum values:

unknown_type

metrics

logs

traces

Default: unknown_type

retention_days

integer · uint32

Duration for which the data will be retained in the data source. Default values are 31 days for metrics, 7 days for logs and traces.

Create a data source › Responses

200

scaleway.cockpit.v1.DataSource

id

string

ID of the data source. (UUID format)

project_id

string

ID of the Project the data source belongs to. (UUID format)

name

string

Data source name.

url

string

Data source URL.

type

string · enum

Data source type.

Enum values:

unknown_type

metrics

logs

traces

Default: unknown_type

origin

string · enum

Data source origin.

Enum values:

unknown_origin

scaleway

external

custom

Default: unknown_origin

created_at

string · date-time

Date the data source was created. (RFC 3339 format)

updated_at

string · date-time

Date the data source was last updated. (RFC 3339 format)

synchronized_with_grafana

boolean

Indicates whether the data source is synchronized with Grafana.

retention_days

integer · uint32

Duration for which the data will be retained in the data source.

region

string

Region of the data source.

current_month_usage

integer · uint64

Usage of the month in bytes. (in bytes)

Get a data source

GET

https://api.scaleway.com

/cockpit/v1/regions/{region}/data-sources/{data_source_id}

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.

Get a data source › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

data_source_id

string · required

ID of the relevant data source.

Get a data source › Responses

200

scaleway.cockpit.v1.DataSource

id

string

ID of the data source. (UUID format)

project_id

string

ID of the Project the data source belongs to. (UUID format)

name

string

Data source name.

url

string

Data source URL.

type

string · enum

Data source type.

Enum values:

unknown_type

metrics

logs

traces

Default: unknown_type

origin

string · enum

Data source origin.

Enum values:

unknown_origin

scaleway

external

custom

Default: unknown_origin

created_at

string · date-time

Date the data source was created. (RFC 3339 format)

updated_at

string · date-time

Date the data source was last updated. (RFC 3339 format)

synchronized_with_grafana

boolean

Indicates whether the data source is synchronized with Grafana.

retention_days

integer · uint32

Duration for which the data will be retained in the data source.

region

string

Region of the data source.

current_month_usage

integer · uint64

Usage of the month in bytes. (in bytes)

Delete a data source

DELETE

https://api.scaleway.com

/cockpit/v1/regions/{region}/data-sources/{data_source_id}

Delete a given data source. Note that this action will permanently delete this data source and any data associated with it.

Delete a data source › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

data_source_id

string · required

ID of the data source to delete.

Delete a data source › Responses

No data returned

Update a data source

PATCH

https://api.scaleway.com

/cockpit/v1/regions/{region}/data-sources/{data_source_id}

Update a given data source attributes (name and/or retention_days).

Update a data source › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

data_source_id

string · required

ID of the data source to update.

Update a data source › Request Body

name

string

Updated name of the data source.

retention_days

integer · uint32

Duration for which the data will be retained in the data source.

Update a data source › Responses

200

scaleway.cockpit.v1.DataSource

id

string

ID of the data source. (UUID format)

project_id

string

ID of the Project the data source belongs to. (UUID format)

name

string

Data source name.

url

string

Data source URL.

type

string · enum

Data source type.

Enum values:

unknown_type

metrics

logs

traces

Default: unknown_type

origin

string · enum

Data source origin.

Enum values:

unknown_origin

scaleway

external

custom

Default: unknown_origin

created_at

string · date-time

Date the data source was created. (RFC 3339 format)

updated_at

string · date-time

Date the data source was last updated. (RFC 3339 format)

synchronized_with_grafana

boolean

Indicates whether the data source is synchronized with Grafana.

retention_days

integer · uint32

Duration for which the data will be retained in the data source.

region

string

Region of the data source.

current_month_usage

integer · uint64

Usage of the month in bytes. (in bytes)

Get data source usage overview

GET

https://api.scaleway.com

/cockpit/v1/regions/{region}/usage-overview

Retrieve the volume of data ingested for each of your data sources in the specified project and region.

Get data source usage overview › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

Get data source usage overview › query Parameters

project_id

string · required

interval

string

(in seconds)

Get data source usage overview › Responses

200

scaleway.cockpit.v1.UsageOverview

scaleway.cockpit.v1.Usage