CockroachDB · Schema

CreateApiKeyResponse

Response from creating an API key. Contains the key secret which is only returned once and cannot be retrieved again.

Cluster ManagementCloudDatabaseDistributed SQLInfrastructurePostgreSQL CompatibleSQL

Properties

Name	Type	Description
api_key	object
secret	string	The secret value of the API key. Only returned on creation and not retrievable afterward.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateApiKeyResponse",
  "title": "CreateApiKeyResponse",
  "type": "object",
  "description": "Response from creating an API key. Contains the key secret which is only returned once and cannot be retrieved again.",
  "properties": {
    "api_key": {
      "$ref": "#/components/schemas/ApiKey"
    },
    "secret": {
      "type": "string",
      "description": "The secret value of the API key. Only returned on creation and not retrievable afterward."
    }
  }
}