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 API requires a registered application key. Alternatively, you can configure these permissions in the UI.
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.
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.
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<API-KEY>"DD_APP_KEY="<APP-KEY>"cargo run
/**
* List Apps returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv2.AppBuilderApi(configuration);apiInstance.listApps().then((data: v2.ListAppsResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));