• Home
  • Dynatrace API
  • Environment
  • Hub items
  • GET items

Hub capabilities API - GET items

Lists all available Hub items.

The request produces an application/json payload.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/hub/items
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/hub/items
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/hub/items

Authentication

To execute this request, you need an access token with hub.read scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
nextPageKeystring

The cursor for the next page of results. You can find it in the nextPageKey field of the previous response.

The first page is always returned if you don't specify the nextPageKey query parameter.

When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.

queryoptional
pageSizeinteger

The amount of hub items in a single response payload.

The maximal allowed page size is 100.

If not set, 20 is used.

queryoptional
itemTypestring

If provided will filter out the results based on item type.

The element can hold these values
  • EXTENSION1
  • EXTENSION2
  • ITEM
  • TECHNOLOGY
queryoptional
querystring

Filter the results for items matching the query string within id, name, author, description or any tag.

  • Case insensitive
  • Checks if text is contained in any of the text fields:
    • id, name, author, description, tags
queryoptional
installedboolean

If provided 'true' will look for items that are installed in your environment

queryoptional
distributedboolean

If provided 'true' will filter for items that are distributed by Dynatrace If provided 'false' will filter for items that are self uploaded and not distributed by Dynatrace

queryoptional
categoryIdstring

If provided, will filter items that belong to the category. For list of category ids refer to /categories

  • Will return the items in the order of the category
queryoptional
offsetstring

If provided, will skip the desired number of results, allowing for pagination in combination with page size

queryoptional

Response

Response codes

CodeTypeDescription
200ItemList

OK

503ErrorEnvelope

Unavailable

Response body objects

The ItemList object

ElementTypeDescription
itemsItemOverview[]

A list of available items.

totalCountinteger

The total number of entries in the result.

pageSizeinteger

The number of entries per page.

nextPageKeystring

The cursor for the next page of results. Has the value of null on the last page.

Use it in the nextPageKey query parameter to obtain subsequent pages of the result.

The ItemOverview object

Overview of an item.

ElementTypeDescription
typestring

Represents the type of item. It can be TECHNOLOGY, EXTENSION1 or EXTENSION2.

The element can hold these values
  • EXTENSION1
  • EXTENSION2
  • TECHNOLOGY
itemIdstring

Unique Id of the item.

namestring

Name of the item.

descriptionstring

Description of the item.

tagsstring[]

Grouping of items with keywords.

authorNamestring

Name of the author of the item.

authorLogostring

Url for the author's logo.

notCompatibleReasonstring

The reason why the item is not compatible with the cluster version.

documentationLinkstring

An absolute link to the documentation page of this item.

marketingLinkstring

An absolute link to the marketing page of this item.

hasDescriptionBlocksboolean

Whether or not the details call will contain description blocks.

comingSoonboolean

Whether or not the item is planned to be released soon

artifactIdstring

The unique ID used by the artifacts contained in releases.

logostring

The logo of the item. Can be a URL or Base64 encoded. Intended for html tags

clusterCompatibleboolean-

Response body JSON model

json
{ "items": [ { "type": "EXTENSION1", "itemId": "string", "name": "string", "description": "string", "tags": [ "string" ], "authorName": "string", "authorLogo": "string", "notCompatibleReason": "string", "documentationLink": "string", "marketingLink": "string", "hasDescriptionBlocks": true, "comingSoon": true, "artifactId": "snmp-extension.dynatrace.com", "logo": "string", "clusterCompatible": true } ], "totalCount": 1, "pageSize": 1, "nextPageKey": "AQAAABQBAAAABQ==" }