Hub capabilities API - POST update an extension 2.0

  • Reference
  • Published Feb 07, 2023

Updates an extension 2.0 to the specified version. If no version is specified, the recommended version is used.

The request produces an application/json payload.

POSTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/hub/extensions2/{extensionName}/actions/update
Environment and Cluster ActiveGate (default port 9999)https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/hub/extensions2/{extensionName}/actions/update

Authentication

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

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

Parameters

ParameterTypeDescriptionInRequired
extensionNamestring

Fully qualified name of the extension

pathRequired
extensionVersionstring

Version of the extension. Fallback to the evaluated recommended version when the version is not provided

queryOptional

Response

Response codes

CodeTypeDescription
200RegisteredExtensionResultDto

OK

400ErrorEnvelope

Bad request

404ErrorEnvelope

Not found

503ErrorEnvelope

Unavailable

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

The RegisteredExtensionResultDto object

ElementTypeDescription
extensionNamestring

FQN of the extension registered in the tenant.

extensionVersionstring

Version number of the extension.

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
codeinteger

The HTTP status code

constraintViolationsConstraintViolation[]

A list of constraint violations

messagestring

The error message

The ConstraintViolation object

A list of constraint violations

ElementTypeDescription
locationstring-
messagestring-
parameterLocationstring-
The element can hold these values
  • HEADER
  • PATH
  • PAYLOAD_BODY
  • QUERY
pathstring-

Response body JSON models

{
"extensionName": "string",
"extensionVersion": "string"
}
{
"error": {
"code": 1,
"constraintViolations": [
{
"location": "string",
"message": "string",
"parameterLocation": "HEADER",
"path": "string"
}
],
"message": "string"
}
}