---
agentTools:
  projectIndex: https://docs.rakam.io/v1.0/llms.txt
---

# Check lock key

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "An analytics platform API that lets you create your own analytics services.",
    "version": "0.13",
    "title": "Rakam API Documentation",
    "contact": {
      "email": "contact@rakam.io"
    },
    "license": {
      "name": "Apache License 2.0",
      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
    }
  },
  "tags": [
    {
      "name": "admin",
      "description": "System related actions",
      "externalDocs": {
        "description": "Rakam Documentation",
        "url": "https://rakam.io/doc"
      }
    }
  ],
  "paths": {
    "/admin/lock_key": {
      "post": {
        "tags": [
          "admin"
        ],
        "summary": "Check lock key",
        "description": "",
        "operationId": "CheckLockKey",
        "requestBody": {
          "$ref": "#/components/requestBodies/CheckLockKeyChecklockkey"
        },
        "responses": {
          "200": {
            "description": "Successful request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "boolean"
                }
              }
            }
          },
          "403": {
            "description": "master_key is invalid",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            }
          }
        },
        "security": [
          {
            "master_key": [
              "master_key"
            ]
          }
        ]
      }
    }
  },
  "servers": [
    {
      "url": "//your-rakam-api.com/"
    }
  ],
  "components": {
    "requestBodies": {
      "CheckLockKeyChecklockkey": {
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "lock_key": {
                  "type": "string",
                  "description": "",
                  "default": ""
                }
              }
            }
          }
        },
        "required": true
      }
    },
    "securitySchemes": {
      "master_key": {
        "type": "apiKey",
        "name": "master_key",
        "in": "header"
      }
    },
    "schemas": {
      "ErrorMessage": {
        "type": "object",
        "required": [
          "error",
          "error_code"
        ],
        "properties": {
          "error": {
            "type": "string"
          },
          "error_code": {
            "type": "integer",
            "format": "int32"
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 93,
      "1": 204,
      "2": 133,
      "3": 218,
      "4": 130,
      "5": 97,
      "6": 210,
      "7": 0,
      "8": 65,
      "9": 118,
      "10": 84,
      "11": 174
    }
  }
}
```