List secrets

v1.0.0

Retrieves the active Vercel secrets for the authenticated user. By default it returns 20 secrets. The rest can be retrieved using the pagination options. The body will contain an entry for each secret.

Input

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Filter out secrets based on comma separated secret ids."
    },
    "projectId": {
      "type": "string",
      "description": "Filter out secrets that belong to a project."
    },
    "teamId": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "pagination",
    "secrets"
  ],
  "properties": {
    "pagination": {
      "type": "object",
      "description": "This object contains information related to the pagination of the current request, including the necessary parameters to get the next or previous page of data.",
      "required": [
        "count",
        "next",
        "prev"
      ],
      "properties": {
        "count": {
          "type": "number",
          "description": "Amount of items in the current page."
        },
        "next": {
          "type": [
            "number",
            "null"
          ],
          "description": "Timestamp that must be used to request the next page."
        },
        "prev": {
          "type": [
            "number",
            "null"
          ],
          "description": "Timestamp that must be used to request the previous page."
        }
      }
    },
    "secrets": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "Data representing a secret.",
        "required": [
          "created",
          "name",
          "uid"
        ],
        "properties": {
          "created": {
            "type": "string",
            "format": "date-time",
            "description": "The date when the secret was created."
          },
          "createdAt": {
            "type": "number",
            "description": "Timestamp for when the secret was created."
          },
          "decryptable": {
            "type": "boolean",
            "description": "Indicates whether the secret value can be decrypted after it has been created."
          },
          "name": {
            "type": "string",
            "description": "The name of the secret."
          },
          "projectId": {
            "type": "string",
            "description": "The unique identifier of the project which the secret belongs to."
          },
          "teamId": {
            "type": [
              "string",
              "null"
            ],
            "description": "The unique identifier of the team the secret was created for."
          },
          "uid": {
            "type": "string",
            "description": "The unique identifier of the secret."
          },
          "userId": {
            "type": "string",
            "description": "The unique identifier of the user who created the secret."
          },
          "value": {
            "type": "string",
            "description": "The value of the secret."
          }
        }
      }
    }
  }
}