Pipeline secrets

Pipeline secret

get

Secret by ID.

Authorizations

userproject

Path parameters

secretIDstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "key": "mysecret",
  "value": "text",
  "createdAt": "2025-03-20T10:38:11.169Z",
  "updatedAt": "2025-03-20T10:38:11.169Z"
}

OK

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

userproject

Path parameters

secretIDstring · uuidrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://cloud-api.calyptia.com/v1/pipeline_secrets/{secretID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

204

No body

No Content

Update pipeline secret

patch

Update secret by its ID.

Authorizations

userproject

Path parameters

secretIDstring · uuidrequired

Body

keystring | nullable

Example: newsecret

valuestring · byte | nullable

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://cloud-api.calyptia.com/v1/pipeline_secrets/{secretID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "key": "newsecret",
    "value": null
  }'

204

204

No body

No Content