Get addon credentials | Addons | Northflank API docs
v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Addons /

Get addon credentials

Returns the credentials for connecting to the given addon.

Required permission

Project > Addons > General > Read

Path parameters

    • projectId

      string required

      ID of the project

    • addonId

      string required

      ID of the addon

Response body

  • {object}

    Response object.

    • data

      {object} required

      Result data.

      • secrets

        {object} required

        An object containing secrets for connecting to the addon. Secrets are dependent on the addon type.

        • envs

          {object} required

          An object containing data such as connection strings. Dependent on the addon type.

      API
      CLI
      JS Client

      GET /v1/projects/{projectId}/addons/{addonId}/credentials

      Example response

      200 OK

      Credentials for the addon.

      JSON

      {
  "data": {
    "secrets": {
      "username": "1720747439245d49",
      "password": "f1ba286ee2465e80b0fd4af31276f3e33a"
    },
    "envs": {}
  }
}

      © 2024 Northflank Ltd. All rights reserved.

      northflank.comTermsPrivacyfeedback@northflank.com