Skip to main content

Read all metadata from an entity

Reads all associated metadata from an entity.
Available entities are: organization, account, namespace, application, build, asset, scope, release, deployment.
Check already defined metadata specification for available metadata keys.

Path Parameters
entity string REQUIRED

Possible values: Value must match regular expression ^[a-z]+(_[a-z]+)*$, [organization, account, namespace, application, build, asset, scope, release, deployment]

Entity name that holds metadata information

id string REQUIRED

Possible values: 1 ≤ length, Value must match regular expression ^[0-9]+$

Entity ID that holds metadata information

Query Parameters
include string

Possible values: 1 ≤ length

Add additional metadata information to the response. For example: schemas, tags

Responses
2XX

Object representing nullplatform entity metadata

Schema OPTIONAL
additional_properties object
entity string

Possible values: Value must match regular expression ^[a-z]+(_[a-z]+)*$, [organization, account, namespace, application, build, asset, scope, release, deployment]

Entity name that holds metadata information

id string

Possible values: 1 ≤ length, Value must match regular expression ^[0-9]+$

Entity ID that holds metadata information

nrn NRN

Possible values: Value must match regular expression ^organization=(\d+|\*)+(?::account=(\d+|\*))?(?::namespace=(\d+|\*))?(?::application=(\d+|\*))?(?::(build|scope|release)=(\d+|\*))?$

Nullplatform Resource Name (NRN) representing a hierarchical identifier for nullplatform resources

schemas object OPTIONAL

References the metadata schemas against which the existing data was validated

tags object[] OPTIONAL

An array of exposed metadata attributes as tags, each containing a key and a value

key string

The key of the tag

value string

The value of the tag

4XX

Format for representing errors during API interactions

Schema OPTIONAL
statusCode number

HTTP status code indicating the error

code string OPTIONAL

Unique error code for reference and categorization

error string

Short, human-readable error type or category

message string

Detailed error message providing additional context

5XX

Format for representing errors during API interactions

Schema OPTIONAL
statusCode number

HTTP status code indicating the error

code string OPTIONAL

Unique error code for reference and categorization

error string

Short, human-readable error type or category

message string

Detailed error message providing additional context