Prisma · Schema

ApiKey

An API key used to authenticate Prisma Client requests to Data Platform resources. The key value is only available at creation time.

Properties

Name Type Description
id string Unique identifier for the API key
name string Display name of the API key
hint string Masked hint showing the last few characters of the key
environmentId string Identifier of the associated environment
createdAt string Timestamp when the API key was created
View JSON Schema on GitHub

JSON Schema

prisma-apikey-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ApiKey",
  "title": "ApiKey",
  "type": "object",
  "description": "An API key used to authenticate Prisma Client requests to Data Platform resources. The key value is only available at creation time.",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the API key"
    },
    "name": {
      "type": "string",
      "description": "Display name of the API key"
    },
    "hint": {
      "type": "string",
      "description": "Masked hint showing the last few characters of the key",
      "examples": [
        "****abc123"
      ]
    },
    "environmentId": {
      "type": "string",
      "description": "Identifier of the associated environment"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the API key was created"
    }
  },
  "required": [
    "id",
    "name",
    "hint",
    "environmentId",
    "createdAt"
  ]
}