Pipeline secrets

PreviousIngest checks NextPipeline ports

Pipeline secret

get

Secret by ID.

Authorizations

Path parameters

secretIDstring · uuidRequired

Responses

200

application/json

get

GET /v1/pipeline_secrets/{secretID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "key": "mysecret",
  "value": "Ynl0ZXM=",
  "createdAt": "2025-05-09T07:54:42.132Z",
  "updatedAt": "2025-05-09T07:54:42.132Z"
}

Delete pipeline secret

delete

Delete pipeline secret by its ID. The secret cannot be deleted if some pipeline config is still referencing it; you must delete the pipeline first if you want to delete the secret.

Authorizations

Path parameters

secretIDstring · uuidRequired

Responses

204

No Content

delete

DELETE /v1/pipeline_secrets/{secretID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content

Update pipeline secret

patch

Update secret by its ID.

Authorizations

Path parameters

secretIDstring · uuidRequired

Body

Update pipeline secret request body.

keystring | nullableOptionalDefault: nullExample: newsecret

valuestring · byte | nullableOptionalDefault: null

Responses

204

No Content

patch

PATCH /v1/pipeline_secrets/{secretID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "key": "newsecret",
  "value": "Ynl0ZXM="
}

204

No Content

No content