> For the complete documentation index, see [llms.txt](https://docs.snapfix.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.snapfix.com/engineering-reference/db/tables/tpri_api_simple_secretkey.md).

# tPri\_Api\_Simple\_SecretKey

{% hint style="info" %}
Generated from the staging database schema, with descriptions drafted by agents ([how to read these docs](https://docs.snapfix.com/how-to-read.md)). [Source on GitHub](https://github.com/snapfix/docs/blob/main/spec/db/tables/tPri_Api_Simple_SecretKey.md).
{% endhint %}

## Description

A public API key: only its SHA-256 hash is stored, with its validity dates, rate limits, permissions and AI switch. The API hashes the caller's key and looks it up here.

<details>

<summary><strong>Table Definition</strong></summary>

```sql
CREATE TABLE `tPri_Api_Simple_SecretKey` (
  `id` int NOT NULL AUTO_INCREMENT,
  `uuid` varchar(255) DEFAULT NULL,
  `uuid_tParent` varchar(255) DEFAULT NULL,
  `x-api-key-hash` varchar(255) DEFAULT NULL,
  `fStartTs` bigint DEFAULT '0',
  `fEndTs` bigint DEFAULT '0',
  `fComment` varchar(255) DEFAULT NULL,
  `fDefaultPermissions_json` json DEFAULT NULL,
  `fRateLimitPerDay` int DEFAULT '50000',
  `fRateLimitPerMin` int DEFAULT '60',
  `fDisabled` tinyint DEFAULT '0',
  `fDisabledTs` bigint DEFAULT '0',
  `fApiSource` enum('sf-public','d3x') DEFAULT 'sf-public',
  `fXVendor` tinyint DEFAULT '0',
  `fMinVersion` int DEFAULT '1',
  `fAiAccessEnabled` tinyint DEFAULT '0',
  `fDeleted` tinyint DEFAULT '0',
  `fCreatedTs` bigint DEFAULT '0',
  `fModifiedTs` bigint DEFAULT '0',
  `fServerTs` bigint DEFAULT NULL,
  `uuid_tUser_CreatedBy` varchar(255) DEFAULT NULL,
  `uuid_tUser_ModifiedBy` varchar(255) DEFAULT NULL,
  PRIMARY KEY (`id`) USING BTREE,
  UNIQUE KEY `uuid` (`uuid`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=latin1
```

</details>

## Columns

| Name                      | Type                    | Default   | Nullable | Extra Definition | Comment                                                                     |
| ------------------------- | ----------------------- | --------- | -------- | ---------------- | --------------------------------------------------------------------------- |
| id                        | int                     |           | false    | auto\_increment  |                                                                             |
| uuid                      | varchar(255)            |           | true     |                  |                                                                             |
| uuid\_tParent             | varchar(255)            |           | true     |                  |                                                                             |
| x-api-key-hash            | varchar(255)            |           | true     |                  |                                                                             |
| fStartTs                  | bigint                  | 0         | true     |                  |                                                                             |
| fEndTs                    | bigint                  | 0         | true     |                  |                                                                             |
| fComment                  | varchar(255)            |           | true     |                  |                                                                             |
| fDefaultPermissions\_json | json                    |           | true     |                  |                                                                             |
| fRateLimitPerDay          | int                     | 50000     | true     |                  |                                                                             |
| fRateLimitPerMin          | int                     | 60        | true     |                  |                                                                             |
| fDisabled                 | tinyint                 | 0         | true     |                  |                                                                             |
| fDisabledTs               | bigint                  | 0         | true     |                  |                                                                             |
| fApiSource                | enum('sf-public','d3x') | sf-public | true     |                  | Which API the key is for, sf-public or d3x; all staging rows are sf-public. |
| fXVendor                  | tinyint                 | 0         | true     |                  |                                                                             |
| fMinVersion               | int                     | 1         | true     |                  |                                                                             |
| fAiAccessEnabled          | tinyint                 | 0         | true     |                  | 1 when the key may use the AI features.                                     |
| fDeleted                  | tinyint                 | 0         | true     |                  |                                                                             |
| fCreatedTs                | bigint                  | 0         | true     |                  |                                                                             |
| fModifiedTs               | bigint                  | 0         | true     |                  |                                                                             |
| fServerTs                 | bigint                  |           | true     |                  |                                                                             |
| uuid\_tUser\_CreatedBy    | varchar(255)            |           | true     |                  |                                                                             |
| uuid\_tUser\_ModifiedBy   | varchar(255)            |           | true     |                  |                                                                             |

## Viewpoints

| Name                                                                                     | Definition                                                                                                                                                               |
| ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [integrations](https://docs.snapfix.com/engineering-reference/db/tables/viewpoint-14.md) | Property management system (PMS) integrations (mappings, room statuses, inbound and outbound queues, webhooks), Deputy, and the keys of the Open API and the vendor API. |

## Constraints

| Name    | Type        | Definition             |
| ------- | ----------- | ---------------------- |
| PRIMARY | PRIMARY KEY | PRIMARY KEY (id)       |
| uuid    | UNIQUE      | UNIQUE KEY uuid (uuid) |

## Indexes

| Name    | Definition                         |
| ------- | ---------------------------------- |
| PRIMARY | PRIMARY KEY (id) USING BTREE       |
| uuid    | UNIQUE KEY uuid (uuid) USING BTREE |

## Relations

```mermaid
erDiagram


"tPri_Api_Simple_SecretKey" {
  int id PK
}
```

***

> Generated by [tbls](https://github.com/k1LoW/tbls)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.snapfix.com/engineering-reference/db/tables/tpri_api_simple_secretkey.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
