POST/secrets

Create secret metadata

Registers the name of a credential secret held in the worker environment; no credential value is accepted.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Request body

application/jsonrequired

project_idrequired

namestringrequired

descriptionstringoptional

service_typerequired

Values: "s3" · "ftp" · "sftp" · "smb" · "archive_password" · "age_identity" · "age_passphrase"

local_secret_namestringrequired

Name of the Kubernetes Secret in the worker environment.

Responses

201application/json

Secret metadata created.

{
  "status": "success",
  "data": {
    "id": "65f0c7a9a7d6b4e2c1234567"
  }
}

400application/json

The request body, parameter, filter, cursor, or project-scoping pattern is invalid.

{
  "status": "error",
  "message": "string",
  "code": "string",
  "detail": {},
  "quota": {
    "key": "string",
    "limit": 1,
    "used": 1
  },
  "feature": "string",
  "dependency": "string"
}

statusstringrequired

messagestringrequired

codestringoptional

Stable machine-readable code when the error defines one.

detailobjectoptional

quotaoptional

featurestringoptional

dependencystringoptional

401application/json

Authentication is missing or the credential is invalid, inactive, expired, or lacks the required scope.

{
  "status": "error",
  "message": "string",
  "code": "string",
  "detail": {},
  "quota": {
    "key": "string",
    "limit": 1,
    "used": 1
  },
  "feature": "string",
  "dependency": "string"
}

statusstringrequired

messagestringrequired

codestringoptional

Stable machine-readable code when the error defines one.

detailobjectoptional

quotaoptional

featurestringoptional

dependencystringoptional

403application/json

The authenticated caller is not allowed to perform this operation.

{
  "status": "error",
  "message": "string",
  "code": "string",
  "detail": {},
  "quota": {
    "key": "string",
    "limit": 1,
    "used": 1
  },
  "feature": "string",
  "dependency": "string"
}

statusstringrequired

messagestringrequired

codestringoptional

Stable machine-readable code when the error defines one.

detailobjectoptional

quotaoptional

featurestringoptional

dependencystringoptional

409application/json

The requested change conflicts with the resource's current state or dependencies.

{
  "status": "error",
  "message": "string",
  "code": "string",
  "detail": {},
  "quota": {
    "key": "string",
    "limit": 1,
    "used": 1
  },
  "feature": "string",
  "dependency": "string"
}

statusstringrequired

messagestringrequired

codestringoptional

Stable machine-readable code when the error defines one.

detailobjectoptional

quotaoptional

featurestringoptional

dependencystringoptional