v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Secrets /

Get global secret

Get a global secret including its contents

Path parameters

    • secretId

      string required
      ID of the secret

Response body

  • {object}
    Response object.

    • data

      {object} required
      Result data.

      • name

        string required
        min length
        3
        max length
        39
        pattern
        ^[a-zA-Z]((-|\s)?[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

            • 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-._]+$

          • createdAt

            string
            time of creation

          • updatedAt

            string
            time of update
      API
      CLI
      JS Client

      GET /v1/secrets/{secretId}

      Example response

      200 OK

      Details about the given secret.

      JSON

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

      © 2026 Northflank Ltd. All rights reserved.

      northflank.comTermsPrivacyfeedback@northflank.com