Secret

Inspect a secret

Changed on
get/secrets/{id}

Request

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

Path parameters

idstring required

ID of the secret

Response

no error

IDstring
CreatedAtstring dateTime
UpdatedAtstring dateTime

Example response

{
  "ID": "blt1owaxmitz71s9v5zh81zun",
  "Version": {
    "Index": 373531
  },
  "CreatedAt": "2017-07-20T13:55:28.678958722Z",
  "UpdatedAt": "2017-07-20T13:55:28.678958722Z",
  "Spec": {
    "Labels": {
      "com.example.some-label": "some-value",
      "com.example.some-other-label": "some-other-value"
    },
    "Driver": {
      "Name": "some-driver",
      "Options": {
        "OptionA": "value for driver-specific option A",
        "OptionB": "value for driver-specific option B"
      }
    },
    "Templating": {
      "Name": "some-driver",
      "Options": {
        "OptionA": "value for driver-specific option A",
        "OptionB": "value for driver-specific option B"
      }
    }
  }
}

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

    • info

      added the non-success response with the status

    • 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

      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