errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data
\nobject
Data for updating an app's favorite status.
attributes
\nobject
Attributes for updating an app's favorite status.
favorite [required]
\nboolean
Whether the app should be marked as a favorite for the current user.
type
\nenum
The favorite resource type. \nAllowed enum values: favorites
default: favorites
data
\nobject
The data object containing the updated app definition.
attributes [required]
\nobject
The updated app definition attributes, such as name, description, and components.
components
\n[object]
The UI components that make up the app.
events
\n[object]
Events to listen for on the grid component.
name
\nenum
The triggering action for the event. \nAllowed enum values: pageChange,tableRowClick,_tableRowButtonClick,change,submit,click,toggleOpen,close,open,executionFinished
type
\nenum
The response to the event. \nAllowed enum values: custom,setComponentState,triggerQuery,openModal,closeModal,openUrl,downloadFile,setStateVariableValue
id
\nstring
The ID of the grid component. This property is deprecated; use name to identify individual components instead.
name [required]
\nstring
A unique identifier for this grid component. This name is also visible in the app editor.
properties [required]
\nobject
Properties of a grid component.
backgroundColor
\nstring
The background color of the grid.
default: default
children
\n[object]
The child components of the grid.
events
\n[object]
Events to listen for on the UI component.
name
\nenum
The triggering action for the event. \nAllowed enum values: pageChange,tableRowClick,_tableRowButtonClick,change,submit,click,toggleOpen,close,open,executionFinished
type
\nenum
The response to the event. \nAllowed enum values: custom,setComponentState,triggerQuery,openModal,closeModal,openUrl,downloadFile,setStateVariableValue
id
\nstring
The ID of the UI component. This property is deprecated; use name to identify individual components instead.
name [required]
\nstring
A unique identifier for this UI component. This name is also visible in the app editor.
properties [required]
\nobject
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
\n[object]
The child components of the UI component.
isVisible
\n<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
\nboolean
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.
type [required]
\nenum
The UI component type. \nAllowed enum values: table,textInput,textArea,button,text,select,modal,schemaForm,checkbox,tabsShow 10 more
,vegaChart,radioButtons,numberInput,fileInput,jsonInput,gridCell,dateRangePicker,search,container,calloutValue
isVisible
\n<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
\nstring
Option 2
\nboolean
default: true
type [required]
\nenum
The grid component type. \nAllowed enum values: grid
default: grid
description
\nstring
The human-readable description for the app.
favorite
\nboolean
Whether the app is marked as a favorite by the current user.
name
\nstring
The name of the app.
queries
\n[ <oneOf>]
An array of queries, such as external actions and state variables, that the app uses.
Option 1
\nobject
An action query. This query type is used to trigger an action, such as sending a HTTP request.
events
\n[object]
Events to listen for downstream of the action query.
name
\nenum
The triggering action for the event. \nAllowed enum values: pageChange,tableRowClick,_tableRowButtonClick,change,submit,click,toggleOpen,close,open,executionFinished
type
\nenum
The response to the event. \nAllowed enum values: custom,setComponentState,triggerQuery,openModal,closeModal,openUrl,downloadFile,setStateVariableValue
id [required]
\nuuid
The ID of the action query.
name [required]
\nstring
A unique identifier for this action query. This name is also used to access the query's result throughout the app.
properties [required]
\nobject
The properties of the action query.
condition
\n<oneOf>
Whether to run this query. If specified, the query will only run if this condition evaluates to true in JavaScript and all other conditions are also met.
Option 1
\nboolean
Option 2
\nstring
debounceInMs
\n<oneOf>
The minimum time in milliseconds that must pass before the query can be triggered again. This is useful for preventing accidental double-clicks from triggering the query multiple times.
Option 1
\ndouble
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a number.
mockedOutputs
\n<oneOf>
The mocked outputs of the action query. This is useful for testing the app without actually running the action.
Option 1
\nstring
Option 2
\nobject
The mocked outputs of the action query.
enabled [required]
\n<oneOf>
Whether to enable the mocked outputs for testing.
Option 1
\nboolean
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.
outputs
\nstring
The mocked outputs of the action query, serialized as JSON.
onlyTriggerManually
\n<oneOf>
Determines when this query is executed. If set to false, the query will run when the app loads and whenever any query arguments change. If set to true, the query will only run when manually triggered from elsewhere in the app.
Option 1
\nboolean
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.
outputs
\nstring
The post-query transformation function, which is a JavaScript function that changes the query's .outputs property after the query's execution.
pollingIntervalInMs
\n<oneOf>
If specified, the app will poll the query at the specified interval in milliseconds. The minimum polling interval is 15 seconds. The query will only poll when the app's browser tab is active.
Option 1
\ndouble
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a number.
requiresConfirmation
\n<oneOf>
Whether to prompt the user to confirm this query before it runs.
Option 1
\nboolean
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.
showToastOnError
\n<oneOf>
Whether to display a toast to the user when the query returns an error.
Option 1
\nboolean
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.
spec [required]
\n<oneOf>
The definition of the action query.
Option 1
\nstring
Option 2
\nobject
The action query spec object.
connectionGroup
\nobject
The connection group to use for an action query.
id
\nuuid
The ID of the connection group.
tags
\n[string]
The tags of the connection group.
connectionId
\nstring
The ID of the custom connection to use for this action query.
fqn [required]
\nstring
The fully qualified name of the action type.
inputs
\n<oneOf>
The inputs to the action query. These are the values that are passed to the action when it is triggered.
Option 1
\nstring
Option 2
\nobject
The inputs to the action query. See the Actions Catalog for more detail on each action and its inputs.
type [required]
\nenum
The action query type. \nAllowed enum values: action
default: action
Option 2
\nobject
A data transformer, which is custom JavaScript code that executes and transforms data when its inputs change.
id [required]
\nuuid
The ID of the data transformer.
name [required]
\nstring
A unique identifier for this data transformer. This name is also used to access the transformer's result throughout the app.
properties [required]
\nobject
The properties of the data transformer.
outputs
\nstring
A JavaScript function that returns the transformed data.
type [required]
\nenum
The data transform type. \nAllowed enum values: dataTransform
default: dataTransform
Option 3
\nobject
A variable, which can be set and read by other components in the app.
id [required]
\nuuid
The ID of the state variable.
name [required]
\nstring
A unique identifier for this state variable. This name is also used to access the variable's value throughout the app.
properties [required]
\nobject
The properties of the state variable.
defaultValue
\nThe default value of the state variable.
type [required]
\nenum
The state variable type. \nAllowed enum values: stateVariable
default: stateVariable
rootInstanceName
\nstring
The name of the root component of the app. This must be a grid component that contains all other components.
tags
\n[string]
A list of tags for the app, which can be used to filter apps.
id [required]
\nuuid
The ID of the updated app.
type [required]
\nenum
The app definition type. \nAllowed enum values: appDefinitions
default: appDefinitions
included
\n[object]
Data on the version of the app that was published.
attributes
\nobject
The attributes object containing the version ID of the published app.
app_version_id
\nuuid
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
\nuuid
The deployment ID.
meta
\nobject
Metadata object containing the publication creation information.
created_at
\ndate-time
Timestamp of when the app was published.
user_id
\nint64
The ID of the user who published the app.
user_name
\nstring
The name (or email address) of the user who published the app.
user_uuid
\nuuid
The UUID of the user who published the app.
type
\nenum
The deployment type. \nAllowed enum values: deployment
default: deployment
meta
\nobject
Metadata of an app.
created_at
\ndate-time
Timestamp of when the app was created.
deleted_at
\ndate-time
Timestamp of when the app was deleted.
org_id
\nint64
The Datadog organization ID that owns the app.
updated_at
\ndate-time
Timestamp of when the app was last updated.
updated_since_deployment
\nboolean
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
\nint64
The ID of the user who created the app.
user_name
\nstring
The name (or email address) of the user who created the app.
user_uuid
\nuuid
The UUID of the user who created the app.
version
\nint64
The version number of the app. This starts at 1 and increments with each update.
relationship
\nobject
The app's publication relationship and custom connections.
connections
\n[object]
Array of custom connections used by the app.
attributes
\nobject
The custom connection attributes.
name
\nstring
The name of the custom connection.
onPremRunner
\nobject
Information about the Private Action Runner used by the custom connection, if the custom connection is associated with a Private Action Runner.
id
\nstring
The Private Action Runner ID.
url
\nstring
The URL of the Private Action Runner.
id
\nuuid
The ID of the custom connection.
type
\nenum
The custom connection type. \nAllowed enum values: custom_connections
default: custom_connections
deployment
\nobject
Information pointing to the app's publication status.
data
\nobject
Data object containing the deployment ID.
id
\nuuid
The deployment ID.
type
\nenum
The deployment type. \nAllowed enum values: deployment
default: deployment
meta
\nobject
Metadata object containing the publication creation information.
created_at
\ndate-time
Timestamp of when the app was published.
user_id
\nint64
The ID of the user who published the app.
user_name
\nstring
The name (or email address) of the user who published the app.
user_uuid
\nuuid
The UUID of the user who published the app.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data
\nobject
Data for updating an app's publication protection level.
attributes
\nobject
Attributes for updating an app's publication protection level.
protectionLevel [required]
\nenum
The publication protection level of the app. approval_required means changes must go through an approval workflow before being published. \nAllowed enum values: direct_publish,approval_required
type
\nenum
The protection-level resource type. \nAllowed enum values: protectionLevel
default: protectionLevel
data
\nobject
The version of the app that was published.
attributes
\nobject
The attributes object containing the version ID of the published app.
app_version_id
\nuuid
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
\nuuid
The deployment ID.
meta
\nobject
Metadata object containing the publication creation information.
created_at
\ndate-time
Timestamp of when the app was published.
user_id
\nint64
The ID of the user who published the app.
user_name
\nstring
The name (or email address) of the user who published the app.
user_uuid
\nuuid
The UUID of the user who published the app.
type
\nenum
The deployment type. \nAllowed enum values: deployment
default: deployment
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data
\nobject
Data for creating a publish request.
attributes
\nobject
Attributes for creating a publish request.
description
\nstring
An optional description of the changes in this publish request.
title [required]
\nstring
A short title for the publish request.
type
\nenum
The publish-request resource type. \nAllowed enum values: publishRequest
default: publishRequest
data
\nobject
The data object containing the updated app definition.
attributes [required]
\nobject
The updated app definition attributes, such as name, description, and components.
components
\n[object]
The UI components that make up the app.
events
\n[object]
Events to listen for on the grid component.
name
\nenum
The triggering action for the event. \nAllowed enum values: pageChange,tableRowClick,_tableRowButtonClick,change,submit,click,toggleOpen,close,open,executionFinished
type
\nenum
The response to the event. \nAllowed enum values: custom,setComponentState,triggerQuery,openModal,closeModal,openUrl,downloadFile,setStateVariableValue
id
\nstring
The ID of the grid component. This property is deprecated; use name to identify individual components instead.
name [required]
\nstring
A unique identifier for this grid component. This name is also visible in the app editor.
properties [required]
\nobject
Properties of a grid component.
backgroundColor
\nstring
The background color of the grid.
default: default
children
\n[object]
The child components of the grid.
events
\n[object]
Events to listen for on the UI component.
name
\nenum
The triggering action for the event. \nAllowed enum values: pageChange,tableRowClick,_tableRowButtonClick,change,submit,click,toggleOpen,close,open,executionFinished
type
\nenum
The response to the event. \nAllowed enum values: custom,setComponentState,triggerQuery,openModal,closeModal,openUrl,downloadFile,setStateVariableValue
id
\nstring
The ID of the UI component. This property is deprecated; use name to identify individual components instead.
name [required]
\nstring
A unique identifier for this UI component. This name is also visible in the app editor.
properties [required]
\nobject
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
\n[object]
The child components of the UI component.
isVisible
\n<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
\nboolean
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.
type [required]
\nenum
The UI component type. \nAllowed enum values: table,textInput,textArea,button,text,select,modal,schemaForm,checkbox,tabsShow 10 more
,vegaChart,radioButtons,numberInput,fileInput,jsonInput,gridCell,dateRangePicker,search,container,calloutValue
isVisible
\n<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
\nstring
Option 2
\nboolean
default: true
type [required]
\nenum
The grid component type. \nAllowed enum values: grid
default: grid
description
\nstring
The human-readable description for the app.
favorite
\nboolean
Whether the app is marked as a favorite by the current user.
name
\nstring
The name of the app.
queries
\n[ <oneOf>]
An array of queries, such as external actions and state variables, that the app uses.
Option 1
\nobject
An action query. This query type is used to trigger an action, such as sending a HTTP request.
events
\n[object]
Events to listen for downstream of the action query.
name
\nenum
The triggering action for the event. \nAllowed enum values: pageChange,tableRowClick,_tableRowButtonClick,change,submit,click,toggleOpen,close,open,executionFinished
type
\nenum
The response to the event. \nAllowed enum values: custom,setComponentState,triggerQuery,openModal,closeModal,openUrl,downloadFile,setStateVariableValue
id [required]
\nuuid
The ID of the action query.
name [required]
\nstring
A unique identifier for this action query. This name is also used to access the query's result throughout the app.
properties [required]
\nobject
The properties of the action query.
condition
\n<oneOf>
Whether to run this query. If specified, the query will only run if this condition evaluates to true in JavaScript and all other conditions are also met.
Option 1
\nboolean
Option 2
\nstring
debounceInMs
\n<oneOf>
The minimum time in milliseconds that must pass before the query can be triggered again. This is useful for preventing accidental double-clicks from triggering the query multiple times.
Option 1
\ndouble
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a number.
mockedOutputs
\n<oneOf>
The mocked outputs of the action query. This is useful for testing the app without actually running the action.
Option 1
\nstring
Option 2
\nobject
The mocked outputs of the action query.
enabled [required]
\n<oneOf>
Whether to enable the mocked outputs for testing.
Option 1
\nboolean
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.
outputs
\nstring
The mocked outputs of the action query, serialized as JSON.
onlyTriggerManually
\n<oneOf>
Determines when this query is executed. If set to false, the query will run when the app loads and whenever any query arguments change. If set to true, the query will only run when manually triggered from elsewhere in the app.
Option 1
\nboolean
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.
outputs
\nstring
The post-query transformation function, which is a JavaScript function that changes the query's .outputs property after the query's execution.
pollingIntervalInMs
\n<oneOf>
If specified, the app will poll the query at the specified interval in milliseconds. The minimum polling interval is 15 seconds. The query will only poll when the app's browser tab is active.
Option 1
\ndouble
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a number.
requiresConfirmation
\n<oneOf>
Whether to prompt the user to confirm this query before it runs.
Option 1
\nboolean
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.
showToastOnError
\n<oneOf>
Whether to display a toast to the user when the query returns an error.
Option 1
\nboolean
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.
spec [required]
\n<oneOf>
The definition of the action query.
Option 1
\nstring
Option 2
\nobject
The action query spec object.
connectionGroup
\nobject
The connection group to use for an action query.
id
\nuuid
The ID of the connection group.
tags
\n[string]
The tags of the connection group.
connectionId
\nstring
The ID of the custom connection to use for this action query.
fqn [required]
\nstring
The fully qualified name of the action type.
inputs
\n<oneOf>
The inputs to the action query. These are the values that are passed to the action when it is triggered.
Option 1
\nstring
Option 2
\nobject
The inputs to the action query. See the Actions Catalog for more detail on each action and its inputs.
type [required]
\nenum
The action query type. \nAllowed enum values: action
default: action
Option 2
\nobject
A data transformer, which is custom JavaScript code that executes and transforms data when its inputs change.
id [required]
\nuuid
The ID of the data transformer.
name [required]
\nstring
A unique identifier for this data transformer. This name is also used to access the transformer's result throughout the app.
properties [required]
\nobject
The properties of the data transformer.
outputs
\nstring
A JavaScript function that returns the transformed data.
type [required]
\nenum
The data transform type. \nAllowed enum values: dataTransform
default: dataTransform
Option 3
\nobject
A variable, which can be set and read by other components in the app.
id [required]
\nuuid
The ID of the state variable.
name [required]
\nstring
A unique identifier for this state variable. This name is also used to access the variable's value throughout the app.
properties [required]
\nobject
The properties of the state variable.
defaultValue
\nThe default value of the state variable.
type [required]
\nenum
The state variable type. \nAllowed enum values: stateVariable
default: stateVariable
rootInstanceName
\nstring
The name of the root component of the app. This must be a grid component that contains all other components.
tags
\n[string]
A list of tags for the app, which can be used to filter apps.
id [required]
\nuuid
The ID of the updated app.
type [required]
\nenum
The app definition type. \nAllowed enum values: appDefinitions
default: appDefinitions
included
\n[object]
Data on the version of the app that was published.
attributes
\nobject
The attributes object containing the version ID of the published app.
app_version_id
\nuuid
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
\nuuid
The deployment ID.
meta
\nobject
Metadata object containing the publication creation information.
created_at
\ndate-time
Timestamp of when the app was published.
user_id
\nint64
The ID of the user who published the app.
user_name
\nstring
The name (or email address) of the user who published the app.
user_uuid
\nuuid
The UUID of the user who published the app.
type
\nenum
The deployment type. \nAllowed enum values: deployment
default: deployment
meta
\nobject
Metadata of an app.
created_at
\ndate-time
Timestamp of when the app was created.
deleted_at
\ndate-time
Timestamp of when the app was deleted.
org_id
\nint64
The Datadog organization ID that owns the app.
updated_at
\ndate-time
Timestamp of when the app was last updated.
updated_since_deployment
\nboolean
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
\nint64
The ID of the user who created the app.
user_name
\nstring
The name (or email address) of the user who created the app.
user_uuid
\nuuid
The UUID of the user who created the app.
version
\nint64
The version number of the app. This starts at 1 and increments with each update.
relationship
\nobject
The app's publication relationship and custom connections.
connections
\n[object]
Array of custom connections used by the app.
attributes
\nobject
The custom connection attributes.
name
\nstring
The name of the custom connection.
onPremRunner
\nobject
Information about the Private Action Runner used by the custom connection, if the custom connection is associated with a Private Action Runner.
id
\nstring
The Private Action Runner ID.
url
\nstring
The URL of the Private Action Runner.
id
\nuuid
The ID of the custom connection.
type
\nenum
The custom connection type. \nAllowed enum values: custom_connections
default: custom_connections
deployment
\nobject
Information pointing to the app's publication status.
data
\nobject
Data object containing the deployment ID.
id
\nuuid
The deployment ID.
type
\nenum
The deployment type. \nAllowed enum values: deployment
default: deployment
meta
\nobject
Metadata object containing the publication creation information.
created_at
\ndate-time
Timestamp of when the app was published.
user_id
\nint64
The ID of the user who published the app.
user_name
\nstring
The name (or email address) of the user who published the app.
user_uuid
\nuuid
The UUID of the user who published the app.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data
\nobject
Data for updating an app's self-service status.
attributes
\nobject
Attributes for updating an app's self-service status.
selfService [required]
\nboolean
Whether the app is enabled for self-service.
type
\nenum
The self-service resource type. \nAllowed enum values: selfService
default: selfService
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data
\nobject
Data for replacing an app's tags.
attributes
\nobject
Attributes for replacing an app's tags.
tags [required]
\n[string]
The full list of tags that should be set on the app. Existing tags not present in this list are removed.
type
\nenum
The tags resource type. \nAllowed enum values: tags
default: tags
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data
\nobject
Data for naming a specific app version.
attributes
\nobject
Attributes for naming a specific app version.
name [required]
\nstring
The name to assign to the app version.
type
\nenum
The version-name resource type. \nAllowed enum values: versionNames
default: versionNames
data
\n[object]
The list of app versions.
attributes
\nobject
Attributes describing an app version.
app_id
\nuuid
The ID of the app this version belongs to.
created_at
\ndate-time
Timestamp of when the version was created.
has_ever_been_published
\nboolean
Whether this version has ever been published.
name
\nstring
The optional human-readable name of the version.
updated_at
\ndate-time
Timestamp of when the version was last updated.
user_id
\nint64
The ID of the user who created the version.
user_name
\nstring
The name (or email) of the user who created the version.
user_uuid
\nuuid
The UUID of the user who created the version.
version
\nint64
The version number of the app, starting at 1.
id
\nuuid
The ID of the app version.
type
\nenum
The app-version resource type. \nAllowed enum values: appVersions
default: appVersions
meta
\nobject
Pagination metadata.
page
\nobject
Information on the total number of apps, to be used for pagination.
totalCount
\nint64
The total number of apps under the Datadog organization, disregarding any filters applied.
totalFilteredCount
\nint64
The total number of apps that match the specified filters.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.