Update secret addon link | Secrets | Northflank API docs
v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Secrets /

Update secret addon link

Link an addon to the secret group or edit the settings of the linked addon.

Required permission

Project > Secrets > General > Update

Path parameters

    • projectId

      string required

      ID of the project

    • secretId

      string required

      ID of the secret

    • addonId

      string required

      ID of the addon

Request body

  • {object}

    • 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.

          pattern
          [a-zA-Z]+

        • aliases

          [array]

          An array of aliases for the key.

          • string

            The name of the alias. Keys may only contain letters, numbers, hyphens, forward slashes and dots.

            pattern
            ^[a-zA-Z0-9_./-]*$

Response body

  • {object}

    Response object.

    • data

      {object} required

      Result data.

      • keys

        [array] required

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

        • {object}

          Details about a key linked to this secret group.

          • keyName

            string required

            The name of the key to link.

            pattern
            [a-zA-Z]+

          • aliases

            [array]

            An array of aliases for the key.

            • string

              The name of the alias. Keys may only contain letters, numbers, hyphens, forward slashes and dots.

              pattern
              ^[a-zA-Z0-9_./-]*$

          • defaultKey

            string required
API
CLI
JS Client

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

Example request

Request body
curl
curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"keys":[{"keyName":"USERNAME","aliases":["MONGO_USERNAME"]}]}' \
  https://api.northflank.com/v1/projects/{projectId}/secrets/{secretId}/addons/{addonId}

Example response

200 OK

Details about the new keys.

JSON

{
  "data": {
    "keys": [
      {
        "keyName": "USERNAME",
        "aliases": [
          "MONGO_USERNAME"
        ],
        "defaultKey": "NF_EXAMPLE-ADDON_USERNAME"
      }
    ]
  }
}

© 2024 Northflank Ltd. All rights reserved.

northflank.comTermsPrivacyfeedback@northflank.com