Hub capabilities API - GET items
Lists all available Hub items.
The request produces an application/json
payload.
GET | ManagedDynatrace for Government | https://{your-domain}/e/{your-environment-id}/api/v2/hub/items |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/hub/items | |
Environment ActiveGate | https://{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
Parameter | Type | Description | In | Required |
---|---|---|---|---|
nextPageKey | string | 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. | query | optional |
pageSize | integer | The amount of hub items in a single response payload. The maximal allowed page size is 100. If not set, 20 is used. | query | optional |
itemType | string | If provided will filter out the results based on item type. | query | optional |
query | string | Filter the results for items matching the query string within id, name, author, description or any tag.
| query | optional |
installed | boolean | If provided 'true' will look for items that are installed in your environment | query | optional |
distributed | boolean | 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 | query | optional |
categoryId | string | If provided, will filter items that belong to the category. For list of category ids refer to /categories
| query | optional |
offset | string | If provided, will skip the desired number of results, allowing for pagination in combination with page size | query | optional |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | Item | OK |
503 | ErrorEnvelope | Unavailable |
Response body objects
The ItemList
object
Element | Type | Description |
---|---|---|
items | Item | A list of available items. |
totalCount | integer | The total number of entries in the result. |
pageSize | integer | The number of entries per page. |
nextPageKey | string | The cursor for the next page of results. Has the value of Use it in the nextPageKey query parameter to obtain subsequent pages of the result. |
The ItemOverview
object
Overview of an item.
Response body JSON model
{
"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=="
}