Metadata

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

get

Get the metadata associated to a pipeline

Authorizations
Path parameters
pipelineIDstring · uuidRequired
Query parameters
keystring[]Optional

List of metadata keys to retrieve.

Responses
200
OK
application/json
get
GET /v1/pipelines/{pipelineID}/metadata HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

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

patch

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

Authorizations
Path parameters
pipelineIDstring · uuidRequired
Body
keystringOptional

metadata key to use

Responses
204
No Content
patch
PATCH /v1/pipelines/{pipelineID}/metadata HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "key": "text",
  "value": "{\"value\": \"1\"}\n"
}
204

No Content

No content