Metadata

PreviousCluster objects NextTrace sessions

Get the metadata associated to a pipeline, keys can be provided or the full metadata will be returned (if none).

Get the metadata associated to a pipeline

get

/v1/pipelines/{pipelineID}/metadata

Authorizations

Path parameters

pipelineIDstring · uuidrequired

Query parameters

keystring[]

List of metadata keys to retrieve.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://cloud-api.calyptia.com/v1/pipelines/{pipelineID}/metadata' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Updates or creates a new metadata key on the pipeline's metadata

Updates a pipeline metadata item by setting the key to a given json object value.

patch

/v1/pipelines/{pipelineID}/metadata

Authorizations

Path parameters

pipelineIDstring · uuidrequired

Body

keystring

metadata key to use

valueobject

json object to use as value

Example: {"value": "1"}