Successful Response

APIs.ioEngineeringPlatform

Properties

Name Type Description
data array
meta object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-getsecrettypes-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/getSecretTypes",
  "title": "Successful Response",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "Information about the secret type.",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the secret type.",
            "example": "Postman Collection Key"
          },
          "id": {
            "type": "string",
            "description": "The ID of the secret type.",
            "example": "04084949-0dda-4735-ace5-f83038f7b200"
          },
          "type": {
            "type": "string",
            "description": "The origin of the secret type:\n- `DEFAULT` \u2014 Supported by default in Postman.\n- `TEAM_REGEX` \u2014 A custom regex added by an Admin or Super Admin user in the **Configure Alerts** section of the [**Team Settings**](https://learning.postman.com/docs/administration/team-settings/) interface.\n",
            "enum": [
              "DEFAULT",
              "TEAM_REGEX"
            ],
            "example": "TEAM_REGEX"
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "integer",
          "description": "The total number of supported secrets.",
          "example": 4
        }
      }
    }
  }
}