> 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/blacklist_ipaddress.md).

# blacklist\_ipaddress

{% 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/blacklist_ipaddress.md).
{% endhint %}

## Description

One blocked IP address in the global blacklist. php-apis's request checks read it, and apipy's and authpy's IP checks also name it.

<details>

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

```sql
CREATE TABLE `blacklist_ipaddress` (
  `id` int NOT NULL AUTO_INCREMENT,
  `uuid` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL,
  `value` varchar(50) COLLATE utf8mb4_unicode_ci DEFAULT NULL,
  `fDeleted` tinyint DEFAULT '0',
  `fCreatedTs` bigint DEFAULT NULL,
  `fModifiedTs` bigint DEFAULT '0',
  `fServerTs` bigint DEFAULT '0',
  `uuid_tUser_CreatedBy` varchar(255) CHARACTER SET latin1 DEFAULT 'cathal',
  `uuid_tUser_ModifiedBy` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT '',
  `notes` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL,
  PRIMARY KEY (`id`),
  UNIQUE KEY `value` (`value`) USING BTREE,
  UNIQUE KEY `uuid` (`uuid`) USING BTREE,
  KEY `fk_blacklist_ipaddress_createdbyuser` (`uuid_tUser_CreatedBy`),
  CONSTRAINT `fk_blacklist_ipaddress_createdbyuser` FOREIGN KEY (`uuid_tUser_CreatedBy`) REFERENCES `tPri_User` (`uuid`) ON DELETE RESTRICT ON UPDATE RESTRICT
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci
```

</details>

## Columns

| Name                    | Type         | Default | Nullable | Extra Definition | Parents                                                                             |
| ----------------------- | ------------ | ------- | -------- | ---------------- | ----------------------------------------------------------------------------------- |
| id                      | int          |         | false    | auto\_increment  |                                                                                     |
| uuid                    | varchar(255) |         | true     |                  |                                                                                     |
| value                   | varchar(50)  |         | true     |                  |                                                                                     |
| fDeleted                | tinyint      | 0       | true     |                  |                                                                                     |
| fCreatedTs              | bigint       |         | true     |                  |                                                                                     |
| fModifiedTs             | bigint       | 0       | true     |                  |                                                                                     |
| fServerTs               | bigint       | 0       | true     |                  |                                                                                     |
| uuid\_tUser\_CreatedBy  | varchar(255) | cathal  | true     |                  | [tPri\_User](https://docs.snapfix.com/engineering-reference/db/tables/tpri_user.md) |
| uuid\_tUser\_ModifiedBy | varchar(255) |         | true     |                  |                                                                                     |
| notes                   | varchar(255) |         | true     |                  |                                                                                     |

## Viewpoints

| Name                                                                              | Definition                                                                                                                   |
| --------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| [staff](https://docs.snapfix.com/engineering-reference/db/tables/viewpoint-19.md) | Snapfix staff tools: blocklists, HubSpot and Jira data, the admin app log, site history and the organisation onboarding log. |

## Constraints

| Name                                    | Type        | Definition                                                        |
| --------------------------------------- | ----------- | ----------------------------------------------------------------- |
| fk\_blacklist\_ipaddress\_createdbyuser | FOREIGN KEY | FOREIGN KEY (uuid\_tUser\_CreatedBy) REFERENCES tPri\_User (uuid) |
| PRIMARY                                 | PRIMARY KEY | PRIMARY KEY (id)                                                  |
| uuid                                    | UNIQUE      | UNIQUE KEY uuid (uuid)                                            |
| value                                   | UNIQUE      | UNIQUE KEY value (value)                                          |

## Indexes

| Name                                    | Definition                                                                       |
| --------------------------------------- | -------------------------------------------------------------------------------- |
| fk\_blacklist\_ipaddress\_createdbyuser | KEY fk\_blacklist\_ipaddress\_createdbyuser (uuid\_tUser\_CreatedBy) USING BTREE |
| PRIMARY                                 | PRIMARY KEY (id) USING BTREE                                                     |
| uuid                                    | UNIQUE KEY uuid (uuid) USING BTREE                                               |
| value                                   | UNIQUE KEY value (value) USING BTREE                                             |

## Relations

```mermaid
erDiagram

"blacklist_ipaddress" }o--o| "tPri_User" : "FOREIGN KEY (uuid_tUser_CreatedBy) REFERENCES tPri_User (uuid)"

"blacklist_ipaddress" {
  int id PK
  varchar_255_ uuid_tUser_CreatedBy FK
}
"tPri_User" {
  int id PK
  varchar_255_ uuid
  varchar_255_ uuid_tUser_CreatedBy FK
}
```

***

> 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/blacklist_ipaddress.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.
