v1
Double column
API
CLI
JS Client

Secrets /

Update secret

Update a secret

Required permission

Project > Secrets > General > Update

Path parameters

    • projectId

      string required

      ID of the project

    • secretId

      string required

      ID of the secret

Request body

  • {object}
    • description

      string

      A description of the secret.

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

      integer

      The priority with which different secrets will be merged.

      min
      0
      max
      100
    • restrictions

      {object}

      Restriction settings of the secret

      • restricted

        boolean

        Is the secret restricted

      • nfObjects

        [array]

        List of Northflank services & jobs the secret is restricted to

        • {object}
          • id

            string required

            ID of the entity the secret is restricted to.

            pattern
            ^[A-Za-z0-9-]+$
          • type

            string required

            Type of the entity the secret is restricted to.

            one of
            service, job
    • addonDependencies

      [array]

      An array of addons to link to this secret group. If provided, this will overwrite any existing linked addons.

      • {object}

        An object containing data about the addon to link.

        • addonId

          string required

          The internal id of the addon to link.

          pattern
          ^[A-Za-z0-9-]+$
        • keys

          [array] required

          An array of objects containing details about the keys to link to this secret group.

          • {object}

            Details about the key to link to this secret group.

            • keyName

              string required

              The name of the key to link.

            • aliases

              [array]

              An array of aliases for the key.

              • string

                The name of the alias. Keys must only contain letters and numbers separated with underscores, may not start with a number

                pattern
                ^[a-zA-Z_][a-zA-Z0-9_]*$
    • secretType

      string

      The type of the created secret

      one of
      environment-arguments, environment, arguments
    • secrets

      {object}
      • variables

        {object}

        Secret variables as JSON object, encrypted at rest. Keys must only contain letters and numbers separated with underscores, may not start with a number

        • files

          {object}

          Secret files as JSON object, encrypted at rest. File path must be absolute

      Response body

      • {object}

        Response object.

        • data

          {object} required

          Result data.

        API
        CLI
        JS Client

        POST /v1/projects/{projectId}/secrets/{secretId}

        Example request

        Request body
        curl
        curl --header "Content-Type: application/json" \
          --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
          --request POST \
          --data '{"description":"A description","priority":10,"restrictions":{"restricted":true,"nfObjects":[{"id":"example-service","type":"service"}]},"addonDependencies":[{"addonId":"example-addon","keys":[{"keyName":"username","aliases":["MONGO_USERNAME"]}]}],"secretType":"environment","secrets":{"variables":{"NODE_ENV":"production","MONGO_DB":"some_connection_string"},"files":{"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}}}}' \
          http://api.northflank.com/v1/projects/{projectId}/secrets/{secretId}

        Example response

        200 OK

        The operation was performed successfully.

        JSON

        {
          "data": {}
        }

        © 2022 Northflank Ltd. All rights reserved.