Skip to main content

Hub

Overview

The Hub API provides catalog content, such as Dynatrace Apps, Extensions, and Technologies, in the context of the current environment.

npm install @dynatrace-sdk/client-hub

appsClient

import { appsClient } from "@dynatrace-sdk/client-hub";

getAppDetails

appsClient.getAppDetails(config): Promise<Detail>

Provides detailed information about an app

Required scope: hub:catalog:read

Parameters

NameTypeDescription
config.addFieldsArray<OptionalAppDetailField>A list of fields that are added to the default set of fields.
config.id*requiredstring

Returns

Detailed information about an app

Code example
import { appsClient } from "@dynatrace-sdk/client-hub";

const data = await appsClient.getAppDetails({ id: "..." });

getAppOverviewList

appsClient.getAppOverviewList(config): Promise<OverviewsList>

List overview information of all apps

Required scope: hub:catalog:read

Parameters

NameTypeDescription
config.addFieldsArray<OptionalAppOverviewField>A list of fields that are added to the default set of fields.
config.onlyCompatiblebooleanFilters apps and their releases to exclude incompatible instances. If true or missing the resulting releases will have compatibility of COMPATIBLE or UNKNOWN.

Returns

A list of overview information

Code example
import { appsClient } from "@dynatrace-sdk/client-hub";

const data = await appsClient.getAppOverviewList();

getAppReleases

appsClient.getAppReleases(config): Promise<ReleasesList>

Provides a list of releases published for an app, including revoked releases

Required scope: hub:catalog:read

Parameters

NameType
config.addFieldsArray<Manifest>
config.id*requiredstring

Returns

A list of releases

Code example
import { appsClient } from "@dynatrace-sdk/client-hub";

const data = await appsClient.getAppReleases({ id: "..." });

categoriesClient

import { categoriesClient } from "@dynatrace-sdk/client-hub";

getCategories

categoriesClient.getCategories(abortSignal?): Promise<Categories>

List Hub categories, including the IDs of the associated items and their content blocks if any

Required scope: hub:catalog:read

{/ no parameters /}

Returns

The categories

Code example
import { categoriesClient } from "@dynatrace-sdk/client-hub";

const data = await categoriesClient.getCategories();

extensionsClient

import { extensionsClient } from "@dynatrace-sdk/client-hub";

getExtensionDetails

extensionsClient.getExtensionDetails(config): Promise<Detail>

Provides detailed information about an extension

Required scope: hub:catalog:read

Parameters

NameTypeDescription
config.addFieldsArray<OptionalExtensionDetailField>A list of fields that are added to the default set of fields.
config.id*requiredstring

Returns

Detailed information about an extension

Code example
import { extensionsClient } from "@dynatrace-sdk/client-hub";

const data = await extensionsClient.getExtensionDetails({
id: "...",
});

getExtensionOverviewList

extensionsClient.getExtensionOverviewList(config): Promise<OverviewsList>

List overview information of all extensions

Required scope: hub:catalog:read

Parameters

NameTypeDescription
config.addFieldsArray<HubItemId>A list of fields that are added to the default set of fields.
config.onlyCompatiblebooleanA flag to reduce the list to only include compatible extensions with their latest compatible version.

Returns

A list of overview information

Code example
import { extensionsClient } from "@dynatrace-sdk/client-hub";

const data = await extensionsClient.getExtensionOverviewList();

getExtensionReleases

extensionsClient.getExtensionReleases(config): Promise<ReleasesList>

Provides a list of releases published for an extension, including revoked releases

Required scope: hub:catalog:read

Parameters

NameTypeDescription
config.addFieldsArray<ExtensionMetadata>A list of fields that are added to the default set of fields.
config.id*requiredstring

Returns

A list of releases

Code example
import { extensionsClient } from "@dynatrace-sdk/client-hub";

const data = await extensionsClient.getExtensionReleases({
id: "...",
});

technologiesClient

import { technologiesClient } from "@dynatrace-sdk/client-hub";

getTechnologyDetails

technologiesClient.getTechnologyDetails(config): Promise<Detail>

Provides detailed information about a technology

Required scope: hub:catalog:read

Parameters

NameTypeDescription
config.addFieldsArray<HubItemId>A list of fields that are added to the default set of fields.
config.id*requiredstring

Returns

Detailed information about a technology

Code example
import { technologiesClient } from "@dynatrace-sdk/client-hub";

const data = await technologiesClient.getTechnologyDetails({
id: "...",
});

getTechnologyOverviewList

technologiesClient.getTechnologyOverviewList(config): Promise<OverviewsList>

List overview information of all technologies

Required scope: hub:catalog:read

Parameters

NameTypeDescription
config.addFieldsArray<HubItemId>A list of fields that are added to the default set of fields.
config.onlyCompatiblebooleanA flag to reduce the list to only include compatible technologies.

Returns

A list of overview information

Code example
import { technologiesClient } from "@dynatrace-sdk/client-hub";

const data = await technologiesClient.getTechnologyOverviewList();

Types

Categories

NameType
categories*requiredArray<Category>

Category

An item category in the Hub

NameTypeDescription
id*requiredstringThe category's ID
itemIds*requiredArray<string>The IDs of the items associated with this category
page*requiredCategoryPage
subgroup*requiredstringGroups categories to related subpages

CategoryPage

NameTypeDescription
content*requiredArray<CategoryPageContent>
description*requiredstringThe customer facing description of this page
shortTitle*requiredstringA shorter version of the customer facing title of the page
title*requiredstringThe customer facing title of the page

CategoryPageContent

NameTypeDescription
blocksArray<CategoryPageContentBlock>The blocks of the items associated with this category
contentType*requiredstringThe type of content
description*requiredstringThe customer facing description of the content
itemIdsArray<string>The IDs of the items associated with this category
title*requiredstringThe customer facing title of the content

CategoryPageContentBlock

NameTypeDefault
descriptionstring""
href*requiredstring
hrefTextstring
image*requiredstring
title*requiredstring

ConstraintViolation

Contains information about a constraint violation caused by invalid input.

NameTypeDescription
message*requiredstringThe constraint violation description message
pathstringThe path of the parameter that caused the constraint violation

Dependency

NameTypeDescription
name*requiredstringThe name of the required dependency
version*requiredstringSemVer2 version of the required dependency

Detail

Meta data of the latest version of this item.

NameTypeDescription
comingSoon*requiredboolean
currentReleaseRelease
description*requiredstring
detailSections*requiredArray<DetailSection>
hasDetailSection*requiredbooleanWhether the details of this item contain one or more detail content sections.
hubItemIdstringThe Hub item id, aka. slug.
iconstring
id*requiredstringThe id is only unique within a specific type.
keywords*requiredArray<string>
linksArray<Link>
name*requiredstring
relatedItemsArray<Overview>
resourceContextResourceContext
type*requiredItemType
versionstringThe latest version of this item.

DetailSection

Can be either a Markdown or Gallery section. Only one of the respective properties is returned (markdown, or gallery).

NameType
galleryGallerySection
markdownMarkdownSection
sourceId*requiredstring

Error

Standard error response

NameTypeDescription
code*requirednumberThe error code (HTTP response)
detailsErrorDetails
message*requiredstringThe error code (HTTP response)

ErrorDetails

Optional details of the error

NameTypeDescription
constraintViolationsArray<ConstraintViolation>A list of constraint violations of input parameters (path, query, request body)

ErrorEnvelope

NameType
error*requiredError

ExtensionMetadata

NameType
extensionContentsArray<Record<string | any>>
featureSetsArray<string>
featureSetsDetailsExtensionMetadataFeatureSetsDetails

ExtensionMetadataFeatureSetsDetails

GalleryImage

NameTypeDescription
altstringDescriptive text of what the image expresses
captionstring
src*requiredstring
titlestring

GallerySection

NameType
images*requiredArray<GalleryImage>
title*requiredstring
NameType
appIdstring
pageTokenstring
targetstring
type*requiredLinkType

Manifest

NameType
actionsRecord<string | any>
cspRecord<string | any>
dependenciesArray<Dependency>
intentsRecord<string | any>
pageTokensRecord<string | any>
scopesRecord<string | any>

MarkdownSection

NameType
markdown*requiredstring
title*requiredstring

Overview

Meta data of the latest version of this item.

NameTypeDescription
comingSoon*requiredboolean
description*requiredstring
hasDetailSection*requiredbooleanWhether the details of this item contain one or more detail content sections.
hubItemIdstringThe Hub item id, aka. slug.
iconstring
id*requiredstringThe id is only unique within a specific type.
keywords*requiredArray<string>
linksArray<Link>
name*requiredstring
resourceContextResourceContext
type*requiredItemType
versionstringThe latest version of this item.

OverviewsList

A list of item meta data. Per default contains only compatible items, but can be controlled using the onlyCompatible flag.

NameType
items*requiredArray<Overview>

Release

NameTypeDescription
compatible*requiredCompatibility
downloadUrlstringThe absolute URL which can be used to fetch the artifact, only included for Extension 1.0.
extensionMetadataExtensionMetadata
manifestManifest
publicationTime*requiredDate
releaseNotesstringMarkdown content describing this release.
revocationRevocation
version*requiredstringA semantic versioning 2.0 conform version.

ReleasesList

NameType
releases*requiredArray<Release>

ResourceContext

NameType
operationsArray<Install>

Revocation

The existence of this object marks a release as being revoked. It contains information on why this is the case.

NameType
descriptionstring
reason*requiredRevocationReason
severityRevocationSeverity

Enums

Compatibility

Enum keys

Compatible | Incompatible | Unknown

ItemType

Enum keys

App | ClassicApp | Extension_1 | Extension_2 | Technology

LinkType

Links can be of the following types:

  • DOCUMENTATION - Technical documentation
  • MARKETING - Promotion material
  • ACTIVATION - Location within the product to configure the item

Enum keys

Activation | Documentation | Marketing

OptionalAppDetailField

Enum keys

HubItemId | Manifest | ResourceContext

OptionalAppOverviewField

Enum keys

HubItemId | ResourceContext

OptionalAppReleaseField

Enum keys

Manifest

OptionalExtensionDetailField

Enum keys

ExtensionMetadata | HubItemId

OptionalExtensionReleaseField

Enum keys

ExtensionMetadata

OptionalOverviewField

Enum keys

HubItemId

OptionalTechnologyDetailField

Enum keys

HubItemId

ResourceContextOperationsItem

Enum keys

Install

RevocationReason

Enum keys

Deprecated | FaultyRelease | SecurityIssue

RevocationSeverity

Enum keys

High | Low | Medium

Still have questions?
Find answers in the Dynatrace Community