Metadata API reference

Dapr has a metadata API that returns information about the sidecar allowing runtime discoverability. The metadata endpoint returns among other things, a list of the components loaded and the activated actors (if present).

The Dapr metadata API also allows you to store additional information in the format of key-value pairs.

Note: The Dapr metatada endpoint is for instance being used by the Dapr CLI when running dapr in standalone mode to store the PID of the process hosting the sidecar and the command used to run the application.

Gets the Dapr sidecar information provided by the Metadata Endpoint.

URL Parameters

HTTP Response Codes

Code	Description
200	Metadata information returned
500	Dapr could not return the metadata information

Metadata API Response Registered Actor

Name	Type	Description
type	string	The registered actor type.
count	integer	Number of actors running.

Metadata API Response Component

Examples

Note: This example is based on the Actor sample provided in the .

Add a custom attribute to the Dapr sidecar information

Adds a custom attribute to the Dapr sidecar information stored by the Metadata Endpoint.

HTTP Request

Parameter	Description
daprPort	The Dapr port.
attributeName	Custom attribute name. This is they key name in the key-value pair.

HTTP Request Body

Within the body of the request place the custom attribute value you want to store:

attributeValue

HTTP Response Codes

Note: This example is based on the Actor sample provided in the Dapr SDK for Python.

Add a custom attribute to the metadata endpoint:

Get the metadata information to confirm your custom attribute was added:

{
    "id":"demo-actor",
    "actors":[
        {
            "type":"DemoActor",
            "count":1
    ],
    "extended": {
        "myDemoAttribute": "myDemoAttributeValue",
        "cliPID":"1031040",
        "appCommand":"uvicorn --port 3000 demo_actor_service:app"
    "components":[
        {
            "type":"pubsub.redis",
            "version":""
        },
        {
            "name":"statestore",
            "type":"state.redis",
            "version":""
        }
}