v1
Double column
API
CLI
JS Client

Services /

Get service build arguments

Gets the build arguments of the given service. If the API key does not have the permission 'Project > Secrets > General > Read', secrets inherited from secret groups will not be displayed.

Required permission

Project > Services > Configuration > View Build Parameters

Path parameters

    • projectId

      string required

      ID of the project

    • serviceId

      string required

      ID of the service

Query parameters

    • show

      string

      Which secrets to display - if set to this only the group's secrets are displayed, if set to inherited only secrets from linked addons are displayed, if set to all or not provided, both are displayed.

      one of
      this, inherited, all

Response body

  • {object}

    Response object.

    • data

      {object} required

      Result data.

      • buildArguments

        {object} required

        The build arguments, formatted as a JSON object. If the show parameter is set to this, this will only contain secrets saved to this entity. If the show parameter is set to inherited, this will only contain secrets inherited from linked secret groups. Otherwise, this will contain both.

        • buildFiles

          {object} required

          The build secret files, formatted as a JSON object. If the show parameter is set to this, this will only contain files saved to this entity. If the show parameter is set to inherited, this will only contain files inherited from linked secret groups. Otherwise, this will contain both.

      API
      CLI
      JS Client

      GET /v1/projects/{projectId}/services/{serviceId}/build-arguments

      Example response

      200 OK

      The build arguments for the service.

      JSON

      {
        "data": {
          "buildArguments": {
            "ARGUMENT_1": "abcdef",
            "ARGUMENT_2": "12345"
          },
          "buildFiles": {
            "/dir/fileName": {
              "data": "VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=",
              "encoding": "utf-8"
            }
          }
        }
      }

      © 2022 Northflank Ltd. All rights reserved.