Pipeline secrets

Pipeline secret

Secret by ID.

GEThttps://cloud-api.calyptia.com/v1/pipeline_secrets/{secretID}
Authorization
Path parameters
secretID*string (uuid)
Response

OK

Body
id*string (uuid)
key*string
Example: "mysecret"
value*string (byte)
createdAt*string (date-time)
updatedAt*string (date-time)
Request
const response = await fetch('https://cloud-api.calyptia.com/v1/pipeline_secrets/{secretID}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();
Response
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "key": "mysecret",
  "value": "Ynl0ZXM=",
  "createdAt": "2024-12-22T04:59:55.490Z",
  "updatedAt": "2024-12-22T04:59:55.490Z"
}

Delete pipeline secret

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.

DELETEhttps://cloud-api.calyptia.com/v1/pipeline_secrets/{secretID}
Authorization
Path parameters
secretID*string (uuid)
Response

No Content

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

Update pipeline secret

Update secret by its ID.

PATCHhttps://cloud-api.calyptia.com/v1/pipeline_secrets/{secretID}
Authorization
Path parameters
secretID*string (uuid)
Body
keynullable string
Example: "newsecret"
valuenullable string (byte)
Response

No Content

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