• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • Schema with custom-defined key property

Settings API - Schema with custom defined key property schema table

Schema with custom defined key property (builtin:example.key-property-schema)

Showcase of a usage of custom defined key property.

Schema IDSchema groupsScope
builtin:example.key-property-schema
  • group:example
HOST - Host
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:example.key-property-schema
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:example.key-property-schema
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:example.key-property-schema

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

PropertyLabelTypeDescriptionRequired
keyPropertyNametext

A unique name used as a key.

required
standardPropertyFreetexttext

A non-key property

optional