Headers

List Headers

get

List all Headers items.

Header is a reusable HTTP header definition with schema, examples, and optional structured content.

Authorizations

AuthorizationstringRequired

Project API key authentication. Use your project API key as a Bearer token in the Authorization header.

Path parameters

versionIdstring · min: 30 · max: 30Required

Catalog version identifier

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

Query parameters

afterstringOptional

Cursor for pagination (item ID)

limitinteger · min: 1 · max: 1000Optional

Maximum number of items to return (default: 50, max: 1000)

Default: 50

sortany ofOptional

Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)

stringOptional

or

string[]Optional

Responses

200

List of Headers

application/json

Headers collection

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get/v2/catalog/versions/{versionId}/headers

GET /v2/catalog/versions/{versionId}/headers HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [],
  "pagination": {
    "nextCursor": null,
    "hasMore": true,
    "limit": 1
  }
}

Create Header

post

Create a new Header item.

Header is a reusable HTTP header definition with schema, examples, and optional structured content.

Authorizations

AuthorizationstringRequired

Project API key authentication. Use your project API key as a Bearer token in the Authorization header.

Path parameters

versionIdstring · min: 30 · max: 30Required

Catalog version identifier

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

Header is a reusable HTTP header definition with schema, examples, and optional structured content.

idstring · min: 31 · max: 31Optional

Object ID with prefix "head_"

Default: head_agqatw3xir2znbb3kj4h77oyq4Example: head_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringRequired

Header name; case-insensitive when serialized in HTTP.

Example: Authorization

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

descriptionstringOptional

Plain description of what the header conveys.

Example: Bearer token for authentication.

requiredbooleanOptional

Marks the header as required for the request or response.

deprecatedbooleanOptional

stylestring · enumOptional

Serialization style for the header (simple = comma-separated).

Example: simplePossible values:

explodebooleanOptional

Controls whether arrays/objects are split into separate values instead of a single combined string.

schemaany ofOptional

JSON Schema describing the header value.

Example: {"type":"string"}

or

or

or

or

or

or

or

Responses

201

Header created

application/json

Header is a reusable HTTP header definition with schema, examples, and optional structured content.

idstring · min: 31 · max: 31Optional

Object ID with prefix "head_"

Default: head_agqatw3xir2znbb3kj4h77oyq4Example: head_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringRequired

Header name; case-insensitive when serialized in HTTP.

Example: Authorization

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

descriptionstringOptional

Plain description of what the header conveys.

Example: Bearer token for authentication.

requiredbooleanOptional

Marks the header as required for the request or response.

deprecatedbooleanOptional

stylestring · enumOptional

Serialization style for the header (simple = comma-separated).

Example: simplePossible values:

explodebooleanOptional

Controls whether arrays/objects are split into separate values instead of a single combined string.

schemaany ofOptional

JSON Schema describing the header value.

Example: {"type":"string"}

or

or

or

or

or

or

or

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

post/v2/catalog/versions/{versionId}/headers

POST /v2/catalog/versions/{versionId}/headers HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 334

{
  "id": "head_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "Authorization",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z",
  "description": "Bearer token for authentication.",
  "required": false,
  "deprecated": false,
  "style": "simple",
  "explode": false,
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "content": {}
}

{
  "id": "head_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "Authorization",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z",
  "description": "Bearer token for authentication.",
  "required": false,
  "deprecated": false,
  "style": "simple",
  "explode": false,
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "content": {}
}

Get Header

get

Get a Header item by its id.

Header is a reusable HTTP header definition with schema, examples, and optional structured content.

Authorizations

AuthorizationstringRequired

Project API key authentication. Use your project API key as a Bearer token in the Authorization header.

Path parameters

versionIdstring · min: 30 · max: 30Required

Catalog version identifier

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

idstring · min: 31 · max: 31Required

Header identifier

Example: head_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

200

Header details

application/json

Header is a reusable HTTP header definition with schema, examples, and optional structured content.

idstring · min: 31 · max: 31Optional

Object ID with prefix "head_"

Default: head_agqatw3xir2znbb3kj4h77oyq4Example: head_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringRequired

Header name; case-insensitive when serialized in HTTP.

Example: Authorization

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

descriptionstringOptional

Plain description of what the header conveys.

Example: Bearer token for authentication.

requiredbooleanOptional

Marks the header as required for the request or response.

deprecatedbooleanOptional

stylestring · enumOptional

Serialization style for the header (simple = comma-separated).

Example: simplePossible values:

explodebooleanOptional

Controls whether arrays/objects are split into separate values instead of a single combined string.

schemaany ofOptional

JSON Schema describing the header value.

Example: {"type":"string"}

or

or

or

or

or

or

or

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Header not found

application/json

500

Internal Server Error

application/json

get/v2/catalog/versions/{versionId}/headers/{id}

GET /v2/catalog/versions/{versionId}/headers/{id} HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "head_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "Authorization",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z",
  "description": "Bearer token for authentication.",
  "required": false,
  "deprecated": false,
  "style": "simple",
  "explode": false,
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "content": {}
}

Replace Header

post

Completely replaces a Header item by its id.

Header is a reusable HTTP header definition with schema, examples, and optional structured content.

Authorizations

AuthorizationstringRequired

Project API key authentication. Use your project API key as a Bearer token in the Authorization header.

Path parameters

versionIdstring · min: 30 · max: 30Required

Catalog version identifier

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

idstring · min: 31 · max: 31Required

Header identifier

Example: head_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

Header is a reusable HTTP header definition with schema, examples, and optional structured content.

idstring · min: 31 · max: 31Optional

Object ID with prefix "head_"

Default: head_agqatw3xir2znbb3kj4h77oyq4Example: head_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringRequired

Header name; case-insensitive when serialized in HTTP.

Example: Authorization

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

descriptionstringOptional

Plain description of what the header conveys.

Example: Bearer token for authentication.

requiredbooleanOptional

Marks the header as required for the request or response.

deprecatedbooleanOptional

stylestring · enumOptional

Serialization style for the header (simple = comma-separated).

Example: simplePossible values:

explodebooleanOptional

Controls whether arrays/objects are split into separate values instead of a single combined string.

schemaany ofOptional

JSON Schema describing the header value.

Example: {"type":"string"}

or

or

or

or

or

or

or

Responses

200

Header replaced

application/json

Header is a reusable HTTP header definition with schema, examples, and optional structured content.

idstring · min: 31 · max: 31Optional

Object ID with prefix "head_"

Default: head_agqatw3xir2znbb3kj4h77oyq4Example: head_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringRequired

Header name; case-insensitive when serialized in HTTP.

Example: Authorization

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

descriptionstringOptional

Plain description of what the header conveys.

Example: Bearer token for authentication.

requiredbooleanOptional

Marks the header as required for the request or response.

deprecatedbooleanOptional

stylestring · enumOptional

Serialization style for the header (simple = comma-separated).

Example: simplePossible values:

explodebooleanOptional

Controls whether arrays/objects are split into separate values instead of a single combined string.

schemaany ofOptional

JSON Schema describing the header value.

Example: {"type":"string"}

or

or

or

or

or

or

or

201

Header created

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Header not found

application/json

500

Internal Server Error

application/json

post/v2/catalog/versions/{versionId}/headers/{id}

POST /v2/catalog/versions/{versionId}/headers/{id} HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 334

{
  "id": "head_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "Authorization",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z",
  "description": "Bearer token for authentication.",
  "required": false,
  "deprecated": false,
  "style": "simple",
  "explode": false,
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "content": {}
}

{
  "id": "head_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "Authorization",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z",
  "description": "Bearer token for authentication.",
  "required": false,
  "deprecated": false,
  "style": "simple",
  "explode": false,
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "content": {}
}

Delete Header

delete

Delete a Header item by its id.

Header is a reusable HTTP header definition with schema, examples, and optional structured content.

Authorizations

AuthorizationstringRequired

Project API key authentication. Use your project API key as a Bearer token in the Authorization header.

Path parameters

versionIdstring · min: 30 · max: 30Required

Catalog version identifier

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

idstring · min: 31 · max: 31Required

Header identifier

Example: head_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

204

Header deleted

No content

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Header not found

application/json

500

Internal Server Error

application/json

delete/v2/catalog/versions/{versionId}/headers/{id}

DELETE /v2/catalog/versions/{versionId}/headers/{id} HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update Header

patch

Partially updates a Header item by its id.

Header is a reusable HTTP header definition with schema, examples, and optional structured content.

Authorizations

AuthorizationstringRequired

Project API key authentication. Use your project API key as a Bearer token in the Authorization header.

Path parameters

versionIdstring · min: 30 · max: 30Required

Catalog version identifier

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

idstring · min: 31 · max: 31Required

Header identifier

Example: head_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

idstring · min: 31 · max: 31Optional

Object ID with prefix "head_"

Default: head_agqatw3xir2znbb3lezitsa2kiExample: head_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringOptional

Header name; case-insensitive when serialized in HTTP.

Example: Authorization

versionIdstring · min: 30 · max: 30Optional

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

descriptionstringOptional

Plain description of what the header conveys.

Example: Bearer token for authentication.

requiredbooleanOptional

Marks the header as required for the request or response.

deprecatedbooleanOptional

stylestring · enumOptional

Serialization style for the header (simple = comma-separated).

Example: simplePossible values:

explodebooleanOptional

Controls whether arrays/objects are split into separate values instead of a single combined string.

schemaany ofOptional

JSON Schema describing the header value.

Example: {"type":"string"}

or

or

or

or

or

or

or

Responses

200

Header updated

application/json

Header is a reusable HTTP header definition with schema, examples, and optional structured content.

idstring · min: 31 · max: 31Optional

Object ID with prefix "head_"

Default: head_agqatw3xir2znbb3kj4h77oyq4Example: head_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringRequired

Header name; case-insensitive when serialized in HTTP.

Example: Authorization

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

descriptionstringOptional

Plain description of what the header conveys.

Example: Bearer token for authentication.

requiredbooleanOptional

Marks the header as required for the request or response.

deprecatedbooleanOptional

stylestring · enumOptional

Serialization style for the header (simple = comma-separated).

Example: simplePossible values:

explodebooleanOptional

Controls whether arrays/objects are split into separate values instead of a single combined string.

schemaany ofOptional

JSON Schema describing the header value.

Example: {"type":"string"}

or

or

or

or

or

or

or

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Header not found

application/json

500

Internal Server Error

application/json

patch/v2/catalog/versions/{versionId}/headers/{id}

PATCH /v2/catalog/versions/{versionId}/headers/{id} HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 334

{
  "id": "head_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "Authorization",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z",
  "description": "Bearer token for authentication.",
  "required": false,
  "deprecated": false,
  "style": "simple",
  "explode": false,
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "content": {}
}

{
  "id": "head_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "Authorization",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z",
  "description": "Bearer token for authentication.",
  "required": false,
  "deprecated": false,
  "style": "simple",
  "explode": false,
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "content": {}
}

List Headers

get

List all Headers items.

Header is a reusable HTTP header definition with schema, examples, and optional structured content.

Authorizations

AuthorizationstringRequired

Project API key authentication. Use your project API key as a Bearer token in the Authorization header.

Path parameters

projectRefany ofRequired

Project slug or project id (proj_*)

string · min: 31 · max: 31Optional

Object ID with prefix "proj_"

Example: proj_c4x6k3w8j7n9b1z5s2t4m8q0ve

or

string · min: 1Optional

versionTypestring · enumRequired

Version type, can be either 'branch' or 'environment'

Example: branchPossible values:

versionSlugstring · min: 1Required

Version slug

Example: main

Query parameters

afterstringOptional

Cursor for pagination (item ID)

limitinteger · min: 1 · max: 1000Optional

Maximum number of items to return (default: 50, max: 1000)

Default: 50

sortany ofOptional

Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)

stringOptional

or

string[]Optional

Responses

200

List of Headers

application/json

Headers collection

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/headers

GET /v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/headers HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [],
  "pagination": {
    "nextCursor": null,
    "hasMore": true,
    "limit": 1
  }
}

Create Header

post

Create a new Header item.

Header is a reusable HTTP header definition with schema, examples, and optional structured content.

Authorizations

AuthorizationstringRequired

Project API key authentication. Use your project API key as a Bearer token in the Authorization header.

Path parameters

projectRefany ofRequired

Project slug or project id (proj_*)

string · min: 31 · max: 31Optional

Object ID with prefix "proj_"

Example: proj_c4x6k3w8j7n9b1z5s2t4m8q0ve

or

string · min: 1Optional

versionTypestring · enumRequired

Version type, can be either 'branch' or 'environment'

Example: branchPossible values:

versionSlugstring · min: 1Required

Version slug

Example: main

Body

Header is a reusable HTTP header definition with schema, examples, and optional structured content.

idstring · min: 31 · max: 31Optional

Object ID with prefix "head_"

Default: head_agqatw3xir2znbb3kj4h77oyq4Example: head_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringRequired

Header name; case-insensitive when serialized in HTTP.

Example: Authorization

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

descriptionstringOptional

Plain description of what the header conveys.

Example: Bearer token for authentication.

requiredbooleanOptional

Marks the header as required for the request or response.

deprecatedbooleanOptional

stylestring · enumOptional

Serialization style for the header (simple = comma-separated).

Example: simplePossible values:

explodebooleanOptional

Controls whether arrays/objects are split into separate values instead of a single combined string.

schemaany ofOptional

JSON Schema describing the header value.

Example: {"type":"string"}

or

or

or

or

or

or

or

Responses

201

Header created

application/json

Header is a reusable HTTP header definition with schema, examples, and optional structured content.

idstring · min: 31 · max: 31Optional

Object ID with prefix "head_"

Default: head_agqatw3xir2znbb3kj4h77oyq4Example: head_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringRequired

Header name; case-insensitive when serialized in HTTP.

Example: Authorization

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

descriptionstringOptional

Plain description of what the header conveys.

Example: Bearer token for authentication.

requiredbooleanOptional

Marks the header as required for the request or response.

deprecatedbooleanOptional

stylestring · enumOptional

Serialization style for the header (simple = comma-separated).

Example: simplePossible values:

explodebooleanOptional

Controls whether arrays/objects are split into separate values instead of a single combined string.

schemaany ofOptional

JSON Schema describing the header value.

Example: {"type":"string"}

or

or

or

or

or

or

or

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

409

Conflict

application/json

500

Internal Server Error

application/json

post/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/headers

POST /v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/headers HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 334

{
  "id": "head_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "Authorization",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z",
  "description": "Bearer token for authentication.",
  "required": false,
  "deprecated": false,
  "style": "simple",
  "explode": false,
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "content": {}
}

{
  "id": "head_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "Authorization",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z",
  "description": "Bearer token for authentication.",
  "required": false,
  "deprecated": false,
  "style": "simple",
  "explode": false,
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "content": {}
}

Get Header

get

Get a Header item by its id.

Header is a reusable HTTP header definition with schema, examples, and optional structured content.

Authorizations

AuthorizationstringRequired

Project API key authentication. Use your project API key as a Bearer token in the Authorization header.

Path parameters

projectRefany ofRequired

Project slug or project id (proj_*)

string · min: 31 · max: 31Optional

Object ID with prefix "proj_"

Example: proj_c4x6k3w8j7n9b1z5s2t4m8q0ve

or

string · min: 1Optional

versionTypestring · enumRequired

Version type, can be either 'branch' or 'environment'

Example: branchPossible values:

versionSlugstring · min: 1Required

Version slug

Example: main

idstring · min: 31 · max: 31Required

Header identifier

Example: head_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

200

Header details

application/json

Header is a reusable HTTP header definition with schema, examples, and optional structured content.

idstring · min: 31 · max: 31Optional

Object ID with prefix "head_"

Default: head_agqatw3xir2znbb3kj4h77oyq4Example: head_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringRequired

Header name; case-insensitive when serialized in HTTP.

Example: Authorization

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

descriptionstringOptional

Plain description of what the header conveys.

Example: Bearer token for authentication.

requiredbooleanOptional

Marks the header as required for the request or response.

deprecatedbooleanOptional

stylestring · enumOptional

Serialization style for the header (simple = comma-separated).

Example: simplePossible values:

explodebooleanOptional

Controls whether arrays/objects are split into separate values instead of a single combined string.

schemaany ofOptional

JSON Schema describing the header value.

Example: {"type":"string"}

or

or

or

or

or

or

or

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Header not found

application/json

500

Internal Server Error

application/json

get/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/headers/{id}

GET /v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/headers/{id} HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "head_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "Authorization",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z",
  "description": "Bearer token for authentication.",
  "required": false,
  "deprecated": false,
  "style": "simple",
  "explode": false,
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "content": {}
}

Replace Header

post

Completely replaces a Header item by its id.

Header is a reusable HTTP header definition with schema, examples, and optional structured content.

Authorizations

AuthorizationstringRequired

Project API key authentication. Use your project API key as a Bearer token in the Authorization header.

Path parameters

projectRefany ofRequired

Project slug or project id (proj_*)

string · min: 31 · max: 31Optional

Object ID with prefix "proj_"

Example: proj_c4x6k3w8j7n9b1z5s2t4m8q0ve

or

string · min: 1Optional

versionTypestring · enumRequired

Version type, can be either 'branch' or 'environment'

Example: branchPossible values:

versionSlugstring · min: 1Required

Version slug

Example: main

idstring · min: 31 · max: 31Required

Header identifier

Example: head_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

Header is a reusable HTTP header definition with schema, examples, and optional structured content.

idstring · min: 31 · max: 31Optional

Object ID with prefix "head_"

Default: head_agqatw3xir2znbb3kj4h77oyq4Example: head_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringRequired

Header name; case-insensitive when serialized in HTTP.

Example: Authorization

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

descriptionstringOptional

Plain description of what the header conveys.

Example: Bearer token for authentication.

requiredbooleanOptional

Marks the header as required for the request or response.

deprecatedbooleanOptional

stylestring · enumOptional

Serialization style for the header (simple = comma-separated).

Example: simplePossible values:

explodebooleanOptional

Controls whether arrays/objects are split into separate values instead of a single combined string.

schemaany ofOptional

JSON Schema describing the header value.

Example: {"type":"string"}

or

or

or

or

or

or

or

Responses

200

Header replaced

application/json

Header is a reusable HTTP header definition with schema, examples, and optional structured content.

idstring · min: 31 · max: 31Optional

Object ID with prefix "head_"

Default: head_agqatw3xir2znbb3kj4h77oyq4Example: head_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringRequired

Header name; case-insensitive when serialized in HTTP.

Example: Authorization

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

descriptionstringOptional

Plain description of what the header conveys.

Example: Bearer token for authentication.

requiredbooleanOptional

Marks the header as required for the request or response.

deprecatedbooleanOptional

stylestring · enumOptional

Serialization style for the header (simple = comma-separated).

Example: simplePossible values:

explodebooleanOptional

Controls whether arrays/objects are split into separate values instead of a single combined string.

schemaany ofOptional

JSON Schema describing the header value.

Example: {"type":"string"}

or

or

or

or

or

or

or

201

Header created

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Header not found

application/json

500

Internal Server Error

application/json

post/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/headers/{id}

POST /v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/headers/{id} HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 334

{
  "id": "head_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "Authorization",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z",
  "description": "Bearer token for authentication.",
  "required": false,
  "deprecated": false,
  "style": "simple",
  "explode": false,
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "content": {}
}

{
  "id": "head_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "Authorization",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z",
  "description": "Bearer token for authentication.",
  "required": false,
  "deprecated": false,
  "style": "simple",
  "explode": false,
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "content": {}
}

Delete Header

delete

Delete a Header item by its id.

Header is a reusable HTTP header definition with schema, examples, and optional structured content.

Authorizations

AuthorizationstringRequired

Project API key authentication. Use your project API key as a Bearer token in the Authorization header.

Path parameters

projectRefany ofRequired

Project slug or project id (proj_*)

string · min: 31 · max: 31Optional

Object ID with prefix "proj_"

Example: proj_c4x6k3w8j7n9b1z5s2t4m8q0ve

or

string · min: 1Optional

versionTypestring · enumRequired

Version type, can be either 'branch' or 'environment'

Example: branchPossible values:

versionSlugstring · min: 1Required

Version slug

Example: main

idstring · min: 31 · max: 31Required

Header identifier

Example: head_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

204

Header deleted

No content

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Header not found

application/json

500

Internal Server Error

application/json

delete/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/headers/{id}

DELETE /v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/headers/{id} HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update Header

patch

Partially updates a Header item by its id.

Header is a reusable HTTP header definition with schema, examples, and optional structured content.

Authorizations

AuthorizationstringRequired

Project API key authentication. Use your project API key as a Bearer token in the Authorization header.

Path parameters

projectRefany ofRequired

Project slug or project id (proj_*)

string · min: 31 · max: 31Optional

Object ID with prefix "proj_"

Example: proj_c4x6k3w8j7n9b1z5s2t4m8q0ve

or

string · min: 1Optional

versionTypestring · enumRequired

Version type, can be either 'branch' or 'environment'

Example: branchPossible values:

versionSlugstring · min: 1Required

Version slug

Example: main

idstring · min: 31 · max: 31Required

Header identifier

Example: head_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

idstring · min: 31 · max: 31Optional

Object ID with prefix "head_"

Default: head_agqatw3xir2znbb3moe6ajpppmExample: head_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringOptional

Header name; case-insensitive when serialized in HTTP.

Example: Authorization

versionIdstring · min: 30 · max: 30Optional

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

descriptionstringOptional

Plain description of what the header conveys.

Example: Bearer token for authentication.

requiredbooleanOptional

Marks the header as required for the request or response.

deprecatedbooleanOptional

stylestring · enumOptional

Serialization style for the header (simple = comma-separated).

Example: simplePossible values:

explodebooleanOptional

Controls whether arrays/objects are split into separate values instead of a single combined string.

schemaany ofOptional

JSON Schema describing the header value.

Example: {"type":"string"}

or

or

or

or

or

or

or

Responses

200

Header updated

application/json

Header is a reusable HTTP header definition with schema, examples, and optional structured content.

idstring · min: 31 · max: 31Optional

Object ID with prefix "head_"

Default: head_agqatw3xir2znbb3kj4h77oyq4Example: head_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringRequired

Header name; case-insensitive when serialized in HTTP.

Example: Authorization

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-08-16T09:16:12.996ZExample: 2024-01-15T10:30:00.000Z

descriptionstringOptional

Plain description of what the header conveys.

Example: Bearer token for authentication.

requiredbooleanOptional

Marks the header as required for the request or response.

deprecatedbooleanOptional

stylestring · enumOptional

Serialization style for the header (simple = comma-separated).

Example: simplePossible values:

explodebooleanOptional

Controls whether arrays/objects are split into separate values instead of a single combined string.

schemaany ofOptional

JSON Schema describing the header value.

Example: {"type":"string"}

or

or

or

or

or

or

or

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Header not found

application/json

500

Internal Server Error

application/json

patch/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/headers/{id}

PATCH /v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/headers/{id} HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 334

{
  "id": "head_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "Authorization",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z",
  "description": "Bearer token for authentication.",
  "required": false,
  "deprecated": false,
  "style": "simple",
  "explode": false,
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "content": {}
}

{
  "id": "head_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "Authorization",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z",
  "description": "Bearer token for authentication.",
  "required": false,
  "deprecated": false,
  "style": "simple",
  "explode": false,
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "content": {}
}