Try it free

Hub capabilities API - PUT an extension 2.0 metadata

  • Reference
  • Published Feb 07, 2023

Updates the metadata of an extension 2.0 that doesn't have Dynatrace-defined metadata. Any existing metadata is overwritten.

The request consumes a multipart/form-data payload.

PUTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/hub/extensions2/{extensionName}/metadata
PUTEnvironment and Cluster ActiveGate (default port 9999)https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/hub/extensions2/{extensionName}/metadata

Authentication

Api-Token:

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

One of the following permissions is required for personal access tokens:

  • environment:roles:viewer

To learn how to obtain and use it, see Personal access tokens.

Parameters

ParameterTypeDescriptionInRequired
extensionNamestring

Fully qualified name of the extension

pathRequired
bodyobject-bodyOptional

Request body objects

The RequestBody object

ElementTypeDescriptionRequired
descriptionstring-Optional
logostring

Logo of the extension

Optional
namestring

If left empty or blank, the extension name will be used as name

Optional

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

{
  "description": "string",
  "logo": "string",
  "name": "string"
}

Response

Response codes

CodeTypeDescription
204-

Extension metadata uploaded

4XXErrorEnvelope

Client side error.

5XXErrorEnvelope

Server side error.

Response body objects

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

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