v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Secrets /

List global secrets

Gets a list of global secrets

Query parameters

    • per_page

      integer
      The number of results to display per request. Maximum of 100 results per page.

    • page

      integer
      The page number to access.

    • cursor

      string
      The cursor returned from the previous page of results, used to request the next page.

Response body

  • {object}
    Response object.

    • data

      {object} required
      Result data.

      • secrets

        [array] required
        An array of global secrets
        • {object}
          A global secret object

          • id

            string required
            Identifier for the global secret

          • name

            string required
            Global secret name

          • description

            string
            A short description of the global secret

          • type

            string required
            The permission type of the global secret.
            one of
            secret, config

          • createdAt

            string required
            The time the global secret was created.

          • updatedAt

            string required
            The time the global secret was last updated.

    • pagination

      {object} required
      Data about the endpoint pagination.

      • hasNextPage

        boolean required
        Is there another page of results available?

      • cursor

        string
        The cursor to access the next page of results.

      • count

        number required
        The number of results returned by this request.
API
CLI
JS Client

GET /v1/secrets

Example response

200 OK

The list of secrets.

JSON

{
  "data": {
    "secrets": [
      {
        "id": "example-secret",
        "name": "Example Secret",
        "description": "This is the global secret description",
        "type": "secret",
        "createdAt": "2020-01-01T12:00:00.000Z",
        "updatedAt": "2020-01-01T12:00:00.000Z"
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}

© 2026 Northflank Ltd. All rights reserved.

northflank.comTermsPrivacyfeedback@northflank.com