v1beta
Double column
curl
API
CLI

Secrets /

List secrets

Gets a list of secrets belonging to the project

URL parameters

    • project

      string required

      ID of the project

Response attributes

  • object

    • secrets

      array required

      An array of secret groups

      • object

        A secret group object

        • name

          string required

          Secret group name

        • description

          string

          A short description of the secret group

        • internalId

          string required

          Identifier for the secret group

        • secretType

          string required

          The type of the created secret group

          one of: environment, arguments

        • priority

          integer required

          The priority with which different secret groups will be merged

        • restrictions

          object required

          Restriction settings of the secret

          • restricted

            boolean

            Is the secret restricted

          • nfObjects

            array

            List of Northflank services & jobs the secret is restricted to

            • object

              • nfObjectId

                string required

                pattern: [A-Za-z0-9-]

              • nfObjectType

                string required

API
CLI

GET /v1beta/projects/{project}/secrets

Example response

200 OK

The list of secrets.

JSON

{
  "secrets": [
    {
      "name": "Example secret group",
      "description": "This is the secret group description",
      "internalId": "example-secret-group",
      "secretType": "environment",
      "priority": 10,
      "restrictions": {
        "restricted": false,
        "nfObjects": [
          {}
        ]
      }
    }
  ]
}

© 2021 Northflank Ltd. All rights reserved.

TermsPrivacy

contact@northflank.com