Skip to main content
POST
https://api-zangtable.com
/
projects
/
{project}
/
indexes
/
{table}
POST /projects/{project}/indexes/{table}
curl --request POST \
  --url https://api-zangtable.com/projects/{project}/indexes/{table} \
  --header 'Authorization: <authorization>'
{
  "ok": true,
  "data": {},
  "error": {},
  "request_id": "<string>"
}
Creates an index on one or more existing columns.

Endpoint details

Authorization
string
required
Bearer pat_... (Project API Token). Keep this token on your backend/server.
project
string
required
Project slug. This acts as the Project ID in API paths.
table
string
required
Table name inside the project.
ok
boolean
required
true for a successful response and false for an error response.
data
object | null
Endpoint-specific response data when ok is true; null on errors.
error
object | null
Error code and message when ok is false; null on success.
request_id
string
required
Request identifier you can use when troubleshooting a specific API call.

Authentication

Project API Token.

Parameters

Path: table required. Body: columns required non-empty array; index_name optional identifier; unique optional boolean.

Request examples

Basic request:
curl -X POST "$BASE_URL/projects/{project}/indexes/{table}" \
  -H 'Authorization: Bearer pat_PROJECT_TOKEN' \
  -H 'Content-Type: application/json' \
  --data '{"columns":["email"]}'
Full request:
curl -X POST "$BASE_URL/projects/{project}/indexes/{table}" \
  -H 'Authorization: Bearer pat_PROJECT_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-Operation-Key: edit-profile-email' \
  -H 'X-Operation-Run-Id: oprun_client_20260602_001' \
  --data '{"columns":["status","created_at"],"index_name":"idx_contacts_status_created_at","unique":false}'

Response examples

Success:
{
  "ok": true,
  "data": {
    "index": {
      "name": "idx_contacts_email",
      "unique": false,
      "origin": "c",
      "partial": false,
      "columns": [
        "email"
      ],
      "managed": true,
      "sql": "CREATE INDEX idx_contacts_email ON contacts (email)"
    }
  },
  "error": null,
  "request_id": "req_20260602T012345_123456Z_abc123def456",
  "operation_key": "edit-profile-email",
  "operation_run_id": "oprun_20260602T012300_000000Z_a1b2c3d4e5f6",
  "operation_grouping_status": "accepted_provided_run",
  "meta": {
    "generated_at": "2026-06-02T01:23:45Z"
  }
}
Error or alternate response:
{
  "ok": false,
  "data": null,
  "error": {
    "code": "index_exists",
    "message": "An index with that name already exists."
  },
  "request_id": "req_20260602T012345_123456Z_abc123def456",
  "meta": {
    "generated_at": "2026-06-02T01:23:45Z"
  }
}