scaleway.secret_manager.v1beta1.SecretVersion

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/scaleway.secret_manager.v1beta1.SecretVersion",
  "title": "scaleway.secret_manager.v1beta1.SecretVersion",
  "type": "object",
  "properties": {
    "revision": {
      "type": "integer",
      "description": "Version number.\nThe first version of the secret is numbered 1, and all subsequent revisions augment by 1.",
      "format": "uint32"
    },
    "secret_id": {
      "type": "string",
      "description": "ID of the secret. (UUID format)",
      "example": "6170692e-7363-616c-6577-61792e636f6d"
    },
    "status": {
      "type": "string",
      "description": "Current status of the version.\n* `unknown_status`: the version is in an invalid state.\n* `enabled`: the version is accessible.\n* `disabled`: the version is not accessible but can be enabled.\n* `scheduled_for_deletion`: the version is scheduled for deletion. It will be deleted in 7 days.\n* `deleted`: the version is permanently deleted. It is not possible to recover it.",
      "enum": [
        "unknown_status",
        "enabled",
        "disabled",
        "deleted",
        "scheduled_for_deletion"
      ],
      "default": "unknown_status"
    },
    "created_at": {
      "type": "string",
      "description": "Date and time of the version's creation. (RFC 3339 format)",
      "format": "date-time",
      "example": "2022-03-22T12:34:56.123456Z",
      "nullable": true
    },
    "updated_at": {
      "type": "string",
      "description": "Last update of the version. (RFC 3339 format)",
      "format": "date-time",
      "example": "2022-03-22T12:34:56.123456Z",
      "nullable": true
    },
    "deleted_at": {
      "type": "string",
      "description": "Date and time of the version's deletion. (RFC 3339 format)",
      "format": "date-time",
      "example": "2022-03-22T12:34:56.123456Z",
      "nullable": true
    },
    "description": {
      "type": "string",
      "description": "Description of the version.",
      "nullable": true
    },
    "latest": {
      "type": "boolean",
      "description": "Returns `true` if the version is the latest."
    },
    "ephemeral_properties": {
      "type": "object",
      "description": "Properties of the ephemeral version.\nReturns the version's expiration date, whether it expires after being accessed once, and the action to perform (disable or delete) once the version expires.",
      "properties": {
        "expires_at": {
          "type": "string",
          "description": "The version's expiration date.\n(Optional.) If not specified, the version does not have an expiration date. (RFC 3339 format)",
          "format": "date-time",
          "example": "2022-03-22T12:34:56.123456Z",
          "nullable": true
        },
        "expires_once_accessed": {
          "type": "boolean",
          "description": "Returns `true` if the version expires after a single user access.\n(Optional.) If not specified, the version can be accessed an unlimited amount of times.",
          "nullable": true
        },
        "action": {
          "type": "string",
          "description": "Action to perform when the version of a secret expires.\nSee `EphemeralPolicy.Action` enum for a description of values.",
          "enum": [
            "unknown_action",
            "delete",
            "disable"
          ],
          "x-enum-descriptions": {
            "values": {
              "delete": "The version is deleted once it expires.",
              "disable": "The version is disabled once it expires."
            }
          },
          "default": "unknown_action"
        }
      },
      "x-properties-order": [
        "expires_at",
        "expires_once_accessed",
        "action"
      ]
    },
    "deletion_requested_at": {
      "type": "string",
      "description": "Returns the time at which deletion was requested. (RFC 3339 format)",
      "format": "date-time",
      "example": "2022-03-22T12:34:56.123456Z",
      "nullable": true
    },
    "region": {
      "type": "string",
      "description": "Region of the version."
    }
  },
  "x-properties-order": [
    "revision",
    "secret_id",
    "status",
    "created_at",
    "updated_at",
    "deleted_at",
    "description",
    "latest",
    "ephemeral_properties",
    "deletion_requested_at",
    "region"
  ]
}