Metadata

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

GEThttps://cloud-api.calyptia.com/v1/pipelines/{pipelineID}/metadata

Authorization

userproject

Path parameters

pipelineID*string (uuid)

Query parameters

Response

200

OK

Body

application/json

Other propertiesany

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.calyptia.com/v1/pipelines/{pipelineID}/metadata', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

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.

PATCHhttps://cloud-api.calyptia.com/v1/pipelines/{pipelineID}/metadata

Authorization

userproject

Path parameters

pipelineID*string (uuid)

Body

application/json

keystring

metadata key to use

valueobject

json object to use as value

Example: "{\"value\": \"1\"}\n"

Response

204

No Content

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.calyptia.com/v1/pipelines/{pipelineID}/metadata', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();