Neynar · Example Payload

Upsert Secrets

Upsert secrets for a deployment.

studio

Upsert 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

Raw ↑ 
{
  "operationId": "upsert-secrets",
  "method": "POST",
  "path": "/v2/studio/deployment/secrets/",
  "summary": "Upsert deployment secrets",
  "description": "Upsert secrets for a deployment.",
  "tags": [
    "studio"
  ],
  "parameters": [],
  "requestBody": {
    "required": true,
    "schema": {
      "properties": {
        "deployment_id": {
          "description": "Deployment ID to add secrets to",
          "format": "uuid",
          "type": "string"
        },
        "secrets": {
          "description": "Secrets to create",
          "items": {
            "properties": {
              "key": {
                "description": "Environment variable name",
                "type": "string"
              },
              "value": {
                "description": "Environment variable value",
                "type": "string"
              }
            },
            "required": [
              "key",
              "value"
            ],
            "type": "object"
          },
          "minItems": 1,
          "type": "array"
        }
      },
      "required": [
        "deployment_id",
        "secrets"
      ],
      "type": "object"
    },
    "example": null
  },
  "responses": {
    "200": {
      "description": "Success",
      "schema": {
        "properties": {
          "success": {
            "enum": [
              true
            ],
            "type": "boolean"
          }
        },
        "required": [
          "success"
        ],
        "type": "object"
      },
      "example": null
    },
    "400": {
      "description": "Bad Request",
      "schema": {
        "$ref": "#/components/schemas/ErrorRes"
      },
      "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
    }
  }
}