HEhexlet
Secret

List secrets

Changed on
get/secrets

Request

  • Base URL
    /v1.57 (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    none declared

Query parameters

filtersstring

A JSON encoded value of the filters (a map[string][]string) to process on the secrets list.

Available filters:

  • id=<secret id>
  • label=<key> or label=<key>=value
  • name=<secret name> matches all or part of a secret name (prefix match)
  • names=<secret name> matches a secret name (exact match)

Response

no error

IDstring
CreatedAtstring dateTime
UpdatedAtstring dateTime

Example response

[
  {
    "ID": "blt1owaxmitz71s9v5zh81zun",
    "Version": {
      "Index": 85
    },
    "CreatedAt": "2017-07-20T13:55:28.678958722Z",
    "UpdatedAt": "2017-07-20T13:55:28.678958722Z",
    "Spec": {
      "Name": "mysql-passwd",
      "Labels": {
        "some.label": "some.value"
      },
      "Driver": {
        "Name": "secret-bucket",
        "Options": {
          "OptionA": "value for driver option A",
          "OptionB": "value for driver option B"
        }
      }
    }
  },
  {
    "ID": "ktnbjxoalbkvbvedmg1urrz8h",
    "Version": {
      "Index": 11
    },
    "CreatedAt": "2016-11-05T01:20:17.327670065Z",
    "UpdatedAt": "2016-11-05T01:20:17.327670065Z",
    "Spec": {
      "Name": "app-dev.crt",
      "Labels": {
        "foo": "bar"
      }
    }
  }
]

Changes

  • 6df97b60796cRevision changes
    • breaking

      removed the media type application/json for the response with the status

    • info

      api tag Secret added

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 31f80d10d31aRevision changes
    • breaking

      the / response's property format changed from dateTime to date-time for status

    • breaking

      the // response's property type changed from object to no type for status

    • breaking

      the // response's property type changed from object to no type for status

    • breaking

      the / response's property format changed from dateTime to date-time for status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      api tag Secret removed

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status