Language

English Français 日本語 한국어 Español

Datadog Site

Site help
US1 US3 US5 EU AP1 US1-FED

App Builder

Datadog App Builder provides a low-code solution to rapidly develop and integrate secure, customized applications into your monitoring stack that are built to accelerate remediation at scale. These API endpoints allow you to create, read, update, delete, and publish apps.

List Apps

Note: App Builder API endpoints are still under active development and might change at any time.

GET https://api.ap1.datadoghq.com/api/v2/app-builder/appshttps://api.datadoghq.eu/api/v2/app-builder/appshttps://api.ddog-gov.com/api/v2/app-builder/appshttps://api.datadoghq.com/api/v2/app-builder/appshttps://api.us3.datadoghq.com/api/v2/app-builder/appshttps://api.us5.datadoghq.com/api/v2/app-builder/apps

Overview

List all apps, with optional filters and sorting. This endpoint is paginated. Only basic app information such as the app ID, name, and description is returned by this endpoint. This endpoint requires the apps_run permission.

Arguments

Query Strings

Name

Type

Description

limit

integer

The number of apps to return per page.

page

integer

The page number to return.

filter[user_name]

string

Filter apps by the app creator. Usually the user’s email.

filter[user_uuid]

string

Filter apps by the app creator’s UUID.

filter[name]

string

Filter by app name.

filter[query]

string

Filter apps by the app name or the app creator.

filter[deployed]

boolean

Filter apps by whether they are published.

filter[tags]

string

Filter apps by tags.

filter[favorite]

boolean

Filter apps by whether you have added them to your favorites.

filter[self_service]

boolean

Filter apps by whether they are enabled for self-service.

sort

array

The fields and direction to sort apps by.

Response

OK

A paginated list of apps matching the specified filters and sorting.

Expand All

Field

Type

Description

data

[object]

An array of app definitions.

attributes [required]

object

Basic information about the app such as name, description, and tags.

description

string

A human-readable description for the app.

favorite

boolean

Whether the app is marked as a favorite by the current user.

name

string

The name of the app.

selfService

boolean

Whether the app is enabled for use in the Datadog self-service hub.

tags

[string]

A list of tags for the app, which can be used to filter apps.

id [required]

uuid

The ID of the app.

meta

object

Metadata of an app.

created_at

date-time

Timestamp of when the app was created.

deleted_at

date-time

Timestamp of when the app was deleted.

org_id

int64

The Datadog organization ID that owns the app.

updated_at

date-time

Timestamp of when the app was last updated.

updated_since_deployment

boolean

Whether the app was updated since it was last published. Published apps are pinned to a specific version and do not automatically update when the app is updated.

user_id

int64

The ID of the user who created the app.

user_name

string

The name (or email address) of the user who created the app.

user_uuid

uuid

The UUID of the user who created the app.

version

int64

The version number of the app. This starts at 1 and increments with each update.

relationships

object

The app's publication information.

deployment

object

Information pointing to the app's publication status.

data

object

Data object containing the deployment ID.

id

uuid

The deployment ID.

type

enum

The deployment type. Allowed enum values: deployment

default: deployment

meta

object

Metadata object containing the publication creation information.

created_at

date-time

Timestamp of when the app was published.

user_id

int64

The ID of the user who published the app.

user_name

string

The name (or email address) of the user who published the app.

user_uuid

uuid

The UUID of the user who published the app.

type [required]

enum

The app definition type. Allowed enum values: appDefinitions

default: appDefinitions

included

[object]

Data on the version of the app that was published.

attributes

object

The attributes object containing the version ID of the published app.

app_version_id

uuid

The version ID of the app that was published. For an unpublished app, this is always the nil UUID (00000000-0000-0000-0000-000000000000).

id

uuid

The deployment ID.

meta

object

Metadata object containing the publication creation information.

created_at

date-time

Timestamp of when the app was published.

user_id

int64

The ID of the user who published the app.

user_name

string

The name (or email address) of the user who published the app.

user_uuid

uuid

The UUID of the user who published the app.

type

enum

The deployment type. Allowed enum values: deployment

default: deployment

meta

object

Pagination metadata.

page

object

Information on the total number of apps, to be used for pagination.

totalCount

int64

The total number of apps under the Datadog organization, disregarding any filters applied.

totalFilteredCount

int64

The total number of apps that match the specified filters.

{
  "data": [
    {
      "attributes": {
        "description": "string",
        "favorite": false,
        "name": "string",
        "selfService": false,
        "tags": [
          "service:webshop-backend",
          "team:webshop"
        ]
      },
      "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
      "meta": {
        "created_at": "2019-09-19T10:00:00.000Z",
        "deleted_at": "2019-09-19T10:00:00.000Z",
        "org_id": "integer",
        "updated_at": "2019-09-19T10:00:00.000Z",
        "updated_since_deployment": false,
        "user_id": "integer",
        "user_name": "string",
        "user_uuid": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
        "version": "integer"
      },
      "relationships": {
        "deployment": {
          "data": {
            "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
            "type": "deployment"
          },
          "meta": {
            "created_at": "2019-09-19T10:00:00.000Z",
            "user_id": "integer",
            "user_name": "string",
            "user_uuid": "65bb1f25-52e1-4510-9f8d-22d1516ed693"
          }
        }
      },
      "type": "appDefinitions"
    }
  ],
  "included": [
    {
      "attributes": {
        "app_version_id": "65bb1f25-52e1-4510-9f8d-22d1516ed693"
      },
      "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
      "meta": {
        "created_at": "2019-09-19T10:00:00.000Z",
        "user_id": "integer",
        "user_name": "string",
        "user_uuid": "65bb1f25-52e1-4510-9f8d-22d1516ed693"
      },
      "type": "deployment"
    }
  ],
  "meta": {
    "page": {
      "totalCount": "integer",
      "totalFilteredCount": "integer"
    }
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Forbidden

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Code Example

                  # Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/app-builder/apps" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

Create App

Note: App Builder API endpoints are still under active development and might change at any time.

POST https://api.ap1.datadoghq.com/api/v2/app-builder/appshttps://api.datadoghq.eu/api/v2/app-builder/appshttps://api.ddog-gov.com/api/v2/app-builder/appshttps://api.datadoghq.com/api/v2/app-builder/appshttps://api.us3.datadoghq.com/api/v2/app-builder/appshttps://api.us5.datadoghq.com/api/v2/app-builder/apps

Overview

Create a new app, returning the app ID. This endpoint requires all of the following permissions:

  • apps_write
  • connections_resolve
  • workflows_run

    • Request

    Body Data (required)

    Expand All

    Field

    Type

    Description

    data

    object

    The data object containing the app definition.

    attributes

    object

    App definition attributes such as name, description, and components.

    components

    [object]

    The UI components that make up the app.

    events

    [object]

    Events to listen for on the grid component.

    name

    enum

    The triggering action for the event. Allowed enum values: pageChange,tableRowClick,_tableRowButtonClick,change,submit,click,toggleOpen,close,open,executionFinished

    type

    enum

    The response to the event. Allowed enum values: custom,setComponentState,triggerQuery,openModal,closeModal,openUrl,downloadFile,setStateVariableValue

    id

    string

    The ID of the grid component. This property is deprecated; use name to identify individual components instead.

    name [required]

    string

    A unique identifier for this grid component. This name is also visible in the app editor.

    properties [required]

    object

    Properties of a grid component.

    backgroundColor

    string

    The background color of the grid.

    default: default

    children

    [object]

    The child components of the grid.

    events

    [object]

    Events to listen for on the UI component.

    name

    enum

    The triggering action for the event. Allowed enum values: pageChange,tableRowClick,_tableRowButtonClick,change,submit,click,toggleOpen,close,open,executionFinished

    type

    enum

    The response to the event. Allowed enum values: custom,setComponentState,triggerQuery,openModal,closeModal,openUrl,downloadFile,setStateVariableValue

    id

    string

    The ID of the UI component. This property is deprecated; use name to identify individual components instead.

    name [required]

    string

    A unique identifier for this UI component. This name is also visible in the app editor.

    properties [required]

    object

    Properties of a UI component. Different component types can have their own additional unique properties. See the components documentation for more detail on each component type and its properties.

    children

    [object]

    The child components of the UI component.

    isVisible

     <oneOf>

    Whether the UI component is visible. If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.

    Option 1

    boolean

    Option 2

    string

    If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.

    type [required]

    enum

    The UI component type. Allowed enum values: table,textInput,textArea,button,text,select,modal,schemaForm,checkbox,tabs,vegaChart,radioButtons,numberInput,fileInput,jsonInput,gridCell,dateRangePicker,search,container,calloutValue

    isVisible

     <oneOf>

    Whether the grid component and its children are visible. If a string, it must be a valid JavaScript expression that evaluates to a boolean.

    Option 1

    string

    Option 2

    boolean

    default: true

    type [required]

    enum

    The grid component type. Allowed enum values: grid

    default: grid

    description

    string

    A human-readable description for the app.

    name

    string

    The name of the app.

    queries

    [object]

    An array of queries, such as external actions and state variables, that the app uses.

    events

    [object]

    Events to listen for downstream of the query.

    name

    enum

    The triggering action for the event. Allowed enum values: pageChange,tableRowClick,_tableRowButtonClick,change,submit,click,toggleOpen,close,open,executionFinished

    type

    enum

    The response to the event. Allowed enum values: custom,setComponentState,triggerQuery,openModal,closeModal,openUrl,downloadFile,setStateVariableValue

    id [required]

    uuid

    The ID of the query.

    name [required]

    string

    The name of the query. The name must be unique within the app and is visible in the app editor.

    properties

    The properties of the query. The properties vary depending on the query type.

    type [required]

    enum

    The query type. Allowed enum values: action,stateVariable,dataTransform

    rootInstanceName

    string

    The name of the root component of the app. This must be a grid component that contains all other components.

    tags

    [string]

    A list of tags for the app, which can be used to filter apps.

    type [required]

    enum

    The app definition type. Allowed enum values: appDefinitions

    default: appDefinitions

    {
  "data": {
    "attributes": {
      "components": [
        {
          "events": [],
          "name": "grid0",
          "properties": {
            "children": [
              {
                "events": [],
                "name": "gridCell0",
                "properties": {
                  "children": [
                    {
                      "events": [],
                      "name": "calloutValue0",
                      "properties": {
                        "isVisible": true,
                        "isUnpublishd": false,
                        "isLoading": false,
                        "label": "CPU Usage",
                        "size": "sm",
                        "style": "vivid_yellow",
                        "unit": "kB",
                        "value": "42"
                      },
                      "type": "calloutValue"
                    }
                  ],
                  "isVisible": "true",
                  "layout": {
                    "default": {
                      "height": 8,
                      "width": 2,
                      "x": 0,
                      "y": 0
                    }
                  }
                },
                "type": "gridCell"
              }
            ]
          },
          "type": "grid"
        }
      ],
      "description": "This is a simple example app",
      "queries": [],
      "name": "Example App",
      "rootInstanceName": "grid0"
    },
    "type": "appDefinitions"
  }
}

    Response

    Created

    The response object after a new app is successfully created, with the app ID.

    Expand All

    Field

    Type

    Description

    data

    object

    The data object containing the app ID.

    id [required]

    uuid

    The ID of the created app.

    type [required]

    enum

    The app definition type. Allowed enum values: appDefinitions

    default: appDefinitions

    {
  "data": {
    "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
    "type": "appDefinitions"
  }
}

    Bad Request

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

    Forbidden

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

    Too many requests

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

    {
  "errors": [
    "Bad Request"
  ]
}

    Code Example

                              # Curl command
    curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/app-builder/apps" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "components": [
        {
          "events": [],
          "name": "grid0",
          "properties": {
            "children": [
              {
                "events": [],
                "name": "gridCell0",
                "properties": {
                  "children": [
                    {
                      "events": [],
                      "name": "calloutValue0",
                      "properties": {
                        "isVisible": true,
                        "isUnpublishd": false,
                        "isLoading": false,
                        "label": "CPU Usage",
                        "size": "sm",
                        "style": "vivid_yellow",
                        "unit": "kB",
                        "value": "42"
                      },
                      "type": "calloutValue"
                    }
                  ],
                  "isVisible": "true",
                  "layout": {
                    "default": {
                      "height": 8,
                      "width": 2,
                      "x": 0,
                      "y": 0
                    }
                  }
                },
                "type": "gridCell"
              }
            ]
          },
          "type": "grid"
        }
      ],
      "description": "This is a simple example app",
      "queries": [],
      "name": "Example App",
      "rootInstanceName": "grid0"
    },
    "type": "appDefinitions"
  }
}
EOF

    Delete Multiple Apps

    Note: App Builder API endpoints are still under active development and might change at any time.

    DELETE https://api.ap1.datadoghq.com/api/v2/app-builder/appshttps://api.datadoghq.eu/api/v2/app-builder/appshttps://api.ddog-gov.com/api/v2/app-builder/appshttps://api.datadoghq.com/api/v2/app-builder/appshttps://api.us3.datadoghq.com/api/v2/app-builder/appshttps://api.us5.datadoghq.com/api/v2/app-builder/apps

    Overview

    Delete multiple apps in a single request from a list of app IDs. This endpoint requires the apps_write permission.

    Request

    Body Data (required)

    Expand All

    Field

    Type

    Description

    data

    [object]

    An array of objects containing the IDs of the apps to delete.

    id [required]

    uuid

    The ID of the app to delete.

    type [required]

    enum

    The app definition type. Allowed enum values: appDefinitions

    default: appDefinitions

    {
  "data": [
    {
      "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
      "type": "appDefinitions"
    }
  ]
}

    Response

    OK

    The response object after multiple apps are successfully deleted.

    Expand All

    Field

    Type

    Description

    data

    [object]

    An array of objects containing the IDs of the deleted apps.

    id [required]

    uuid

    The ID of the deleted app.

    type [required]

    enum

    The app definition type. Allowed enum values: appDefinitions

    default: appDefinitions

    {
  "data": [
    {
      "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
      "type": "appDefinitions"
    }
  ]
}

    Bad Request

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

    Forbidden

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

    Not Found

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

    Too many requests

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

    {
  "errors": [
    "Bad Request"
  ]
}

    Code Example

                              # Curl command
    curl -X DELETE "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/app-builder/apps" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "data": [
    {
      "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
      "type": "appDefinitions"
    }
  ]
}
EOF

    Get App

    Note: App Builder API endpoints are still under active development and might change at any time.

    GET https://api.ap1.datadoghq.com/api/v2/app-builder/apps/{app_id}https://api.datadoghq.eu/api/v2/app-builder/apps/{app_id}https://api.ddog-gov.com/api/v2/app-builder/apps/{app_id}https://api.datadoghq.com/api/v2/app-builder/apps/{app_id}https://api.us3.datadoghq.com/api/v2/app-builder/apps/{app_id}https://api.us5.datadoghq.com/api/v2/app-builder/apps/{app_id}

    Overview

    Get the full definition of an app. This endpoint requires all of the following permissions:

  • apps_run
  • connections_read

    • Arguments

    Path Parameters

    Name

    Type

    Description

    app_id [required]

    string

    The ID of the app to retrieve.

    Query Strings

    Name

    Type

    Description

    version

    string

    The version number of the app to retrieve. If not specified, the latest version is returned. Version numbers start at 1 and increment with each update. The special values latest and deployed can be used to retrieve the latest version or the published version, respectively.

    Response

    OK

    The full app definition response object.

    Expand All

    Field

    Type

    Description

    data

    object

    The data object containing the app definition.

    attributes [required]

    object

    The app definition attributes, such as name, description, and components.

    components

    [object]

    The UI components that make up the app.

    events

    [object]

    Events to listen for on the grid component.

    name

    enum

    The triggering action for the event. Allowed enum values: pageChange,tableRowClick,_tableRowButtonClick,change,submit,click,toggleOpen,close,open,executionFinished

    type

    enum

    The response to the event. Allowed enum values: custom,setComponentState,triggerQuery,openModal,closeModal,openUrl,downloadFile,setStateVariableValue

    id

    string

    The ID of the grid component. This property is deprecated; use name to identify individual components instead.

    name [required]

    string

    A unique identifier for this grid component. This name is also visible in the app editor.

    properties [required]

    object

    Properties of a grid component.

    backgroundColor

    string

    The background color of the grid.

    default: default

    children

    [object]

    The child components of the grid.

    events

    [object]

    Events to listen for on the UI component.

    name

    enum

    The triggering action for the event. Allowed enum values: pageChange,tableRowClick,_tableRowButtonClick,change,submit,click,toggleOpen,close,open,executionFinished

    type

    enum

    The response to the event. Allowed enum values: custom,setComponentState,triggerQuery,openModal,closeModal,openUrl,downloadFile,setStateVariableValue

    id

    string

    The ID of the UI component. This property is deprecated; use name to identify individual components instead.

    name [required]

    string

    A unique identifier for this UI component. This name is also visible in the app editor.

    properties [required]

    object

    Properties of a UI component. Different component types can have their own additional unique properties. See the components documentation for more detail on each component type and its properties.

    children

    [object]

    The child components of the UI component.

    isVisible

     <oneOf>

    Whether the UI component is visible. If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.

    Option 1

    boolean

    Option 2

    string

    If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.

    type [required]

    enum

    The UI component type. Allowed enum values: table,textInput,textArea,button,text,select,modal,schemaForm,checkbox,tabs,vegaChart,radioButtons,numberInput,fileInput,jsonInput,gridCell,dateRangePicker,search,container,calloutValue

    isVisible

     <oneOf>

    Whether the grid component and its children are visible. If a string, it must be a valid JavaScript expression that evaluates to a boolean.

    Option 1

    string

    Option 2

    boolean

    default: true

    type [required]

    enum

    The grid component type. Allowed enum values: grid

    default: grid

    description

    string

    A human-readable description for the app.

    favorite

    boolean

    Whether the app is marked as a favorite by the current user.

    name

    string

    The name of the app.

    queries

    [object]

    An array of queries, such as external actions and state variables, that the app uses.

    events

    [object]

    Events to listen for downstream of the query.

    name

    enum

    The triggering action for the event. Allowed enum values: pageChange,tableRowClick,_tableRowButtonClick,change,submit,click,toggleOpen,close,open,executionFinished

    type

    enum

    The response to the event. Allowed enum values: custom,setComponentState,triggerQuery,openModal,closeModal,openUrl,downloadFile,setStateVariableValue

    id [required]

    uuid

    The ID of the query.

    name [required]

    string

    The name of the query. The name must be unique within the app and is visible in the app editor.

    properties

    The properties of the query. The properties vary depending on the query type.

    type [required]

    enum

    The query type. Allowed enum values: action,stateVariable,dataTransform

    rootInstanceName

    string

    The name of the root component of the app. This must be a grid component that contains all other components.

    tags

    [string]

    A list of tags for the app, which can be used to filter apps.

    id [required]

    uuid

    The ID of the app.

    type [required]

    enum

    The app definition type. Allowed enum values: appDefinitions

    default: appDefinitions

    included

    [object]

    Data on the version of the app that was published.

    attributes

    object

    The attributes object containing the version ID of the published app.

    app_version_id

    uuid

    The version ID of the app that was published. For an unpublished app, this is always the nil UUID (00000000-0000-0000-0000-000000000000).

    id

    uuid

    The deployment ID.

    meta

    object

    Metadata object containing the publication creation information.

    created_at

    date-time

    Timestamp of when the app was published.

    user_id

    int64

    The ID of the user who published the app.

    user_name

    string

    The name (or email address) of the user who published the app.

    user_uuid

    uuid

    The UUID of the user who published the app.

    type

    enum

    The deployment type. Allowed enum values: deployment

    default: deployment

    meta

    object

    Metadata of an app.

    created_at

    date-time

    Timestamp of when the app was created.

    deleted_at

    date-time

    Timestamp of when the app was deleted.

    org_id

    int64

    The Datadog organization ID that owns the app.

    updated_at

    date-time

    Timestamp of when the app was last updated.

    updated_since_deployment

    boolean

    Whether the app was updated since it was last published. Published apps are pinned to a specific version and do not automatically update when the app is updated.

    user_id

    int64

    The ID of the user who created the app.

    user_name

    string

    The name (or email address) of the user who created the app.

    user_uuid

    uuid

    The UUID of the user who created the app.

    version

    int64

    The version number of the app. This starts at 1 and increments with each update.

    relationship

    object

    The app's publication relationship and custom connections.

    connections

    [object]

    Array of custom connections used by the app.

    attributes

    object

    The custom connection attributes.

    name

    string

    The name of the custom connection.

    onPremRunner

    object

    Information about the Private Action Runner used by the custom connection, if the custom connection is associated with a Private Action Runner.

    id

    string

    The Private Action Runner ID.

    url

    string

    The URL of the Private Action Runner.

    id

    uuid

    The ID of the custom connection.

    type

    enum

    The custom connection type. Allowed enum values: custom_connections

    default: custom_connections

    deployment

    object

    Information pointing to the app's publication status.

    data

    object

    Data object containing the deployment ID.

    id

    uuid

    The deployment ID.

    type

    enum

    The deployment type. Allowed enum values: deployment

    default: deployment

    meta

    object

    Metadata object containing the publication creation information.

    created_at

    date-time

    Timestamp of when the app was published.

    user_id

    int64

    The ID of the user who published the app.

    user_name

    string

    The name (or email address) of the user who published the app.

    user_uuid

    uuid

    The UUID of the user who published the app.

    {
  "data": {
    "attributes": {
      "components": [
        {
          "events": [
            {
              "name": "click",
              "type": "triggerQuery"
            }
          ],
          "id": "string",
          "name": "",
          "properties": {
            "backgroundColor": "string",
            "children": [
              {
                "events": [
                  {
                    "name": "click",
                    "type": "triggerQuery"
                  }
                ],
                "id": "string",
                "name": "",
                "properties": {
                  "children": [],
                  "isVisible": {
                    "type": "undefined"
                  }
                },
                "type": "text"
              }
            ],
            "isVisible": {
              "type": "undefined"
            }
          },
          "type": "grid"
        }
      ],
      "description": "string",
      "favorite": false,
      "name": "string",
      "queries": [
        {
          "events": [
            {
              "name": "click",
              "type": "triggerQuery"
            }
          ],
          "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
          "name": "",
          "properties": "undefined",
          "type": "action"
        }
      ],
      "rootInstanceName": "string",
      "tags": [
        "service:webshop-backend",
        "team:webshop"
      ]
    },
    "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
    "type": "appDefinitions"
  },
  "included": [
    {
      "attributes": {
        "app_version_id": "65bb1f25-52e1-4510-9f8d-22d1516ed693"
      },
      "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
      "meta": {
        "created_at": "2019-09-19T10:00:00.000Z",
        "user_id": "integer",
        "user_name": "string",
        "user_uuid": "65bb1f25-52e1-4510-9f8d-22d1516ed693"
      },
      "type": "deployment"
    }
  ],
  "meta": {
    "created_at": "2019-09-19T10:00:00.000Z",
    "deleted_at": "2019-09-19T10:00:00.000Z",
    "org_id": "integer",
    "updated_at": "2019-09-19T10:00:00.000Z",
    "updated_since_deployment": false,
    "user_id": "integer",
    "user_name": "string",
    "user_uuid": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
    "version": "integer"
  },
  "relationship": {
    "connections": [
      {
        "attributes": {
          "name": "string",
          "onPremRunner": {
            "id": "string",
            "url": "string"
          }
        },
        "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
        "type": "custom_connections"
      }
    ],
    "deployment": {
      "data": {
        "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
        "type": "deployment"
      },
      "meta": {
        "created_at": "2019-09-19T10:00:00.000Z",
        "user_id": "integer",
        "user_name": "string",
        "user_uuid": "65bb1f25-52e1-4510-9f8d-22d1516ed693"
      }
    }
  }
}

    Bad Request

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

    Forbidden

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

    Not Found

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

    Too many requests

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

    {
  "errors": [
    "Bad Request"
  ]
}

    Code Example

                      # Path parameters
    export app_id="65bb1f25-52e1-4510-9f8d-22d1516ed693"
    # Curl command
    curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/app-builder/apps/${app_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

    Update App

    Note: App Builder API endpoints are still under active development and might change at any time.

    PATCH https://api.ap1.datadoghq.com/api/v2/app-builder/apps/{app_id}https://api.datadoghq.eu/api/v2/app-builder/apps/{app_id}https://api.ddog-gov.com/api/v2/app-builder/apps/{app_id}https://api.datadoghq.com/api/v2/app-builder/apps/{app_id}https://api.us3.datadoghq.com/api/v2/app-builder/apps/{app_id}https://api.us5.datadoghq.com/api/v2/app-builder/apps/{app_id}

    Overview

    Update an existing app. This creates a new version of the app. This endpoint requires all of the following permissions:

  • apps_write
  • connections_resolve
  • workflows_run

    • Arguments

    Path Parameters

    Name

    Type

    Description

    app_id [required]

    string

    The ID of the app to update.

    Request

    Body Data (required)

    Expand All

    Field

    Type

    Description

    data

    object

    The data object containing the new app definition. Any fields not included in the request remain unchanged.

    attributes

    object

    App definition attributes to be updated, such as name, description, and components.

    components

    [object]

    The new UI components that make up the app. If this field is set, all existing components are replaced with the new components under this field.

    events

    [object]

    Events to listen for on the grid component.

    name

    enum

    The triggering action for the event. Allowed enum values: pageChange,tableRowClick,_tableRowButtonClick,change,submit,click,toggleOpen,close,open,executionFinished

    type

    enum

    The response to the event. Allowed enum values: custom,setComponentState,triggerQuery,openModal,closeModal,openUrl,downloadFile,setStateVariableValue

    id

    string

    The ID of the grid component. This property is deprecated; use name to identify individual components instead.

    name [required]

    string

    A unique identifier for this grid component. This name is also visible in the app editor.

    properties [required]

    object

    Properties of a grid component.

    backgroundColor

    string

    The background color of the grid.

    default: default

    children

    [object]

    The child components of the grid.

    events

    [object]

    Events to listen for on the UI component.

    name

    enum

    The triggering action for the event. Allowed enum values: pageChange,tableRowClick,_tableRowButtonClick,change,submit,click,toggleOpen,close,open,executionFinished

    type

    enum

    The response to the event. Allowed enum values: custom,setComponentState,triggerQuery,openModal,closeModal,openUrl,downloadFile,setStateVariableValue

    id

    string

    The ID of the UI component. This property is deprecated; use name to identify individual components instead.

    name [required]

    string

    A unique identifier for this UI component. This name is also visible in the app editor.

    properties [required]

    object

    Properties of a UI component. Different component types can have their own additional unique properties. See the components documentation for more detail on each component type and its properties.

    children

    [object]

    The child components of the UI component.

    isVisible

     <oneOf>

    Whether the UI component is visible. If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.

    Option 1

    boolean

    Option 2

    string

    If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.

    type [required]

    enum

    The UI component type. Allowed enum values: table,textInput,textArea,button,text,select,modal,schemaForm,checkbox,tabs,vegaChart,radioButtons,numberInput,fileInput,jsonInput,gridCell,dateRangePicker,search,container,calloutValue

    isVisible

     <oneOf>

    Whether the grid component and its children are visible. If a string, it must be a valid JavaScript expression that evaluates to a boolean.

    Option 1

    string

    Option 2

    boolean

    default: true

    type [required]

    enum

    The grid component type. Allowed enum values: grid

    default: grid

    description

    string

    The new human-readable description for the app.

    name

    string

    The new name of the app.

    queries

    [object]

    The new array of queries, such as external actions and state variables, that the app uses. If this field is set, all existing queries are replaced with the new queries under this field.

    events

    [object]

    Events to listen for downstream of the query.

    name

    enum

    The triggering action for the event. Allowed enum values: pageChange,tableRowClick,_tableRowButtonClick,change,submit,click,toggleOpen,close,open,executionFinished

    type

    enum

    The response to the event. Allowed enum values: custom,setComponentState,triggerQuery,openModal,closeModal,openUrl,downloadFile,setStateVariableValue

    id [required]

    uuid

    The ID of the query.

    name [required]

    string

    The name of the query. The name must be unique within the app and is visible in the app editor.

    properties

    The properties of the query. The properties vary depending on the query type.

    type [required]

    enum

    The query type. Allowed enum values: action,stateVariable,dataTransform

    rootInstanceName

    string

    The new name of the root component of the app. This must be a grid component that contains all other components.

    tags

    [string]

    The new list of tags for the app, which can be used to filter apps. If this field is set, any existing tags not included in the request are removed.

    id

    uuid

    The ID of the app to update. The app ID must match the ID in the URL path.

    type [required]

    enum

    The app definition type. Allowed enum values: appDefinitions

    default: appDefinitions

    {
  "data": {
    "attributes": {
      "name": "Updated Name",
      "rootInstanceName": "grid0"
    },
    "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
    "type": "appDefinitions"
  }
}

    Response

    OK

    The response object after an app is successfully updated.

    Expand All

    Field

    Type

    Description

    data

    object

    The data object containing the updated app definition.

    attributes [required]

    object

    The updated app definition attributes, such as name, description, and components.

    components

    [object]

    The UI components that make up the app.

    events

    [object]

    Events to listen for on the grid component.

    name

    enum

    The triggering action for the event. Allowed enum values: pageChange,tableRowClick,_tableRowButtonClick,change,submit,click,toggleOpen,close,open,executionFinished

    type

    enum

    The response to the event. Allowed enum values: custom,setComponentState,triggerQuery,openModal,closeModal,openUrl,downloadFile,setStateVariableValue

    id

    string

    The ID of the grid component. This property is deprecated; use name to identify individual components instead.

    name [required]

    string

    A unique identifier for this grid component. This name is also visible in the app editor.

    properties [required]

    object

    Properties of a grid component.

    backgroundColor

    string

    The background color of the grid.

    default: default

    children

    [object]

    The child components of the grid.

    events

    [object]

    Events to listen for on the UI component.

    name

    enum

    The triggering action for the event. Allowed enum values: pageChange,tableRowClick,_tableRowButtonClick,change,submit,click,toggleOpen,close,open,executionFinished

    type

    enum

    The response to the event. Allowed enum values: custom,setComponentState,triggerQuery,openModal,closeModal,openUrl,downloadFile,setStateVariableValue

    id

    string

    The ID of the UI component. This property is deprecated; use name to identify individual components instead.

    name [required]

    string

    A unique identifier for this UI component. This name is also visible in the app editor.

    properties [required]

    object

    Properties of a UI component. Different component types can have their own additional unique properties. See the components documentation for more detail on each component type and its properties.

    children

    [object]

    The child components of the UI component.

    isVisible

     <oneOf>

    Whether the UI component is visible. If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.

    Option 1

    boolean

    Option 2

    string

    If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.

    type [required]

    enum

    The UI component type. Allowed enum values: table,textInput,textArea,button,text,select,modal,schemaForm,checkbox,tabs,vegaChart,radioButtons,numberInput,fileInput,jsonInput,gridCell,dateRangePicker,search,container,calloutValue

    isVisible

     <oneOf>

    Whether the grid component and its children are visible. If a string, it must be a valid JavaScript expression that evaluates to a boolean.

    Option 1

    string

    Option 2

    boolean

    default: true

    type [required]

    enum

    The grid component type. Allowed enum values: grid

    default: grid

    description

    string

    The human-readable description for the app.

    favorite

    boolean

    Whether the app is marked as a favorite by the current user.

    name

    string

    The name of the app.

    queries

    [object]

    An array of queries, such as external actions and state variables, that the app uses.

    events

    [object]

    Events to listen for downstream of the query.

    name

    enum

    The triggering action for the event. Allowed enum values: pageChange,tableRowClick,_tableRowButtonClick,change,submit,click,toggleOpen,close,open,executionFinished

    type

    enum

    The response to the event. Allowed enum values: custom,setComponentState,triggerQuery,openModal,closeModal,openUrl,downloadFile,setStateVariableValue

    id [required]

    uuid

    The ID of the query.

    name [required]

    string

    The name of the query. The name must be unique within the app and is visible in the app editor.

    properties

    The properties of the query. The properties vary depending on the query type.

    type [required]

    enum

    The query type. Allowed enum values: action,stateVariable,dataTransform

    rootInstanceName

    string

    The name of the root component of the app. This must be a grid component that contains all other components.

    tags

    [string]

    A list of tags for the app, which can be used to filter apps.

    id [required]

    uuid

    The ID of the updated app.

    type [required]

    enum

    The app definition type. Allowed enum values: appDefinitions

    default: appDefinitions

    included

    [object]

    Data on the version of the app that was published.

    attributes

    object

    The attributes object containing the version ID of the published app.

    app_version_id

    uuid

    The version ID of the app that was published. For an unpublished app, this is always the nil UUID (00000000-0000-0000-0000-000000000000).

    id

    uuid

    The deployment ID.

    meta

    object

    Metadata object containing the publication creation information.

    created_at

    date-time

    Timestamp of when the app was published.

    user_id

    int64

    The ID of the user who published the app.

    user_name

    string

    The name (or email address) of the user who published the app.

    user_uuid

    uuid

    The UUID of the user who published the app.

    type

    enum

    The deployment type. Allowed enum values: deployment

    default: deployment

    meta

    object

    Metadata of an app.

    created_at

    date-time

    Timestamp of when the app was created.

    deleted_at

    date-time

    Timestamp of when the app was deleted.

    org_id

    int64

    The Datadog organization ID that owns the app.

    updated_at

    date-time

    Timestamp of when the app was last updated.

    updated_since_deployment

    boolean

    Whether the app was updated since it was last published. Published apps are pinned to a specific version and do not automatically update when the app is updated.

    user_id

    int64

    The ID of the user who created the app.

    user_name

    string

    The name (or email address) of the user who created the app.

    user_uuid

    uuid

    The UUID of the user who created the app.

    version

    int64

    The version number of the app. This starts at 1 and increments with each update.

    relationship

    object

    The app's publication relationship and custom connections.

    connections

    [object]

    Array of custom connections used by the app.

    attributes

    object

    The custom connection attributes.

    name

    string

    The name of the custom connection.

    onPremRunner

    object

    Information about the Private Action Runner used by the custom connection, if the custom connection is associated with a Private Action Runner.

    id

    string

    The Private Action Runner ID.

    url

    string

    The URL of the Private Action Runner.

    id

    uuid

    The ID of the custom connection.

    type

    enum

    The custom connection type. Allowed enum values: custom_connections

    default: custom_connections

    deployment

    object

    Information pointing to the app's publication status.

    data

    object

    Data object containing the deployment ID.

    id

    uuid

    The deployment ID.

    type

    enum

    The deployment type. Allowed enum values: deployment

    default: deployment

    meta

    object

    Metadata object containing the publication creation information.

    created_at

    date-time

    Timestamp of when the app was published.

    user_id

    int64

    The ID of the user who published the app.

    user_name

    string

    The name (or email address) of the user who published the app.

    user_uuid

    uuid

    The UUID of the user who published the app.

    {
  "data": {
    "attributes": {
      "components": [
        {
          "events": [
            {
              "name": "click",
              "type": "triggerQuery"
            }
          ],
          "id": "string",
          "name": "",
          "properties": {
            "backgroundColor": "string",
            "children": [
              {
                "events": [
                  {
                    "name": "click",
                    "type": "triggerQuery"
                  }
                ],
                "id": "string",
                "name": "",
                "properties": {
                  "children": [],
                  "isVisible": {
                    "type": "undefined"
                  }
                },
                "type": "text"
              }
            ],
            "isVisible": {
              "type": "undefined"
            }
          },
          "type": "grid"
        }
      ],
      "description": "string",
      "favorite": false,
      "name": "string",
      "queries": [
        {
          "events": [
            {
              "name": "click",
              "type": "triggerQuery"
            }
          ],
          "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
          "name": "",
          "properties": "undefined",
          "type": "action"
        }
      ],
      "rootInstanceName": "string",
      "tags": [
        "service:webshop-backend",
        "team:webshop"
      ]
    },
    "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
    "type": "appDefinitions"
  },
  "included": [
    {
      "attributes": {
        "app_version_id": "65bb1f25-52e1-4510-9f8d-22d1516ed693"
      },
      "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
      "meta": {
        "created_at": "2019-09-19T10:00:00.000Z",
        "user_id": "integer",
        "user_name": "string",
        "user_uuid": "65bb1f25-52e1-4510-9f8d-22d1516ed693"
      },
      "type": "deployment"
    }
  ],
  "meta": {
    "created_at": "2019-09-19T10:00:00.000Z",
    "deleted_at": "2019-09-19T10:00:00.000Z",
    "org_id": "integer",
    "updated_at": "2019-09-19T10:00:00.000Z",
    "updated_since_deployment": false,
    "user_id": "integer",
    "user_name": "string",
    "user_uuid": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
    "version": "integer"
  },
  "relationship": {
    "connections": [
      {
        "attributes": {
          "name": "string",
          "onPremRunner": {
            "id": "string",
            "url": "string"
          }
        },
        "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
        "type": "custom_connections"
      }
    ],
    "deployment": {
      "data": {
        "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
        "type": "deployment"
      },
      "meta": {
        "created_at": "2019-09-19T10:00:00.000Z",
        "user_id": "integer",
        "user_name": "string",
        "user_uuid": "65bb1f25-52e1-4510-9f8d-22d1516ed693"
      }
    }
  }
}

    Bad Request

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

    Forbidden

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

    Too many requests

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

    {
  "errors": [
    "Bad Request"
  ]
}

    Code Example

                              # Path parameters
    export app_id="65bb1f25-52e1-4510-9f8d-22d1516ed693"
    # Curl command
    curl -X PATCH "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/app-builder/apps/${app_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "name": "Updated Name",
      "rootInstanceName": "grid0"
    },
    "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
    "type": "appDefinitions"
  }
}
EOF

    Delete App

    Note: App Builder API endpoints are still under active development and might change at any time.

    DELETE https://api.ap1.datadoghq.com/api/v2/app-builder/apps/{app_id}https://api.datadoghq.eu/api/v2/app-builder/apps/{app_id}https://api.ddog-gov.com/api/v2/app-builder/apps/{app_id}https://api.datadoghq.com/api/v2/app-builder/apps/{app_id}https://api.us3.datadoghq.com/api/v2/app-builder/apps/{app_id}https://api.us5.datadoghq.com/api/v2/app-builder/apps/{app_id}

    Overview

    Delete a single app. This endpoint requires the apps_write permission.

    Arguments

    Path Parameters

    Name

    Type

    Description

    app_id [required]

    string

    The ID of the app to delete.

    Response

    OK

    The response object after an app is successfully deleted.

    Expand All

    Field

    Type

    Description

    data

    object

    The definition of DeleteAppResponseData object.

    id [required]

    uuid

    The ID of the deleted app.

    type [required]

    enum

    The app definition type. Allowed enum values: appDefinitions

    default: appDefinitions

    {
  "data": {
    "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
    "type": "appDefinitions"
  }
}

    Bad Request

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

    Forbidden

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

    Not Found

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

    Gone

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

    Too many requests

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

    {
  "errors": [
    "Bad Request"
  ]
}

    Code Example

                      # Path parameters
    export app_id="65bb1f25-52e1-4510-9f8d-22d1516ed693"
    # Curl command
    curl -X DELETE "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/app-builder/apps/${app_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

    Publish App

    Note: App Builder API endpoints are still under active development and might change at any time.

    POST https://api.ap1.datadoghq.com/api/v2/app-builder/apps/{app_id}/deploymenthttps://api.datadoghq.eu/api/v2/app-builder/apps/{app_id}/deploymenthttps://api.ddog-gov.com/api/v2/app-builder/apps/{app_id}/deploymenthttps://api.datadoghq.com/api/v2/app-builder/apps/{app_id}/deploymenthttps://api.us3.datadoghq.com/api/v2/app-builder/apps/{app_id}/deploymenthttps://api.us5.datadoghq.com/api/v2/app-builder/apps/{app_id}/deployment

    Overview

    Publish an app for use by other users. To ensure the app is accessible to the correct users, you also need to set a Restriction Policy on the app if a policy does not yet exist. This endpoint requires the apps_write permission.

    Arguments

    Path Parameters

    Name

    Type

    Description

    app_id [required]

    string

    The ID of the app to publish.

    Response

    Created

    The response object after an app is successfully published.

    Expand All

    Field

    Type

    Description

    data

    object

    The version of the app that was published.

    attributes

    object

    The attributes object containing the version ID of the published app.

    app_version_id

    uuid

    The version ID of the app that was published. For an unpublished app, this is always the nil UUID (00000000-0000-0000-0000-000000000000).

    id

    uuid

    The deployment ID.

    meta

    object

    Metadata object containing the publication creation information.

    created_at

    date-time

    Timestamp of when the app was published.

    user_id

    int64

    The ID of the user who published the app.

    user_name

    string

    The name (or email address) of the user who published the app.

    user_uuid

    uuid

    The UUID of the user who published the app.

    type

    enum

    The deployment type. Allowed enum values: deployment

    default: deployment

    {
  "data": {
    "attributes": {
      "app_version_id": "65bb1f25-52e1-4510-9f8d-22d1516ed693"
    },
    "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
    "meta": {
      "created_at": "2019-09-19T10:00:00.000Z",
      "user_id": "integer",
      "user_name": "string",
      "user_uuid": "65bb1f25-52e1-4510-9f8d-22d1516ed693"
    },
    "type": "deployment"
  }
}

    Bad Request

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

    Forbidden

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

    Not Found

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

    Too many requests

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

    {
  "errors": [
    "Bad Request"
  ]
}

    Code Example

                      # Path parameters
    export app_id="65bb1f25-52e1-4510-9f8d-22d1516ed693"
    # Curl command
    curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/app-builder/apps/${app_id}/deployment" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"

    Unpublish App

    Note: App Builder API endpoints are still under active development and might change at any time.

    DELETE https://api.ap1.datadoghq.com/api/v2/app-builder/apps/{app_id}/deploymenthttps://api.datadoghq.eu/api/v2/app-builder/apps/{app_id}/deploymenthttps://api.ddog-gov.com/api/v2/app-builder/apps/{app_id}/deploymenthttps://api.datadoghq.com/api/v2/app-builder/apps/{app_id}/deploymenthttps://api.us3.datadoghq.com/api/v2/app-builder/apps/{app_id}/deploymenthttps://api.us5.datadoghq.com/api/v2/app-builder/apps/{app_id}/deployment

    Overview

    Unpublish an app, removing the live version of the app. Unpublishing creates a new instance of a deployment object on the app, with a nil app_version_id (00000000-0000-0000-0000-000000000000). The app can still be updated and published again in the future. This endpoint requires the apps_write permission.

    Arguments

    Path Parameters

    Name

    Type

    Description

    app_id [required]

    string

    The ID of the app to unpublish.

    Response

    OK

    The response object after an app is successfully unpublished.

    Expand All

    Field

    Type

    Description

    data

    object

    The version of the app that was published.

    attributes

    object

    The attributes object containing the version ID of the published app.

    app_version_id

    uuid

    The version ID of the app that was published. For an unpublished app, this is always the nil UUID (00000000-0000-0000-0000-000000000000).

    id

    uuid

    The deployment ID.

    meta

    object

    Metadata object containing the publication creation information.

    created_at

    date-time

    Timestamp of when the app was published.

    user_id

    int64

    The ID of the user who published the app.

    user_name

    string

    The name (or email address) of the user who published the app.

    user_uuid

    uuid

    The UUID of the user who published the app.

    type

    enum

    The deployment type. Allowed enum values: deployment

    default: deployment

    {
  "data": {
    "attributes": {
      "app_version_id": "65bb1f25-52e1-4510-9f8d-22d1516ed693"
    },
    "id": "65bb1f25-52e1-4510-9f8d-22d1516ed693",
    "meta": {
      "created_at": "2019-09-19T10:00:00.000Z",
      "user_id": "integer",
      "user_name": "string",
      "user_uuid": "65bb1f25-52e1-4510-9f8d-22d1516ed693"
    },
    "type": "deployment"
  }
}

    Bad Request

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

    Forbidden

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

    Not Found

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [object]

    A list of errors.

    detail

    string

    A human-readable explanation specific to this occurrence of the error.

    meta

    object

    Non-standard meta-information about the error

    source

    object

    References to the source of the error.

    header

    string

    A string indicating the name of a single request header which caused the error.

    parameter

    string

    A string indicating which URI query parameter caused the error.

    pointer

    string

    A JSON pointer to the value in the request document that caused the error.

    status

    string

    Status code of the response.

    title

    string

    Short human-readable summary of the error.

    {
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

    Too many requests

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

    {
  "errors": [
    "Bad Request"
  ]
}

    Code Example

                      # Path parameters
    export app_id="65bb1f25-52e1-4510-9f8d-22d1516ed693"
    # Curl command
    curl -X DELETE "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/app-builder/apps/${app_id}/deployment" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"