Neynar · Example Payload

List Secrets

Retrieves all secrets for a deployment.

studio

List Secrets is an example object payload from Neynar, with 9 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummarydescriptiontagsparametersrequestBodyresponses

Example Payload

{
  "operationId": "list-secrets",
  "method": "GET",
  "path": "/v2/studio/deployment/secrets/",
  "summary": "List deployment secrets",
  "description": "Retrieves all secrets for a deployment.",
  "tags": [
    "studio"
  ],
  "parameters": [
    {
      "name": "deployment_id",
      "in": "query",
      "required": true,
      "description": "Deployment ID to list secrets for",
      "schema": {
        "format": "uuid",
        "type": "string"
      }
    },
    {
      "name": "key",
      "in": "query",
      "required": false,
      "description": "Optional filter by environment variable name",
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": null,
  "responses": {
    "200": {
      "description": "Success",
      "schema": {
        "properties": {
          "secrets": {
            "items": {
              "properties": {
                "id": {
                  "description": "Environment variable ID",
                  "type": "string"
                },
                "key": {
                  "description": "Environment variable name",
                  "type": "string"
                },
                "preview": {
                  "description": "Masked preview of the secret value (e.g. \"sk_l\u2026t1b3\")",
                  "type": "string"
                },
                "type": {
                  "description": "Whether this is a system-managed or user-defined variable",
                  "enum": [
                    "system",
                    "user"
                  ],
                  "type": "string"
                }
              },
              "required": [
                "key",
                "id",
                "type"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "success": {
            "enum": [
              true
            ],
            "type": "boolean"
          }
        },
        "required": [
          "success",
          "secrets"
        ],
        "type": "object"
      },
      "example": null
    },
    "404": {
      "description": "Resource not found",
      "schema": {
        "$ref": "#/components/schemas/ErrorRes"
      },
      "example": null
    },
    "500": {
      "description": "Server Error",
      "schema": {
        "$ref": "#/components/schemas/ErrorRes"
      },
      "example": null
    }
  }
}