diff --git a/.apigentools-info b/.apigentools-info index cc7114e3f390b..8abd90e8729b5 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.6", - "regenerated": "2025-07-24 19:59:19.182981", - "spec_repo_commit": "c09ac236" + "regenerated": "2025-07-25 14:08:30.909404", + "spec_repo_commit": "e4f653f1" }, "v2": { "apigentools_version": "1.6.6", - "regenerated": "2025-07-24 19:59:28.761694", - "spec_repo_commit": "c09ac236" + "regenerated": "2025-07-25 14:08:40.468056", + "spec_repo_commit": "e4f653f1" } } } \ No newline at end of file diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index b8cde362712f8..5bea1ca5aacb9 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -6573,6 +6573,18 @@ menu: url: /api/latest/datasets/ identifier: datasets generated: true + - name: Edit a dataset + url: '#edit-a-dataset' + identifier: datasets-edit-a-dataset + parent: datasets + generated: true + params: + versions: + - v2 + operationids: + - UpdateDataset + unstable: [] + order: 4 - name: Get a single dataset by ID url: '#get-a-single-dataset-by-id' identifier: datasets-get-a-single-dataset-by-id diff --git a/content/en/api/v2/datasets/examples.json b/content/en/api/v2/datasets/examples.json index 42660b2b99fcf..fcf3228ddfc15 100644 --- a/content/en/api/v2/datasets/examples.json +++ b/content/en/api/v2/datasets/examples.json @@ -26,7 +26,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

The list of datasets returned in response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Dataset metadata and configuration(s).

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp when the dataset was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by

\n
\n

uuid

\n

Unique ID of the user who created the dataset.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the dataset.

\n
\n \n
\n
\n
\n
\n
\n

principals [required]

\n
\n

[string]

\n

List of access principals, formatted as principal_type:id. Principal can be 'team' or 'role'.

\n
\n \n
\n
\n
\n
\n
\n

product_filters [required]

\n
\n

[object]

\n

List of product-specific filters.

\n
\n
\n
\n
\n
\n

filters [required]

\n
\n

[string]

\n

Defines the list of tag-based filters used to restrict access to telemetry data for a specific product.\nThese filters act as access control rules. Each filter must follow the tag query syntax used by\nDatadog (such as @tag.key:value), and only one tag or attribute may be used to define the access strategy\nper telemetry type.

\n
\n \n
\n
\n
\n
\n
\n

product [required]

\n
\n

string

\n

Name of the product the dataset is for. Possible values are 'apm', 'rum', 'synthetics',\n'metrics', 'logs', 'sd_repoinfo', 'error_tracking', 'cloud_cost', and 'ml_obs'.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Unique identifier for the dataset.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Resource type, always "dataset".

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

The list of datasets returned in response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Dataset metadata and configuration(s).

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp when the dataset was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by

\n
\n

uuid

\n

Unique ID of the user who created the dataset.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the dataset.

\n
\n \n
\n
\n
\n
\n
\n

principals [required]

\n
\n

[string]

\n

List of access principals, formatted as principal_type:id. Principal can be 'team' or 'role'.

\n
\n \n
\n
\n
\n
\n
\n

product_filters [required]

\n
\n

[object]

\n

List of product-specific filters.

\n
\n
\n
\n
\n
\n

filters [required]

\n
\n

[string]

\n

Defines the list of tag-based filters used to restrict access to telemetry data for a specific product.\nThese filters act as access control rules. Each filter must follow the tag query syntax used by\nDatadog (such as @tag.key:value), and only one tag or attribute may be used to define the access strategy\nper telemetry type.

\n
\n \n
\n
\n
\n
\n
\n

product [required]

\n
\n

string

\n

Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Unique identifier for the dataset.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Resource type, always "dataset".

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -76,7 +76,7 @@ "type": "dataset" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Dataset object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Dataset metadata and configuration(s).

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp when the dataset was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by

\n
\n

uuid

\n

Unique ID of the user who created the dataset.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the dataset.

\n
\n \n
\n
\n
\n
\n
\n

principals [required]

\n
\n

[string]

\n

List of access principals, formatted as principal_type:id. Principal can be 'team' or 'role'.

\n
\n \n
\n
\n
\n
\n
\n

product_filters [required]

\n
\n

[object]

\n

List of product-specific filters.

\n
\n
\n
\n
\n
\n

filters [required]

\n
\n

[string]

\n

Defines the list of tag-based filters used to restrict access to telemetry data for a specific product.\nThese filters act as access control rules. Each filter must follow the tag query syntax used by\nDatadog (such as @tag.key:value), and only one tag or attribute may be used to define the access strategy\nper telemetry type.

\n
\n \n
\n
\n
\n
\n
\n

product [required]

\n
\n

string

\n

Name of the product the dataset is for. Possible values are 'apm', 'rum', 'synthetics',\n'metrics', 'logs', 'sd_repoinfo', 'error_tracking', 'cloud_cost', and 'ml_obs'.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Unique identifier for the dataset.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Resource type, always "dataset".

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Dataset object.

\n

Datasets Constraints

\n
    \n

  • Tag Limit per Dataset:

    \n
      \n
    • Each restricted dataset supports a maximum of 10 key:value pairs per product.
      • \n
    \n
    • \n

  • Tag Key Rules per Telemetry Type:

    \n
      \n
    • Only one tag key or attribute may be used to define access within a single telemetry type.
      • \n
    • The same or different tag key may be used across different telemetry types.
      • \n
    \n
    • \n

  • Tag Value Uniqueness:

    \n
      \n
    • Tag values must be unique within a single dataset.
      • \n
    • A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.
      • \n
    \n
    • \n
\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Dataset metadata and configuration(s).

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp when the dataset was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by

\n
\n

uuid

\n

Unique ID of the user who created the dataset.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the dataset.

\n
\n \n
\n
\n
\n
\n
\n

principals [required]

\n
\n

[string]

\n

List of access principals, formatted as principal_type:id. Principal can be 'team' or 'role'.

\n
\n \n
\n
\n
\n
\n
\n

product_filters [required]

\n
\n

[object]

\n

List of product-specific filters.

\n
\n
\n
\n
\n
\n

filters [required]

\n
\n

[string]

\n

Defines the list of tag-based filters used to restrict access to telemetry data for a specific product.\nThese filters act as access control rules. Each filter must follow the tag query syntax used by\nDatadog (such as @tag.key:value), and only one tag or attribute may be used to define the access strategy\nper telemetry type.

\n
\n \n
\n
\n
\n
\n
\n

product [required]

\n
\n

string

\n

Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Unique identifier for the dataset.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Resource type, always "dataset".

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -153,7 +153,7 @@ "type": "dataset" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Dataset object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Dataset metadata and configuration(s).

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp when the dataset was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by

\n
\n

uuid

\n

Unique ID of the user who created the dataset.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the dataset.

\n
\n \n
\n
\n
\n
\n
\n

principals [required]

\n
\n

[string]

\n

List of access principals, formatted as principal_type:id. Principal can be 'team' or 'role'.

\n
\n \n
\n
\n
\n
\n
\n

product_filters [required]

\n
\n

[object]

\n

List of product-specific filters.

\n
\n
\n
\n
\n
\n

filters [required]

\n
\n

[string]

\n

Defines the list of tag-based filters used to restrict access to telemetry data for a specific product.\nThese filters act as access control rules. Each filter must follow the tag query syntax used by\nDatadog (such as @tag.key:value), and only one tag or attribute may be used to define the access strategy\nper telemetry type.

\n
\n \n
\n
\n
\n
\n
\n

product [required]

\n
\n

string

\n

Name of the product the dataset is for. Possible values are 'apm', 'rum', 'synthetics',\n'metrics', 'logs', 'sd_repoinfo', 'error_tracking', 'cloud_cost', and 'ml_obs'.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Unique identifier for the dataset.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Resource type, always "dataset".

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Dataset object.

\n

Datasets Constraints

\n
    \n

  • Tag Limit per Dataset:

    \n
      \n
    • Each restricted dataset supports a maximum of 10 key:value pairs per product.
      • \n
    \n
    • \n

  • Tag Key Rules per Telemetry Type:

    \n
      \n
    • Only one tag key or attribute may be used to define access within a single telemetry type.
      • \n
    • The same or different tag key may be used across different telemetry types.
      • \n
    \n
    • \n

  • Tag Value Uniqueness:

    \n
      \n
    • Tag values must be unique within a single dataset.
      • \n
    • A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.
      • \n
    \n
    • \n
\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Dataset metadata and configuration(s).

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp when the dataset was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by

\n
\n

uuid

\n

Unique ID of the user who created the dataset.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the dataset.

\n
\n \n
\n
\n
\n
\n
\n

principals [required]

\n
\n

[string]

\n

List of access principals, formatted as principal_type:id. Principal can be 'team' or 'role'.

\n
\n \n
\n
\n
\n
\n
\n

product_filters [required]

\n
\n

[object]

\n

List of product-specific filters.

\n
\n
\n
\n
\n
\n

filters [required]

\n
\n

[string]

\n

Defines the list of tag-based filters used to restrict access to telemetry data for a specific product.\nThese filters act as access control rules. Each filter must follow the tag query syntax used by\nDatadog (such as @tag.key:value), and only one tag or attribute may be used to define the access strategy\nper telemetry type.

\n
\n \n
\n
\n
\n
\n
\n

product [required]

\n
\n

string

\n

Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Unique identifier for the dataset.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Resource type, always "dataset".

\n
\n \n
\n
\n
\n
" } }, "DeleteDataset": { @@ -222,7 +222,7 @@ "type": "dataset" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Dataset object.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Dataset metadata and configuration(s).

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp when the dataset was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by

\n
\n

uuid

\n

Unique ID of the user who created the dataset.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the dataset.

\n
\n \n
\n
\n
\n
\n
\n

principals [required]

\n
\n

[string]

\n

List of access principals, formatted as principal_type:id. Principal can be 'team' or 'role'.

\n
\n \n
\n
\n
\n
\n
\n

product_filters [required]

\n
\n

[object]

\n

List of product-specific filters.

\n
\n
\n
\n
\n
\n

filters [required]

\n
\n

[string]

\n

Defines the list of tag-based filters used to restrict access to telemetry data for a specific product.\nThese filters act as access control rules. Each filter must follow the tag query syntax used by\nDatadog (such as @tag.key:value), and only one tag or attribute may be used to define the access strategy\nper telemetry type.

\n
\n \n
\n
\n
\n
\n
\n

product [required]

\n
\n

string

\n

Name of the product the dataset is for. Possible values are 'apm', 'rum', 'synthetics',\n'metrics', 'logs', 'sd_repoinfo', 'error_tracking', 'cloud_cost', and 'ml_obs'.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Unique identifier for the dataset.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Resource type, always "dataset".

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Dataset object.

\n

Datasets Constraints

\n
    \n

  • Tag Limit per Dataset:

    \n
      \n
    • Each restricted dataset supports a maximum of 10 key:value pairs per product.
      • \n
    \n
    • \n

  • Tag Key Rules per Telemetry Type:

    \n
      \n
    • Only one tag key or attribute may be used to define access within a single telemetry type.
      • \n
    • The same or different tag key may be used across different telemetry types.
      • \n
    \n
    • \n

  • Tag Value Uniqueness:

    \n
      \n
    • Tag values must be unique within a single dataset.
      • \n
    • A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.
      • \n
    \n
    • \n
\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Dataset metadata and configuration(s).

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp when the dataset was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by

\n
\n

uuid

\n

Unique ID of the user who created the dataset.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the dataset.

\n
\n \n
\n
\n
\n
\n
\n

principals [required]

\n
\n

[string]

\n

List of access principals, formatted as principal_type:id. Principal can be 'team' or 'role'.

\n
\n \n
\n
\n
\n
\n
\n

product_filters [required]

\n
\n

[object]

\n

List of product-specific filters.

\n
\n
\n
\n
\n
\n

filters [required]

\n
\n

[string]

\n

Defines the list of tag-based filters used to restrict access to telemetry data for a specific product.\nThese filters act as access control rules. Each filter must follow the tag query syntax used by\nDatadog (such as @tag.key:value), and only one tag or attribute may be used to define the access strategy\nper telemetry type.

\n
\n \n
\n
\n
\n
\n
\n

product [required]

\n
\n

string

\n

Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Unique identifier for the dataset.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Resource type, always "dataset".

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -262,5 +262,110 @@ "json": {}, "html": "" } + }, + "UpdateDataset": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "created_at": "2019-09-19T10:00:00.000Z", + "created_by": "string", + "name": "Security Audit Dataset", + "principals": [ + "role:86245fce-0a4e-11f0-92bd-da7ad0900002" + ], + "product_filters": [ + { + "filters": [ + "@application.id:ABCD" + ], + "product": "logs" + } + ] + }, + "id": "123e4567-e89b-12d3-a456-426614174000", + "type": "dataset" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Dataset object.

\n

Datasets Constraints

\n
    \n

  • Tag Limit per Dataset:

    \n
      \n
    • Each restricted dataset supports a maximum of 10 key:value pairs per product.
      • \n
    \n
    • \n

  • Tag Key Rules per Telemetry Type:

    \n
      \n
    • Only one tag key or attribute may be used to define access within a single telemetry type.
      • \n
    • The same or different tag key may be used across different telemetry types.
      • \n
    \n
    • \n

  • Tag Value Uniqueness:

    \n
      \n
    • Tag values must be unique within a single dataset.
      • \n
    • A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.
      • \n
    \n
    • \n
\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Dataset metadata and configuration(s).

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp when the dataset was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by

\n
\n

uuid

\n

Unique ID of the user who created the dataset.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the dataset.

\n
\n \n
\n
\n
\n
\n
\n

principals [required]

\n
\n

[string]

\n

List of access principals, formatted as principal_type:id. Principal can be 'team' or 'role'.

\n
\n \n
\n
\n
\n
\n
\n

product_filters [required]

\n
\n

[object]

\n

List of product-specific filters.

\n
\n
\n
\n
\n
\n

filters [required]

\n
\n

[string]

\n

Defines the list of tag-based filters used to restrict access to telemetry data for a specific product.\nThese filters act as access control rules. Each filter must follow the tag query syntax used by\nDatadog (such as @tag.key:value), and only one tag or attribute may be used to define the access strategy\nper telemetry type.

\n
\n \n
\n
\n
\n
\n
\n

product [required]

\n
\n

string

\n

Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Unique identifier for the dataset.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Resource type, always "dataset".

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "404": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "name": "Security Audit Dataset", + "principals": [ + "role:86245fce-0a4e-11f0-92bd-da7ad0900002" + ], + "product_filters": [ + { + "filters": [ + "@application.id:ABCD" + ], + "product": "logs" + } + ] + }, + "type": "dataset" + } + }, + "json": { + "data": { + "attributes": { + "created_at": "2019-09-19T10:00:00.000Z", + "created_by": "string", + "name": "Security Audit Dataset", + "principals": [ + "role:86245fce-0a4e-11f0-92bd-da7ad0900002" + ], + "product_filters": [ + { + "filters": [ + "@application.id:ABCD" + ], + "product": "logs" + } + ] + }, + "id": "123e4567-e89b-12d3-a456-426614174000", + "type": "dataset" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Dataset object.

\n

Datasets Constraints

\n
    \n

  • Tag Limit per Dataset:

    \n
      \n
    • Each restricted dataset supports a maximum of 10 key:value pairs per product.
      • \n
    \n
    • \n

  • Tag Key Rules per Telemetry Type:

    \n
      \n
    • Only one tag key or attribute may be used to define access within a single telemetry type.
      • \n
    • The same or different tag key may be used across different telemetry types.
      • \n
    \n
    • \n

  • Tag Value Uniqueness:

    \n
      \n
    • Tag values must be unique within a single dataset.
      • \n
    • A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.
      • \n
    \n
    • \n
\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Dataset metadata and configuration(s).

\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp when the dataset was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by

\n
\n

uuid

\n

Unique ID of the user who created the dataset.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the dataset.

\n
\n \n
\n
\n
\n
\n
\n

principals [required]

\n
\n

[string]

\n

List of access principals, formatted as principal_type:id. Principal can be 'team' or 'role'.

\n
\n \n
\n
\n
\n
\n
\n

product_filters [required]

\n
\n

[object]

\n

List of product-specific filters.

\n
\n
\n
\n
\n
\n

filters [required]

\n
\n

[string]

\n

Defines the list of tag-based filters used to restrict access to telemetry data for a specific product.\nThese filters act as access control rules. Each filter must follow the tag query syntax used by\nDatadog (such as @tag.key:value), and only one tag or attribute may be used to define the access strategy\nper telemetry type.

\n
\n \n
\n
\n
\n
\n
\n

product [required]

\n
\n

string

\n

Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Unique identifier for the dataset.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

Resource type, always "dataset".

\n
\n \n
\n
\n
\n
" + } } } \ No newline at end of file diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 3b8527ec822e2..930da2541bee9 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -12342,7 +12342,14 @@ components: - type type: object Dataset: - description: Dataset object. + description: "Dataset object.\n\n### Datasets Constraints\n- **Tag Limit per + Dataset**:\n - Each restricted dataset supports a maximum of 10 key:value + pairs per product.\n\n- **Tag Key Rules per Telemetry Type**:\n - Only one + tag key or attribute may be used to define access within a single telemetry + type.\n - The same or different tag key may be used across different telemetry + types.\n\n- **Tag Value Uniqueness**:\n - Tag values must be unique within + a single dataset.\n - A tag value used in one dataset cannot be reused in + another dataset of the same telemetry type." properties: attributes: $ref: '#/components/schemas/DatasetAttributes' @@ -12420,6 +12427,14 @@ components: required: - data type: object + DatasetUpdateRequest: + description: Edit request for a dataset. + properties: + data: + $ref: '#/components/schemas/Dataset' + required: + - data + type: object Date: description: Date as Unix timestamp in milliseconds. example: 1722439510282 @@ -16194,10 +16209,9 @@ components: type: array product: description: 'Name of the product the dataset is for. Possible values are - ''apm'', ''rum'', ''synthetics'', + ''apm'', ''rum'', - ''metrics'', ''logs'', ''sd_repoinfo'', ''error_tracking'', ''cloud_cost'', - and ''ml_obs''.' + ''metrics'', ''logs'', ''error_tracking'', and ''cloud_cost''.' example: logs type: string required: @@ -49630,6 +49644,47 @@ paths: permissions: [] x-undo: type: safe + put: + description: Edits the dataset associated with the ID. + operationId: UpdateDataset + parameters: + - $ref: '#/components/parameters/DatasetID' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DatasetUpdateRequest' + description: Dataset payload + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/DatasetResponseSingle' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: [] + summary: Edit a dataset + tags: + - Datasets + x-codegen-request-body-name: body + x-menu-order: 4 + x-permission: + operator: OPEN + permissions: [] + x-undo: + type: idempotent /api/v2/domain_allowlist: get: description: Get the domain allowlist for an organization. diff --git a/data/api/v2/full_spec_deref.json b/data/api/v2/full_spec_deref.json index 651d6b2bdd20f..3370030c6f18e 100644 --- a/data/api/v2/full_spec_deref.json +++ b/data/api/v2/full_spec_deref.json @@ -69228,7 +69228,7 @@ "type": "object" }, "Dataset": { - "description": "Dataset object.", + "description": "Dataset object.\n\n### Datasets Constraints\n- **Tag Limit per Dataset**:\n - Each restricted dataset supports a maximum of 10 key:value pairs per product.\n\n- **Tag Key Rules per Telemetry Type**:\n - Only one tag key or attribute may be used to define access within a single telemetry type.\n - The same or different tag key may be used across different telemetry types.\n\n- **Tag Value Uniqueness**:\n - Tag values must be unique within a single dataset.\n - A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.", "properties": { "attributes": { "description": "Dataset metadata and configuration(s).", @@ -69277,7 +69277,7 @@ "type": "array" }, "product": { - "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum', 'synthetics',\n'metrics', 'logs', 'sd_repoinfo', 'error_tracking', 'cloud_cost', and 'ml_obs'.", + "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.", "example": "logs", "type": "string" } @@ -69362,7 +69362,7 @@ "type": "array" }, "product": { - "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum', 'synthetics',\n'metrics', 'logs', 'sd_repoinfo', 'error_tracking', 'cloud_cost', and 'ml_obs'.", + "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.", "example": "logs", "type": "string" } @@ -69387,7 +69387,7 @@ "description": "Create request for a dataset.", "properties": { "data": { - "description": "Dataset object.", + "description": "Dataset object.\n\n### Datasets Constraints\n- **Tag Limit per Dataset**:\n - Each restricted dataset supports a maximum of 10 key:value pairs per product.\n\n- **Tag Key Rules per Telemetry Type**:\n - Only one tag key or attribute may be used to define access within a single telemetry type.\n - The same or different tag key may be used across different telemetry types.\n\n- **Tag Value Uniqueness**:\n - Tag values must be unique within a single dataset.\n - A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.", "properties": { "attributes": { "description": "Dataset metadata and configuration(s).", @@ -69436,7 +69436,7 @@ "type": "array" }, "product": { - "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum', 'synthetics',\n'metrics', 'logs', 'sd_repoinfo', 'error_tracking', 'cloud_cost', and 'ml_obs'.", + "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.", "example": "logs", "type": "string" } @@ -69486,7 +69486,7 @@ "data": { "description": "The list of datasets returned in response.", "items": { - "description": "Dataset object.", + "description": "Dataset object.\n\n### Datasets Constraints\n- **Tag Limit per Dataset**:\n - Each restricted dataset supports a maximum of 10 key:value pairs per product.\n\n- **Tag Key Rules per Telemetry Type**:\n - Only one tag key or attribute may be used to define access within a single telemetry type.\n - The same or different tag key may be used across different telemetry types.\n\n- **Tag Value Uniqueness**:\n - Tag values must be unique within a single dataset.\n - A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.", "properties": { "attributes": { "description": "Dataset metadata and configuration(s).", @@ -69535,7 +69535,7 @@ "type": "array" }, "product": { - "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum', 'synthetics',\n'metrics', 'logs', 'sd_repoinfo', 'error_tracking', 'cloud_cost', and 'ml_obs'.", + "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.", "example": "logs", "type": "string" } @@ -69585,7 +69585,7 @@ "description": "Response containing a single dataset object.", "properties": { "data": { - "description": "Dataset object.", + "description": "Dataset object.\n\n### Datasets Constraints\n- **Tag Limit per Dataset**:\n - Each restricted dataset supports a maximum of 10 key:value pairs per product.\n\n- **Tag Key Rules per Telemetry Type**:\n - Only one tag key or attribute may be used to define access within a single telemetry type.\n - The same or different tag key may be used across different telemetry types.\n\n- **Tag Value Uniqueness**:\n - Tag values must be unique within a single dataset.\n - A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.", "properties": { "attributes": { "description": "Dataset metadata and configuration(s).", @@ -69634,7 +69634,104 @@ "type": "array" }, "product": { - "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum', 'synthetics',\n'metrics', 'logs', 'sd_repoinfo', 'error_tracking', 'cloud_cost', and 'ml_obs'.", + "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.", + "example": "logs", + "type": "string" + } + }, + "required": [ + "product", + "filters" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "name", + "product_filters", + "principals" + ], + "type": "object" + }, + "id": { + "description": "Unique identifier for the dataset.", + "example": "123e4567-e89b-12d3-a456-426614174000", + "type": "string" + }, + "type": { + "description": "Resource type, always \"dataset\".", + "example": "dataset", + "type": "string" + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "DatasetUpdateRequest": { + "description": "Edit request for a dataset.", + "properties": { + "data": { + "description": "Dataset object.\n\n### Datasets Constraints\n- **Tag Limit per Dataset**:\n - Each restricted dataset supports a maximum of 10 key:value pairs per product.\n\n- **Tag Key Rules per Telemetry Type**:\n - Only one tag key or attribute may be used to define access within a single telemetry type.\n - The same or different tag key may be used across different telemetry types.\n\n- **Tag Value Uniqueness**:\n - Tag values must be unique within a single dataset.\n - A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.", + "properties": { + "attributes": { + "description": "Dataset metadata and configuration(s).", + "properties": { + "created_at": { + "description": "Timestamp when the dataset was created.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "created_by": { + "description": "Unique ID of the user who created the dataset.", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "Name of the dataset.", + "example": "Security Audit Dataset", + "type": "string" + }, + "principals": { + "description": "List of access principals, formatted as `principal_type:id`. Principal can be 'team' or 'role'.", + "example": [ + "role:86245fce-0a4e-11f0-92bd-da7ad0900002" + ], + "items": { + "example": "role:86245fce-0a4e-11f0-92bd-da7ad0900002", + "type": "string" + }, + "type": "array" + }, + "product_filters": { + "description": "List of product-specific filters.", + "items": { + "description": "Product-specific filters for the dataset.", + "properties": { + "filters": { + "description": "Defines the list of tag-based filters used to restrict access to telemetry data for a specific product.\nThese filters act as access control rules. Each filter must follow the tag query syntax used by\nDatadog (such as `@tag.key:value`), and only one tag or attribute may be used to define the access strategy\nper telemetry type.", + "example": [ + "@application.id:ABCD" + ], + "items": { + "example": "@application.id:ABCD", + "type": "string" + }, + "type": "array" + }, + "product": { + "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.", "example": "logs", "type": "string" } @@ -92759,7 +92856,7 @@ "type": "array" }, "product": { - "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum', 'synthetics',\n'metrics', 'logs', 'sd_repoinfo', 'error_tracking', 'cloud_cost', and 'ml_obs'.", + "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.", "example": "logs", "type": "string" } @@ -378034,7 +378131,7 @@ "data": { "description": "The list of datasets returned in response.", "items": { - "description": "Dataset object.", + "description": "Dataset object.\n\n### Datasets Constraints\n- **Tag Limit per Dataset**:\n - Each restricted dataset supports a maximum of 10 key:value pairs per product.\n\n- **Tag Key Rules per Telemetry Type**:\n - Only one tag key or attribute may be used to define access within a single telemetry type.\n - The same or different tag key may be used across different telemetry types.\n\n- **Tag Value Uniqueness**:\n - Tag values must be unique within a single dataset.\n - A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.", "properties": { "attributes": { "description": "Dataset metadata and configuration(s).", @@ -378083,7 +378180,7 @@ "type": "array" }, "product": { - "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum', 'synthetics',\n'metrics', 'logs', 'sd_repoinfo', 'error_tracking', 'cloud_cost', and 'ml_obs'.", + "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.", "example": "logs", "type": "string" } @@ -378245,7 +378342,7 @@ "description": "Create request for a dataset.", "properties": { "data": { - "description": "Dataset object.", + "description": "Dataset object.\n\n### Datasets Constraints\n- **Tag Limit per Dataset**:\n - Each restricted dataset supports a maximum of 10 key:value pairs per product.\n\n- **Tag Key Rules per Telemetry Type**:\n - Only one tag key or attribute may be used to define access within a single telemetry type.\n - The same or different tag key may be used across different telemetry types.\n\n- **Tag Value Uniqueness**:\n - Tag values must be unique within a single dataset.\n - A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.", "properties": { "attributes": { "description": "Dataset metadata and configuration(s).", @@ -378294,7 +378391,7 @@ "type": "array" }, "product": { - "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum', 'synthetics',\n'metrics', 'logs', 'sd_repoinfo', 'error_tracking', 'cloud_cost', and 'ml_obs'.", + "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.", "example": "logs", "type": "string" } @@ -378351,7 +378448,7 @@ "description": "Response containing a single dataset object.", "properties": { "data": { - "description": "Dataset object.", + "description": "Dataset object.\n\n### Datasets Constraints\n- **Tag Limit per Dataset**:\n - Each restricted dataset supports a maximum of 10 key:value pairs per product.\n\n- **Tag Key Rules per Telemetry Type**:\n - Only one tag key or attribute may be used to define access within a single telemetry type.\n - The same or different tag key may be used across different telemetry types.\n\n- **Tag Value Uniqueness**:\n - Tag values must be unique within a single dataset.\n - A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.", "properties": { "attributes": { "description": "Dataset metadata and configuration(s).", @@ -378400,7 +378497,7 @@ "type": "array" }, "product": { - "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum', 'synthetics',\n'metrics', 'logs', 'sd_repoinfo', 'error_tracking', 'cloud_cost', and 'ml_obs'.", + "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.", "example": "logs", "type": "string" } @@ -378774,7 +378871,7 @@ "description": "Response containing a single dataset object.", "properties": { "data": { - "description": "Dataset object.", + "description": "Dataset object.\n\n### Datasets Constraints\n- **Tag Limit per Dataset**:\n - Each restricted dataset supports a maximum of 10 key:value pairs per product.\n\n- **Tag Key Rules per Telemetry Type**:\n - Only one tag key or attribute may be used to define access within a single telemetry type.\n - The same or different tag key may be used across different telemetry types.\n\n- **Tag Value Uniqueness**:\n - Tag values must be unique within a single dataset.\n - A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.", "properties": { "attributes": { "description": "Dataset metadata and configuration(s).", @@ -378823,7 +378920,7 @@ "type": "array" }, "product": { - "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum', 'synthetics',\n'metrics', 'logs', 'sd_repoinfo', 'error_tracking', 'cloud_cost', and 'ml_obs'.", + "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.", "example": "logs", "type": "string" } @@ -379005,6 +379102,367 @@ "x-undo": { "type": "safe" } + }, + "put": { + "description": "Edits the dataset associated with the ID.", + "operationId": "UpdateDataset", + "parameters": [ + { + "description": "The ID of a defined dataset.", + "example": "0879ce27-29a1-481f-a12e-bc2a48ec9ae1", + "in": "path", + "name": "dataset_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Edit request for a dataset.", + "properties": { + "data": { + "description": "Dataset object.\n\n### Datasets Constraints\n- **Tag Limit per Dataset**:\n - Each restricted dataset supports a maximum of 10 key:value pairs per product.\n\n- **Tag Key Rules per Telemetry Type**:\n - Only one tag key or attribute may be used to define access within a single telemetry type.\n - The same or different tag key may be used across different telemetry types.\n\n- **Tag Value Uniqueness**:\n - Tag values must be unique within a single dataset.\n - A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.", + "properties": { + "attributes": { + "description": "Dataset metadata and configuration(s).", + "properties": { + "created_at": { + "description": "Timestamp when the dataset was created.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "created_by": { + "description": "Unique ID of the user who created the dataset.", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "Name of the dataset.", + "example": "Security Audit Dataset", + "type": "string" + }, + "principals": { + "description": "List of access principals, formatted as `principal_type:id`. Principal can be 'team' or 'role'.", + "example": [ + "role:86245fce-0a4e-11f0-92bd-da7ad0900002" + ], + "items": { + "example": "role:86245fce-0a4e-11f0-92bd-da7ad0900002", + "type": "string" + }, + "type": "array" + }, + "product_filters": { + "description": "List of product-specific filters.", + "items": { + "description": "Product-specific filters for the dataset.", + "properties": { + "filters": { + "description": "Defines the list of tag-based filters used to restrict access to telemetry data for a specific product.\nThese filters act as access control rules. Each filter must follow the tag query syntax used by\nDatadog (such as `@tag.key:value`), and only one tag or attribute may be used to define the access strategy\nper telemetry type.", + "example": [ + "@application.id:ABCD" + ], + "items": { + "example": "@application.id:ABCD", + "type": "string" + }, + "type": "array" + }, + "product": { + "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.", + "example": "logs", + "type": "string" + } + }, + "required": [ + "product", + "filters" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "name", + "product_filters", + "principals" + ], + "type": "object" + }, + "id": { + "description": "Unique identifier for the dataset.", + "example": "123e4567-e89b-12d3-a456-426614174000", + "type": "string" + }, + "type": { + "description": "Resource type, always \"dataset\".", + "example": "dataset", + "type": "string" + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "Dataset payload", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response containing a single dataset object.", + "properties": { + "data": { + "description": "Dataset object.\n\n### Datasets Constraints\n- **Tag Limit per Dataset**:\n - Each restricted dataset supports a maximum of 10 key:value pairs per product.\n\n- **Tag Key Rules per Telemetry Type**:\n - Only one tag key or attribute may be used to define access within a single telemetry type.\n - The same or different tag key may be used across different telemetry types.\n\n- **Tag Value Uniqueness**:\n - Tag values must be unique within a single dataset.\n - A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.", + "properties": { + "attributes": { + "description": "Dataset metadata and configuration(s).", + "properties": { + "created_at": { + "description": "Timestamp when the dataset was created.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "created_by": { + "description": "Unique ID of the user who created the dataset.", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "Name of the dataset.", + "example": "Security Audit Dataset", + "type": "string" + }, + "principals": { + "description": "List of access principals, formatted as `principal_type:id`. Principal can be 'team' or 'role'.", + "example": [ + "role:86245fce-0a4e-11f0-92bd-da7ad0900002" + ], + "items": { + "example": "role:86245fce-0a4e-11f0-92bd-da7ad0900002", + "type": "string" + }, + "type": "array" + }, + "product_filters": { + "description": "List of product-specific filters.", + "items": { + "description": "Product-specific filters for the dataset.", + "properties": { + "filters": { + "description": "Defines the list of tag-based filters used to restrict access to telemetry data for a specific product.\nThese filters act as access control rules. Each filter must follow the tag query syntax used by\nDatadog (such as `@tag.key:value`), and only one tag or attribute may be used to define the access strategy\nper telemetry type.", + "example": [ + "@application.id:ABCD" + ], + "items": { + "example": "@application.id:ABCD", + "type": "string" + }, + "type": "array" + }, + "product": { + "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.", + "example": "logs", + "type": "string" + } + }, + "required": [ + "product", + "filters" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "name", + "product_filters", + "principals" + ], + "type": "object" + }, + "id": { + "description": "Unique identifier for the dataset.", + "example": "123e4567-e89b-12d3-a456-426614174000", + "type": "string" + }, + "type": { + "description": "Resource type, always \"dataset\".", + "example": "dataset", + "type": "string" + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Authorized" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [] + } + ], + "summary": "Edit a dataset", + "tags": [ + "Datasets" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 4, + "x-permission": { + "operator": "OPEN", + "permissions": [] + }, + "x-undo": { + "type": "idempotent" + } } }, "/api/v2/domain_allowlist": { diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index 04ace04589578..8fd95f8cdf7be 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -625,6 +625,12 @@ "description": "Retrieves the dataset associated with the ID.", "summary": "Get a single dataset by ID" }, + "UpdateDataset": { + "description": "Edits the dataset associated with the ID.", + "summary": "Edit a dataset", + "request_description": "Dataset payload", + "request_schema_description": "Edit request for a dataset." + }, "GetDomainAllowlist": { "description": "Get the domain allowlist for an organization.", "summary": "Get Domain Allowlist" diff --git a/static/resources/json/full_spec_v2.json b/static/resources/json/full_spec_v2.json index 651d6b2bdd20f..3370030c6f18e 100644 --- a/static/resources/json/full_spec_v2.json +++ b/static/resources/json/full_spec_v2.json @@ -69228,7 +69228,7 @@ "type": "object" }, "Dataset": { - "description": "Dataset object.", + "description": "Dataset object.\n\n### Datasets Constraints\n- **Tag Limit per Dataset**:\n - Each restricted dataset supports a maximum of 10 key:value pairs per product.\n\n- **Tag Key Rules per Telemetry Type**:\n - Only one tag key or attribute may be used to define access within a single telemetry type.\n - The same or different tag key may be used across different telemetry types.\n\n- **Tag Value Uniqueness**:\n - Tag values must be unique within a single dataset.\n - A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.", "properties": { "attributes": { "description": "Dataset metadata and configuration(s).", @@ -69277,7 +69277,7 @@ "type": "array" }, "product": { - "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum', 'synthetics',\n'metrics', 'logs', 'sd_repoinfo', 'error_tracking', 'cloud_cost', and 'ml_obs'.", + "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.", "example": "logs", "type": "string" } @@ -69362,7 +69362,7 @@ "type": "array" }, "product": { - "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum', 'synthetics',\n'metrics', 'logs', 'sd_repoinfo', 'error_tracking', 'cloud_cost', and 'ml_obs'.", + "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.", "example": "logs", "type": "string" } @@ -69387,7 +69387,7 @@ "description": "Create request for a dataset.", "properties": { "data": { - "description": "Dataset object.", + "description": "Dataset object.\n\n### Datasets Constraints\n- **Tag Limit per Dataset**:\n - Each restricted dataset supports a maximum of 10 key:value pairs per product.\n\n- **Tag Key Rules per Telemetry Type**:\n - Only one tag key or attribute may be used to define access within a single telemetry type.\n - The same or different tag key may be used across different telemetry types.\n\n- **Tag Value Uniqueness**:\n - Tag values must be unique within a single dataset.\n - A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.", "properties": { "attributes": { "description": "Dataset metadata and configuration(s).", @@ -69436,7 +69436,7 @@ "type": "array" }, "product": { - "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum', 'synthetics',\n'metrics', 'logs', 'sd_repoinfo', 'error_tracking', 'cloud_cost', and 'ml_obs'.", + "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.", "example": "logs", "type": "string" } @@ -69486,7 +69486,7 @@ "data": { "description": "The list of datasets returned in response.", "items": { - "description": "Dataset object.", + "description": "Dataset object.\n\n### Datasets Constraints\n- **Tag Limit per Dataset**:\n - Each restricted dataset supports a maximum of 10 key:value pairs per product.\n\n- **Tag Key Rules per Telemetry Type**:\n - Only one tag key or attribute may be used to define access within a single telemetry type.\n - The same or different tag key may be used across different telemetry types.\n\n- **Tag Value Uniqueness**:\n - Tag values must be unique within a single dataset.\n - A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.", "properties": { "attributes": { "description": "Dataset metadata and configuration(s).", @@ -69535,7 +69535,7 @@ "type": "array" }, "product": { - "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum', 'synthetics',\n'metrics', 'logs', 'sd_repoinfo', 'error_tracking', 'cloud_cost', and 'ml_obs'.", + "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.", "example": "logs", "type": "string" } @@ -69585,7 +69585,7 @@ "description": "Response containing a single dataset object.", "properties": { "data": { - "description": "Dataset object.", + "description": "Dataset object.\n\n### Datasets Constraints\n- **Tag Limit per Dataset**:\n - Each restricted dataset supports a maximum of 10 key:value pairs per product.\n\n- **Tag Key Rules per Telemetry Type**:\n - Only one tag key or attribute may be used to define access within a single telemetry type.\n - The same or different tag key may be used across different telemetry types.\n\n- **Tag Value Uniqueness**:\n - Tag values must be unique within a single dataset.\n - A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.", "properties": { "attributes": { "description": "Dataset metadata and configuration(s).", @@ -69634,7 +69634,104 @@ "type": "array" }, "product": { - "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum', 'synthetics',\n'metrics', 'logs', 'sd_repoinfo', 'error_tracking', 'cloud_cost', and 'ml_obs'.", + "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.", + "example": "logs", + "type": "string" + } + }, + "required": [ + "product", + "filters" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "name", + "product_filters", + "principals" + ], + "type": "object" + }, + "id": { + "description": "Unique identifier for the dataset.", + "example": "123e4567-e89b-12d3-a456-426614174000", + "type": "string" + }, + "type": { + "description": "Resource type, always \"dataset\".", + "example": "dataset", + "type": "string" + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "DatasetUpdateRequest": { + "description": "Edit request for a dataset.", + "properties": { + "data": { + "description": "Dataset object.\n\n### Datasets Constraints\n- **Tag Limit per Dataset**:\n - Each restricted dataset supports a maximum of 10 key:value pairs per product.\n\n- **Tag Key Rules per Telemetry Type**:\n - Only one tag key or attribute may be used to define access within a single telemetry type.\n - The same or different tag key may be used across different telemetry types.\n\n- **Tag Value Uniqueness**:\n - Tag values must be unique within a single dataset.\n - A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.", + "properties": { + "attributes": { + "description": "Dataset metadata and configuration(s).", + "properties": { + "created_at": { + "description": "Timestamp when the dataset was created.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "created_by": { + "description": "Unique ID of the user who created the dataset.", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "Name of the dataset.", + "example": "Security Audit Dataset", + "type": "string" + }, + "principals": { + "description": "List of access principals, formatted as `principal_type:id`. Principal can be 'team' or 'role'.", + "example": [ + "role:86245fce-0a4e-11f0-92bd-da7ad0900002" + ], + "items": { + "example": "role:86245fce-0a4e-11f0-92bd-da7ad0900002", + "type": "string" + }, + "type": "array" + }, + "product_filters": { + "description": "List of product-specific filters.", + "items": { + "description": "Product-specific filters for the dataset.", + "properties": { + "filters": { + "description": "Defines the list of tag-based filters used to restrict access to telemetry data for a specific product.\nThese filters act as access control rules. Each filter must follow the tag query syntax used by\nDatadog (such as `@tag.key:value`), and only one tag or attribute may be used to define the access strategy\nper telemetry type.", + "example": [ + "@application.id:ABCD" + ], + "items": { + "example": "@application.id:ABCD", + "type": "string" + }, + "type": "array" + }, + "product": { + "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.", "example": "logs", "type": "string" } @@ -92759,7 +92856,7 @@ "type": "array" }, "product": { - "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum', 'synthetics',\n'metrics', 'logs', 'sd_repoinfo', 'error_tracking', 'cloud_cost', and 'ml_obs'.", + "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.", "example": "logs", "type": "string" } @@ -378034,7 +378131,7 @@ "data": { "description": "The list of datasets returned in response.", "items": { - "description": "Dataset object.", + "description": "Dataset object.\n\n### Datasets Constraints\n- **Tag Limit per Dataset**:\n - Each restricted dataset supports a maximum of 10 key:value pairs per product.\n\n- **Tag Key Rules per Telemetry Type**:\n - Only one tag key or attribute may be used to define access within a single telemetry type.\n - The same or different tag key may be used across different telemetry types.\n\n- **Tag Value Uniqueness**:\n - Tag values must be unique within a single dataset.\n - A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.", "properties": { "attributes": { "description": "Dataset metadata and configuration(s).", @@ -378083,7 +378180,7 @@ "type": "array" }, "product": { - "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum', 'synthetics',\n'metrics', 'logs', 'sd_repoinfo', 'error_tracking', 'cloud_cost', and 'ml_obs'.", + "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.", "example": "logs", "type": "string" } @@ -378245,7 +378342,7 @@ "description": "Create request for a dataset.", "properties": { "data": { - "description": "Dataset object.", + "description": "Dataset object.\n\n### Datasets Constraints\n- **Tag Limit per Dataset**:\n - Each restricted dataset supports a maximum of 10 key:value pairs per product.\n\n- **Tag Key Rules per Telemetry Type**:\n - Only one tag key or attribute may be used to define access within a single telemetry type.\n - The same or different tag key may be used across different telemetry types.\n\n- **Tag Value Uniqueness**:\n - Tag values must be unique within a single dataset.\n - A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.", "properties": { "attributes": { "description": "Dataset metadata and configuration(s).", @@ -378294,7 +378391,7 @@ "type": "array" }, "product": { - "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum', 'synthetics',\n'metrics', 'logs', 'sd_repoinfo', 'error_tracking', 'cloud_cost', and 'ml_obs'.", + "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.", "example": "logs", "type": "string" } @@ -378351,7 +378448,7 @@ "description": "Response containing a single dataset object.", "properties": { "data": { - "description": "Dataset object.", + "description": "Dataset object.\n\n### Datasets Constraints\n- **Tag Limit per Dataset**:\n - Each restricted dataset supports a maximum of 10 key:value pairs per product.\n\n- **Tag Key Rules per Telemetry Type**:\n - Only one tag key or attribute may be used to define access within a single telemetry type.\n - The same or different tag key may be used across different telemetry types.\n\n- **Tag Value Uniqueness**:\n - Tag values must be unique within a single dataset.\n - A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.", "properties": { "attributes": { "description": "Dataset metadata and configuration(s).", @@ -378400,7 +378497,7 @@ "type": "array" }, "product": { - "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum', 'synthetics',\n'metrics', 'logs', 'sd_repoinfo', 'error_tracking', 'cloud_cost', and 'ml_obs'.", + "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.", "example": "logs", "type": "string" } @@ -378774,7 +378871,7 @@ "description": "Response containing a single dataset object.", "properties": { "data": { - "description": "Dataset object.", + "description": "Dataset object.\n\n### Datasets Constraints\n- **Tag Limit per Dataset**:\n - Each restricted dataset supports a maximum of 10 key:value pairs per product.\n\n- **Tag Key Rules per Telemetry Type**:\n - Only one tag key or attribute may be used to define access within a single telemetry type.\n - The same or different tag key may be used across different telemetry types.\n\n- **Tag Value Uniqueness**:\n - Tag values must be unique within a single dataset.\n - A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.", "properties": { "attributes": { "description": "Dataset metadata and configuration(s).", @@ -378823,7 +378920,7 @@ "type": "array" }, "product": { - "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum', 'synthetics',\n'metrics', 'logs', 'sd_repoinfo', 'error_tracking', 'cloud_cost', and 'ml_obs'.", + "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.", "example": "logs", "type": "string" } @@ -379005,6 +379102,367 @@ "x-undo": { "type": "safe" } + }, + "put": { + "description": "Edits the dataset associated with the ID.", + "operationId": "UpdateDataset", + "parameters": [ + { + "description": "The ID of a defined dataset.", + "example": "0879ce27-29a1-481f-a12e-bc2a48ec9ae1", + "in": "path", + "name": "dataset_id", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Edit request for a dataset.", + "properties": { + "data": { + "description": "Dataset object.\n\n### Datasets Constraints\n- **Tag Limit per Dataset**:\n - Each restricted dataset supports a maximum of 10 key:value pairs per product.\n\n- **Tag Key Rules per Telemetry Type**:\n - Only one tag key or attribute may be used to define access within a single telemetry type.\n - The same or different tag key may be used across different telemetry types.\n\n- **Tag Value Uniqueness**:\n - Tag values must be unique within a single dataset.\n - A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.", + "properties": { + "attributes": { + "description": "Dataset metadata and configuration(s).", + "properties": { + "created_at": { + "description": "Timestamp when the dataset was created.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "created_by": { + "description": "Unique ID of the user who created the dataset.", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "Name of the dataset.", + "example": "Security Audit Dataset", + "type": "string" + }, + "principals": { + "description": "List of access principals, formatted as `principal_type:id`. Principal can be 'team' or 'role'.", + "example": [ + "role:86245fce-0a4e-11f0-92bd-da7ad0900002" + ], + "items": { + "example": "role:86245fce-0a4e-11f0-92bd-da7ad0900002", + "type": "string" + }, + "type": "array" + }, + "product_filters": { + "description": "List of product-specific filters.", + "items": { + "description": "Product-specific filters for the dataset.", + "properties": { + "filters": { + "description": "Defines the list of tag-based filters used to restrict access to telemetry data for a specific product.\nThese filters act as access control rules. Each filter must follow the tag query syntax used by\nDatadog (such as `@tag.key:value`), and only one tag or attribute may be used to define the access strategy\nper telemetry type.", + "example": [ + "@application.id:ABCD" + ], + "items": { + "example": "@application.id:ABCD", + "type": "string" + }, + "type": "array" + }, + "product": { + "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.", + "example": "logs", + "type": "string" + } + }, + "required": [ + "product", + "filters" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "name", + "product_filters", + "principals" + ], + "type": "object" + }, + "id": { + "description": "Unique identifier for the dataset.", + "example": "123e4567-e89b-12d3-a456-426614174000", + "type": "string" + }, + "type": { + "description": "Resource type, always \"dataset\".", + "example": "dataset", + "type": "string" + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "Dataset payload", + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response containing a single dataset object.", + "properties": { + "data": { + "description": "Dataset object.\n\n### Datasets Constraints\n- **Tag Limit per Dataset**:\n - Each restricted dataset supports a maximum of 10 key:value pairs per product.\n\n- **Tag Key Rules per Telemetry Type**:\n - Only one tag key or attribute may be used to define access within a single telemetry type.\n - The same or different tag key may be used across different telemetry types.\n\n- **Tag Value Uniqueness**:\n - Tag values must be unique within a single dataset.\n - A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.", + "properties": { + "attributes": { + "description": "Dataset metadata and configuration(s).", + "properties": { + "created_at": { + "description": "Timestamp when the dataset was created.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "created_by": { + "description": "Unique ID of the user who created the dataset.", + "format": "uuid", + "type": "string" + }, + "name": { + "description": "Name of the dataset.", + "example": "Security Audit Dataset", + "type": "string" + }, + "principals": { + "description": "List of access principals, formatted as `principal_type:id`. Principal can be 'team' or 'role'.", + "example": [ + "role:86245fce-0a4e-11f0-92bd-da7ad0900002" + ], + "items": { + "example": "role:86245fce-0a4e-11f0-92bd-da7ad0900002", + "type": "string" + }, + "type": "array" + }, + "product_filters": { + "description": "List of product-specific filters.", + "items": { + "description": "Product-specific filters for the dataset.", + "properties": { + "filters": { + "description": "Defines the list of tag-based filters used to restrict access to telemetry data for a specific product.\nThese filters act as access control rules. Each filter must follow the tag query syntax used by\nDatadog (such as `@tag.key:value`), and only one tag or attribute may be used to define the access strategy\nper telemetry type.", + "example": [ + "@application.id:ABCD" + ], + "items": { + "example": "@application.id:ABCD", + "type": "string" + }, + "type": "array" + }, + "product": { + "description": "Name of the product the dataset is for. Possible values are 'apm', 'rum',\n'metrics', 'logs', 'error_tracking', and 'cloud_cost'.", + "example": "logs", + "type": "string" + } + }, + "required": [ + "product", + "filters" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "name", + "product_filters", + "principals" + ], + "type": "object" + }, + "id": { + "description": "Unique identifier for the dataset.", + "example": "123e4567-e89b-12d3-a456-426614174000", + "type": "string" + }, + "type": { + "description": "Resource type, always \"dataset\".", + "example": "dataset", + "type": "string" + } + }, + "required": [ + "type", + "attributes" + ], + "type": "object" + } + }, + "required": [ + "data" + ], + "type": "object" + } + } + }, + "description": "OK" + }, + "400": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Bad Request" + }, + "403": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Authorized" + }, + "404": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Not Found" + }, + "429": { + "content": { + "application/json": { + "schema": { + "description": "API error response.", + "properties": { + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" + ], + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "errors" + ], + "type": "object" + } + } + }, + "description": "Too many requests" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [] + } + ], + "summary": "Edit a dataset", + "tags": [ + "Datasets" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 4, + "x-permission": { + "operator": "OPEN", + "permissions": [] + }, + "x-undo": { + "type": "idempotent" + } } }, "/api/v2/domain_allowlist": {