Split · Schema

ApiKey

An API key used for authenticating with the Split platform

ExperimentationFeature FlagsFeature ManagementRolloutsSDKs

Properties

Name Type Description
id string Unique identifier for the API key
name string Name of the API key
apiKeyType string Type of the API key
key string The API key value (only returned at creation time)
roles array Roles assigned to the API key
createdAt integer Timestamp of when the API key was created
View JSON Schema on GitHub

JSON Schema

split-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 for authenticating with the Split platform",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the API key"
    },
    "name": {
      "type": "string",
      "description": "Name of the API key"
    },
    "apiKeyType": {
      "type": "string",
      "description": "Type of the API key",
      "enum": [
        "admin",
        "client-side",
        "server-side"
      ]
    },
    "key": {
      "type": "string",
      "description": "The API key value (only returned at creation time)"
    },
    "roles": {
      "type": "array",
      "description": "Roles assigned to the API key",
      "items": {
        "type": "string"
      }
    },
    "createdAt": {
      "type": "integer",
      "format": "int64",
      "description": "Timestamp of when the API key was created"
    }
  }
}