Data exporter

Download schema

The data exporter endpoints allow you to manage and send your Scaleway product's metrics and logs as data exports, to external destinations.

List data exports

GET

https://api.scaleway.com

/cockpit/v1/regions/{region}/exporters

List all data exports within a given Scaleway Project, specified by its ID. Optionally, specify a Scaleway data source ID to retrieve only data exports associated with that data source.

List data exports › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

List data exports › query Parameters

project_id

string · required

Project ID to filter for. Only data exports from this Project will be returned.

datasource_id

string

Data source ID to filter for. Only data exports linked to this data source will be returned.

page

integer · int32

Page number to return from the paginated results.

page_size

integer · uint32

Number of data exports to return per page.

order_by

string · enum

Sort order for data exports in the response.

Enum values:

created_at_asc

created_at_desc

name_asc

name_desc

Default: created_at_asc

List data exports › Responses

200

scaleway.cockpit.v1.ListExportersResponse

total_count

integer · uint64

Total count of data exports matching the request.

scaleway.cockpit.v1.Exporter[]

Data exports matching the request within the pagination.

GET/cockpit/v1/regions/{region}/exporters

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

Example Responses

{
  "total_count": 0,
  "exporters": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "name": "name",
      "description": "description",
      "datasource_id": "6170692e-7363-616c-6577-61792e636f6d",
      "datadog_destination": {
        "api_key": "api_key",
        "endpoint": "endpoint"
      },
      "otlp_destination": {
        "endpoint": "endpoint",
        "headers": {
          "<headerKey>": "<headerKey>"
        }
      },
      "status": "unknown_status",
      "exported_products": [
        "string"
      ],
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "region": "region"
    }
  ]
}

json

application/json

Create a data export

POST

https://api.scaleway.com

/cockpit/v1/regions/{region}/exporters

Create an export to send your metrics/logs from a Scaleway data source to an external destination. Current supported destination for data exports are Datadog and OTLP endpoints. This feature is in Beta phase. During Beta phase, exporter can take up to 30 min to be effectively active.

Create a data export › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

Create a data export › Request Body

datasource_id

string · required

ID of the data source linked to the data export.

exported_products

string[] · required

The list of products name your data export send to the destination. To include all products in your data export, you can use an array containing "all" You can retrieve the complete list of product names using the ListProducts endpoint.

name

string · required

Name of the data export.

object

Datadog destination configuration for the data export.

object

OTLP destination configuration for the data export.

description

string

Description of the data export.

Create a data export › Responses

200

scaleway.cockpit.v1.Exporter

id

string

ID of the data export. (UUID format)

name

string

Name of the data export.

description

string

Description of the data export.

datasource_id

string

ID of the data source linked to the data export. (UUID format)

object

Datadog destination configuration for the data export.

object

OTLP destination configuration for the data export.

status

string · enum

Status of the data export.

Enum values:

unknown_status

creating

ready

error

idle

Default: unknown_status

exported_products

string[]

List of Scaleway products name exported by the data export.

created_at

string · date-time

A timestamp of the creation date of the data export. (RFC 3339 format)

updated_at

string · date-time

A timestamp of the last update date of the data export. (RFC 3339 format)

region

string

The region in which the export is located.

POST/cockpit/v1/regions/{region}/exporters

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "datasource_id": "string",
    "exported_products": [
        "string"
    ],
    "name": "string"
  }' \
  "https://api.scaleway.com/cockpit/v1/regions/{region}/exporters"

Example Request Body

{
  "datasource_id": "datasource_id",
  "datadog_destination": {
    "api_key": "api_key",
    "endpoint": "endpoint"
  },
  "otlp_destination": {
    "endpoint": "endpoint",
    "headers": {
      "<headerKey>": "<headerKey>"
    }
  },
  "exported_products": [
    "string"
  ],
  "name": "name",
  "description": "description"
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "description": "description",
  "datasource_id": "6170692e-7363-616c-6577-61792e636f6d",
  "datadog_destination": {
    "api_key": "api_key",
    "endpoint": "endpoint"
  },
  "otlp_destination": {
    "endpoint": "endpoint",
    "headers": {
      "<headerKey>": "<headerKey>"
    }
  },
  "status": "unknown_status",
  "exported_products": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "region": "region"
}

json

application/json

Get a data export

GET

https://api.scaleway.com

/cockpit/v1/regions/{region}/exporters/{exporter_id}

Retrieve information about a given data export, specified by its ID.

Get a data export › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

exporter_id

string · required

ID of the data export to retrieve.

Get a data export › Responses

200

scaleway.cockpit.v1.Exporter

id

string

ID of the data export. (UUID format)

name

string

Name of the data export.

description

string

Description of the data export.

datasource_id

string

ID of the data source linked to the data export. (UUID format)

object

Datadog destination configuration for the data export.

object

OTLP destination configuration for the data export.

status

string · enum

Status of the data export.

Enum values:

unknown_status

creating

ready

error

idle

Default: unknown_status

exported_products

string[]

List of Scaleway products name exported by the data export.

created_at

string · date-time

A timestamp of the creation date of the data export. (RFC 3339 format)

updated_at

string · date-time

A timestamp of the last update date of the data export. (RFC 3339 format)

region

string

The region in which the export is located.

Delete a data export

DELETE

https://api.scaleway.com

/cockpit/v1/regions/{region}/exporters/{exporter_id}

Delete a given data export, specified by its ID. Note that this action will immediately and permanently delete this data exports.

Delete a data export › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

exporter_id

string · required

ID of the data export to update.

Delete a data export › Responses

No data returned

Update a data export

PATCH

https://api.scaleway.com

/cockpit/v1/regions/{region}/exporters/{exporter_id}

Update a data export attributes. Changes are effective immediately even during Beta phase. Note that you can not change the data source linked to the export. If you need to do so, you will need to re-create the export.

Update a data export › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

exporter_id

string · required

ID of the data export to update.

Update a data export › Request Body

object

Updated Datadog destination configuration for the data export.

object

Updated OTLP destination configuration for the data export.

name

string

Updated name of the data export.

description

string

Updated description of the data export.

exported_products

string[]

Updated list of Scaleway products to export. To include all products in your data export, you can use an array containing "all" You can retrieve the complete list of product names using the ListProducts endpoint.

Update a data export › Responses

200

scaleway.cockpit.v1.Exporter

id

string

ID of the data export. (UUID format)

name

string

Name of the data export.

description

string

Description of the data export.

datasource_id

string

ID of the data source linked to the data export. (UUID format)

object

Datadog destination configuration for the data export.

object

OTLP destination configuration for the data export.

status

string · enum

Status of the data export.

Enum values:

unknown_status

creating

ready

error

idle

Default: unknown_status

exported_products

string[]

List of Scaleway products name exported by the data export.

created_at

string · date-time

A timestamp of the creation date of the data export. (RFC 3339 format)

updated_at

string · date-time

A timestamp of the last update date of the data export. (RFC 3339 format)

region

string

The region in which the export is located.

PATCH/cockpit/v1/regions/{region}/exporters/{exporter_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/cockpit/v1/regions/{region}/exporters/{exporter_id}"

Example Request Body

{
  "datadog_destination": {
    "api_key": "api_key",
    "endpoint": "endpoint"
  },
  "otlp_destination": {
    "endpoint": "endpoint",
    "headers": {
      "<headerKey>": "<headerKey>"
    }
  },
  "name": "name",
  "description": "description",
  "exported_products": [
    "string"
  ]
}

json

Example Responses

{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "name",
  "description": "description",
  "datasource_id": "6170692e-7363-616c-6577-61792e636f6d",
  "datadog_destination": {
    "api_key": "api_key",
    "endpoint": "endpoint"
  },
  "otlp_destination": {
    "endpoint": "endpoint",
    "headers": {
      "<headerKey>": "<headerKey>"
    }
  },
  "status": "unknown_status",
  "exported_products": [
    "string"
  ],
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "region": "region"
}

json

application/json

Alert manager Products

List data exports

GET

https://api.scaleway.com

/cockpit/v1/regions/{region}/exporters

List all data exports within a given Scaleway Project, specified by its ID. Optionally, specify a Scaleway data source ID to retrieve only data exports associated with that data source.

List data exports › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

List data exports › query Parameters

project_id

string · required

Project ID to filter for. Only data exports from this Project will be returned.

datasource_id

string

Data source ID to filter for. Only data exports linked to this data source will be returned.

page

integer · int32

Page number to return from the paginated results.

page_size

integer · uint32

Number of data exports to return per page.

order_by

string · enum

Sort order for data exports in the response.

Enum values:

created_at_asc

created_at_desc

name_asc

name_desc

Default: created_at_asc

List data exports › Responses

200

scaleway.cockpit.v1.ListExportersResponse

total_count

integer · uint64

Total count of data exports matching the request.

scaleway.cockpit.v1.Exporter[]

Data exports matching the request within the pagination.

Create a data export

POST

https://api.scaleway.com

/cockpit/v1/regions/{region}/exporters

Create a data export › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

Create a data export › Request Body

datasource_id

string · required

ID of the data source linked to the data export.

exported_products

string[] · required

name

string · required

Name of the data export.

object

Datadog destination configuration for the data export.

object

OTLP destination configuration for the data export.

description

string

Description of the data export.

Create a data export › Responses

200

scaleway.cockpit.v1.Exporter

id

string

ID of the data export. (UUID format)

name

string

Name of the data export.

description

string

Description of the data export.

datasource_id

string

ID of the data source linked to the data export. (UUID format)

object

Datadog destination configuration for the data export.

object

OTLP destination configuration for the data export.

status

string · enum

Status of the data export.

Enum values:

unknown_status

creating

ready

error

idle

Default: unknown_status

exported_products

string[]

List of Scaleway products name exported by the data export.

created_at

string · date-time

A timestamp of the creation date of the data export. (RFC 3339 format)

updated_at

string · date-time

A timestamp of the last update date of the data export. (RFC 3339 format)

region

string

The region in which the export is located.

Get a data export

GET

https://api.scaleway.com

/cockpit/v1/regions/{region}/exporters/{exporter_id}

Retrieve information about a given data export, specified by its ID.

Get a data export › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

exporter_id

string · required

ID of the data export to retrieve.

Get a data export › Responses

200

scaleway.cockpit.v1.Exporter

id

string

ID of the data export. (UUID format)

name

string

Name of the data export.

description

string

Description of the data export.

datasource_id

string

ID of the data source linked to the data export. (UUID format)

object

Datadog destination configuration for the data export.

object

OTLP destination configuration for the data export.

status

string · enum

Status of the data export.

Enum values:

unknown_status

creating

ready

error

idle

Default: unknown_status

exported_products

string[]

List of Scaleway products name exported by the data export.

created_at

string · date-time

A timestamp of the creation date of the data export. (RFC 3339 format)

updated_at

string · date-time

A timestamp of the last update date of the data export. (RFC 3339 format)

region

string

The region in which the export is located.

Delete a data export

DELETE

https://api.scaleway.com

/cockpit/v1/regions/{region}/exporters/{exporter_id}

Delete a given data export, specified by its ID. Note that this action will immediately and permanently delete this data exports.

Delete a data export › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

exporter_id

string · required

ID of the data export to update.

Delete a data export › Responses

No data returned

Update a data export

PATCH

https://api.scaleway.com

/cockpit/v1/regions/{region}/exporters/{exporter_id}

Update a data export › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

exporter_id

string · required

ID of the data export to update.

Update a data export › Request Body

object

Updated Datadog destination configuration for the data export.

object

Updated OTLP destination configuration for the data export.

name

string

Updated name of the data export.

description

string

Updated description of the data export.

exported_products

string[]

Update a data export › Responses

200

scaleway.cockpit.v1.Exporter

id

string

ID of the data export. (UUID format)

name

string

Name of the data export.

description

string

Description of the data export.

datasource_id

string

ID of the data source linked to the data export. (UUID format)

object

Datadog destination configuration for the data export.

object

OTLP destination configuration for the data export.

status

string · enum

Status of the data export.

Enum values:

unknown_status

creating

ready

error

idle

Default: unknown_status

exported_products

string[]

List of Scaleway products name exported by the data export.

created_at

string · date-time

A timestamp of the creation date of the data export. (RFC 3339 format)

updated_at

string · date-time

A timestamp of the last update date of the data export. (RFC 3339 format)

region

string

The region in which the export is located.