Pipeline secrets

Pipeline secret

Secret by ID.

GEThttps://cloud-api.calyptia.com/v1/pipeline_secrets/{secretID}

Authorization

userproject

Path parameters

secretID*string (uuid)

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

JavaScriptCurl

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-07-27T03:16:16.757Z",
  "updatedAt": "2024-07-27T03:16:16.757Z"
}

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

userproject

Path parameters

secretID*string (uuid)

Response

204

No Content

Request

JavaScriptCurl

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

userproject

Path parameters

secretID*string (uuid)

Body

application/json

keynullable string

Example: "newsecret"

valuenullable string (byte)

Response

204

No Content

Request

JavaScriptCurl

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();