v1
Double column
API
CLI
JS Client

Secrets /

Get secret addon link details

Get details about a given addon link.

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

Response body

  • {object}

    Response object.

    • data

      {object} required

      Result data.

      • secretName

        string required

        The name of the secret group

      • secretId

        string required

        Identifier for the secret group

      • addonName

        string required

        The name of the linked addon

      • addonId

        string required

        The ID of the linked addon

      • addonType

        string required

        The addon type of the linked addon

      • linked

        boolean required

        Is this addon currently linked to this secret group?

      • linkedKeys

        [array]

        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.

          • 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_]*$
          • defaultKey

            string required
      • availableKeys

        [array] required

        A list of available keys for the given addon.

        • string
API
CLI
JS Client

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

Example response

200 OK

Details about the link between the secret group and addon.

JSON

{
  "data": {
    "secretName": "Example secret group",
    "secretId": "example-secret-group",
    "addonName": "Example Addon",
    "addonId": "example-addon",
    "addonType": "mongodb",
    "linked": true,
    "linkedKeys": [
      {
        "keyName": "username",
        "aliases": [
          "MONGO_USERNAME"
        ],
        "defaultKey": "NF_EXAMPLE-ADDON_USERNAME"
      }
    ],
    "availableKeys": [
      "username"
    ]
  }
}

© 2022 Northflank Ltd. All rights reserved.