Team / Secrets /

Patch global secret

Updates a global secret with the specified payload

Path parameters

secretId
string required
ID of the secret

Query parameters

runDependents
boolean
On update, whether to run the global secret’s configured dependent templates (when enabled). Defaults to false.
idempotencyKey
string
Deduplicates dependent template runs when the same update is retried.

Request body

{object}

description
string
max length
200
pattern
^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$
secrets
{object}

values
{object}

files
{object}

gitops
{object}

vcsService
string required
The VCS provider to use.
one of
bitbucket, gitlab, github, self-hosted, azure, origin
selfHostedVcsId
string
If projectType is self-hosted, the ID of the self-hosted vcs to use.
pattern
^([A-Za-z0-9-]+)|([0-9a-f]{24})$
accountLogin
string
By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name.
vcsLinkId
string
Legacy key. Please used accountLogin instead.
repoUrl
string required
URL of the Git repo to sync the file with.
pattern
^(https:\/\/)?((www(\.[a-zA-Z0-9-]{2,})+\.)?[a-zA-Z0-9-]{2,})(\.([a-zA-Z0-9-]{2,}))+(\/([a-zA-Z0-9\-._]{2,}))+?$
branch
string required
The name of the branch to use.
filePath
string required
The file path in the repository. If using an existing file, it should be in JSON format.
pattern
^\/((?!\.\.?\/)[a-zA-Z0-9-._]+\/)*(?!\.\.?$)[a-zA-Z0-9-._]+$

dependents
{object}

templates
{object}

items
[array]
Templates to run, referenced by internalId.

string
min length
3
max length
100
pattern
^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$

Response body

{object}
Response object.

data
{object} required
Result data.

name
string required
min length
3
max length
100
pattern
^[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*$
description
string
max length
200
pattern
^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$
secrets
{object}

values
{object} required

files
{object}

type
string required
The permission type of the global secret.
one of
secret, config
gitops
{object}

vcsService
string required
The VCS provider to use.
one of
bitbucket, gitlab, github, self-hosted, azure, origin
selfHostedVcsId
string
If projectType is self-hosted, the ID of the self-hosted vcs to use.
pattern
^([A-Za-z0-9-]+)|([0-9a-f]{24})$
accountLogin
string
By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name.
vcsLinkId
string
Legacy key. Please used accountLogin instead.
repoUrl
string required
URL of the Git repo to sync the file with.
pattern
^(https:\/\/)?((www(\.[a-zA-Z0-9-]{2,})+\.)?[a-zA-Z0-9-]{2,})(\.([a-zA-Z0-9-]{2,}))+(\/([a-zA-Z0-9\-._]{2,}))+?$
branch
string required
The name of the branch to use.
filePath
string required
The file path in the repository. If using an existing file, it should be in JSON format.
pattern
^\/((?!\.\.?\/)[a-zA-Z0-9-._]+\/)*(?!\.\.?$)[a-zA-Z0-9-._]+$

dependents
{object}

templates
{object}

items
[array]
Templates to run, referenced by internalId.

string
min length
3
max length
100
pattern
^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$

createdAt
string
time of creation
updatedAt
string
time of update
triggerResult
{object}

batchId
string required
max length
128
accepted
integer required
succeeded
integer required
failed
integer required
skipped
integer required
deduplicated
integer required
items
[array] required

{object}

templateInternalId
string required
min length
3
max length
100
pattern
^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$
status
string required
one of
succeeded, failed, skipped, deduplicated
templateRunId
string

API

CLI

JS Client

PATCH /v1/secrets/{secretId}

PATCH /v1/teams/{teamId}/secrets/{secretId}

Example request

Request body

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request PATCH \
  --data '{"gitops":{"vcsService":"github","accountLogin":"github-user","repoUrl":"https://github.com/northflank-examples/remix-postgres-redis-demo","branch":"main","filePath":"/Dockerfile"}}' \
  https://api.northflank.com/v1/secrets/{secretId}

Example response

200 OK

Details about the updated secret.

JSON

{
  "data": {
    "type": "secret",
    "gitops": {
      "vcsService": "github",
      "accountLogin": "github-user",
      "repoUrl": "https://github.com/northflank-examples/remix-postgres-redis-demo",
      "branch": "main",
      "filePath": "/Dockerfile"
    }
  }
}