neosourceDocs
Search docs

Set (create or replace) a workspace CI secret

PUT/api/workspaces/{workspace_id}/ci/secrets/{name}

setCiSecret

Requires authentication using a bearer token — see tokens and scopes.

curl

curl -X PUT 'https://neosource.dev/api/workspaces/WORKSPACE_ID/ci/secrets/NAME' \
  -H 'Authorization: Bearer $NEOSOURCE_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"value":"string"}'

fetch

fetch("https://neosource.dev/api/workspaces/WORKSPACE_ID/ci/secrets/NAME", {
  method: "PUT",
  headers: {
    Authorization: "Bearer $NEOSOURCE_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"value":"string"}),
});

Path parameters

workspace_idrequired

string

namerequired

Env-var-style secret name (`[A-Z_][A-Z0-9_]*`).

string

Request bodyrequired

application/json

SetCiSecretRequest

object

Set (create or replace) a workspace CI secret. The value is encrypted at rest and never echoed back by any read endpoint.

valuerequired

string

Plaintext secret value. Stored encrypted; only its name is ever listed afterwards.

Responses

204Secret stored

403Forbidden — one of: forbidden, needs_scope

application/json

one of
  • ErrorForbidden

  • NeedsScopeError

    object

    `403` body returned when listing private repos but the linked identity lacks the required provider scope. The SPA turns this into an incremental-authorization prompt (Tier 2) that calls the `/elevate` OAuth endpoint with this `scope`.

    errorrequired

    string

    Always `needs_scope` — this body exists to carry the extra fields that kind needs.

    "needs_scope"

    scoperequired

    string

    The provider scope to request via elevation (e.g. `"repo"`).

Standard errors

Bodies documented once for the whole API — see standard errors.

  • 400Bad Request — one of: invalid_input
  • 401Authentication required
  • 404Not Found — one of: not_found
  • 409Conflict — one of: already_exists, conflict
  • 429Rate limited — retry after the `Retry-After` header
  • 500Internal server error
  • 503Service temporarily unavailable / at capacity — retry after the `Retry-After` header
  • 504Gateway timeout — the request exceeded the server's handling budget