Secrets

Pipeline secrets

Secrets from a pipeline.

GEThttps://cloud-api.calyptia.com/v1/aggregator_pipelines/{pipelineID}/secrets

Authorization

userproject

Path parameters

pipelineID*string (uuid)

Query parameters

Response

200

OK

Body

application/json

id*string (uuid)

key*string

Example: "mysecret"

value*string (byte)

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

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

Response

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "key": "mysecret",
    "value": "Ynl0ZXM=",
    "createdAt": "2024-10-16T08:56:24.231Z",
    "updatedAt": "2024-10-16T08:56:24.231Z"
  }
]

Create pipeline secret

Create secret within a pipeline. The given name is unique within the pipeline. These secrets can be referenced by their name within a fluentbit configuration file like so {{secrets.thename}}. Use them to hide sensible values from your config file.

POSThttps://cloud-api.calyptia.com/v1/aggregator_pipelines/{pipelineID}/secrets

Authorization

userproject

Path parameters

pipelineID*string (uuid)

Body

application/json

key*string

Example: "newsecret"

value*string (byte)

Response

201

Created

Body

application/json

id*string (uuid)

createdAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.calyptia.com/v1/aggregator_pipelines/{pipelineID}/secrets', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "key": "newsecret",
      "value": "Ynl0ZXM="
    }),
});
const data = await response.json();

Response

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2024-10-16T08:56:24.231Z"
}