Pinecone · Schema

UpdateAPIKeyRequest

Vector DatabasesAIEmbeddingsRAG

Properties

Name Type Description
name string A new name for the API key. The name must be 1-80 characters long. If omitted, the name will not be updated.
roles array A new set of roles for the API key. Existing roles will be removed if not included. If this field is omitted, the roles will not be updated.
View JSON Schema on GitHub

JSON Schema

pinecone-updateapikeyrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateAPIKeyRequest",
  "title": "UpdateAPIKeyRequest",
  "type": "object",
  "properties": {
    "name": {
      "example": "devkey",
      "description": "A new name for the API key. The name must be 1-80 characters long. If omitted, the name will not be updated.\n",
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "roles": {
      "description": "A new set of roles for the API key. Existing roles will be removed if not included.\nIf this field is omitted, the roles will not be updated.\n",
      "type": "array",
      "items": {
        "example": "ProjectEditor",
        "description": "A role that can be assigned to an API key.\nPossible values: `ProjectEditor`, `ProjectViewer`, `ControlPlaneEditor`, `ControlPlaneViewer`, `DataPlaneEditor`, or `DataPlaneViewer`.",
        "x-enum": [
          "ProjectEditor",
          "ProjectViewer",
          "ControlPlaneEditor",
          "ControlPlaneViewer",
          "DataPlaneEditor",
          "DataPlaneViewer"
        ],
        "type": "string"
      }
    }
  }
}