Parameters

List Parameters

get

List all Parameters items.

Parameter is a reusable request parameter definition scoped to a path or a single operation.

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 Parameters

application/json

Parameters 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}/parameters

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

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

Create Parameter

post

Create a new Parameter item.

Parameter is a reusable request parameter definition scoped to a path or a single operation.

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

Parameter is a reusable request parameter definition scoped to a path or a single operation.

idstring · min: 30 · max: 30Optional

Object ID with prefix "par_"

Default: par_agqkbwfj3n3bzeizmgx32g6xjaExample: par_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestring · min: 1Required

Parameter name as exposed in the API (case-sensitive for header names).

Example: page

descriptionstringOptional

Human-readable description of what the parameter controls (markdown).

Example: Page number for pagination.

pathIdstring · min: 31 · max: 31Optional

Set when the parameter applies to every operation on a path.

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Optional

Set when the parameter is specific to a single operation.

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

deprecatedbooleanOptionalDefault: false

requiredbooleanOptionalDefault: false

instring · enumRequired

Location of the parameter (query, header, path, or cookie).

Example: queryPossible values:

schemaany ofRequired

Structured shape of the parameter value (type, format, constraints).

Example: {"type":"string"}

or

or

or

or

or

or

or

allowEmptyValuebooleanOptionalDeprecated

Allows sending an empty string for query parameters (legacy OpenAPI flag; generally avoid).

Default: false

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-09-14T16:55:48.955ZExample: 2024-01-15T10:30:00.000Z

Responses

201

Parameter created

application/json

Parameter is a reusable request parameter definition scoped to a path or a single operation.

idstring · min: 30 · max: 30Optional

Object ID with prefix "par_"

Default: par_agqkbwfj3n3bzeizmgx32g6xjaExample: par_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestring · min: 1Required

Parameter name as exposed in the API (case-sensitive for header names).

Example: page

descriptionstringOptional

Human-readable description of what the parameter controls (markdown).

Example: Page number for pagination.

pathIdstring · min: 31 · max: 31Optional

Set when the parameter applies to every operation on a path.

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Optional

Set when the parameter is specific to a single operation.

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

deprecatedbooleanOptionalDefault: false

requiredbooleanOptionalDefault: false

instring · enumRequired

Location of the parameter (query, header, path, or cookie).

Example: queryPossible values:

schemaany ofRequired

Structured shape of the parameter value (type, format, constraints).

Example: {"type":"string"}

or

or

or

or

or

or

or

allowEmptyValuebooleanOptionalDeprecated

Allows sending an empty string for query parameters (legacy OpenAPI flag; generally avoid).

Default: false

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-09-14T16:55:48.955ZExample: 2024-01-15T10:30:00.000Z

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}/parameters

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

{
  "id": "par_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "page",
  "description": "Page number for pagination.",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "deprecated": false,
  "required": false,
  "in": "query",
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "par_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "page",
  "description": "Page number for pagination.",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "deprecated": false,
  "required": false,
  "in": "query",
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Get Parameter

get

Get a Parameter item by its id.

Parameter is a reusable request parameter definition scoped to a path or a single operation.

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: 30 · max: 30Required

Parameter identifier

Example: par_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

200

Parameter details

application/json

Parameter is a reusable request parameter definition scoped to a path or a single operation.

idstring · min: 30 · max: 30Optional

Object ID with prefix "par_"

Default: par_agqkbwfj3n3bzeizmgx32g6xjaExample: par_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestring · min: 1Required

Parameter name as exposed in the API (case-sensitive for header names).

Example: page

descriptionstringOptional

Human-readable description of what the parameter controls (markdown).

Example: Page number for pagination.

pathIdstring · min: 31 · max: 31Optional

Set when the parameter applies to every operation on a path.

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Optional

Set when the parameter is specific to a single operation.

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

deprecatedbooleanOptionalDefault: false

requiredbooleanOptionalDefault: false

instring · enumRequired

Location of the parameter (query, header, path, or cookie).

Example: queryPossible values:

schemaany ofRequired

Structured shape of the parameter value (type, format, constraints).

Example: {"type":"string"}

or

or

or

or

or

or

or

allowEmptyValuebooleanOptionalDeprecated

Allows sending an empty string for query parameters (legacy OpenAPI flag; generally avoid).

Default: false

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-09-14T16:55:48.955ZExample: 2024-01-15T10:30:00.000Z

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Parameter not found

application/json

500

Internal Server Error

application/json

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

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

{
  "id": "par_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "page",
  "description": "Page number for pagination.",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "deprecated": false,
  "required": false,
  "in": "query",
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Replace Parameter

post

Completely replaces a Parameter item by its id.

Parameter is a reusable request parameter definition scoped to a path or a single operation.

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: 30 · max: 30Required

Parameter identifier

Example: par_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

Parameter is a reusable request parameter definition scoped to a path or a single operation.

idstring · min: 30 · max: 30Optional

Object ID with prefix "par_"

Default: par_agqkbwfj3n3bzeizmgx32g6xjaExample: par_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestring · min: 1Required

Parameter name as exposed in the API (case-sensitive for header names).

Example: page

descriptionstringOptional

Human-readable description of what the parameter controls (markdown).

Example: Page number for pagination.

pathIdstring · min: 31 · max: 31Optional

Set when the parameter applies to every operation on a path.

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Optional

Set when the parameter is specific to a single operation.

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

deprecatedbooleanOptionalDefault: false

requiredbooleanOptionalDefault: false

instring · enumRequired

Location of the parameter (query, header, path, or cookie).

Example: queryPossible values:

schemaany ofRequired

Structured shape of the parameter value (type, format, constraints).

Example: {"type":"string"}

or

or

or

or

or

or

or

allowEmptyValuebooleanOptionalDeprecated

Allows sending an empty string for query parameters (legacy OpenAPI flag; generally avoid).

Default: false

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-09-14T16:55:48.955ZExample: 2024-01-15T10:30:00.000Z

Responses

200

Parameter replaced

application/json

Parameter is a reusable request parameter definition scoped to a path or a single operation.

idstring · min: 30 · max: 30Optional

Object ID with prefix "par_"

Default: par_agqkbwfj3n3bzeizmgx32g6xjaExample: par_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestring · min: 1Required

Parameter name as exposed in the API (case-sensitive for header names).

Example: page

descriptionstringOptional

Human-readable description of what the parameter controls (markdown).

Example: Page number for pagination.

pathIdstring · min: 31 · max: 31Optional

Set when the parameter applies to every operation on a path.

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Optional

Set when the parameter is specific to a single operation.

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

deprecatedbooleanOptionalDefault: false

requiredbooleanOptionalDefault: false

instring · enumRequired

Location of the parameter (query, header, path, or cookie).

Example: queryPossible values:

schemaany ofRequired

Structured shape of the parameter value (type, format, constraints).

Example: {"type":"string"}

or

or

or

or

or

or

or

allowEmptyValuebooleanOptionalDeprecated

Allows sending an empty string for query parameters (legacy OpenAPI flag; generally avoid).

Default: false

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-09-14T16:55:48.955ZExample: 2024-01-15T10:30:00.000Z

201

Parameter created

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Parameter not found

application/json

500

Internal Server Error

application/json

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

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

{
  "id": "par_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "page",
  "description": "Page number for pagination.",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "deprecated": false,
  "required": false,
  "in": "query",
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "par_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "page",
  "description": "Page number for pagination.",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "deprecated": false,
  "required": false,
  "in": "query",
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Delete Parameter

delete

Delete a Parameter item by its id.

Parameter is a reusable request parameter definition scoped to a path or a single operation.

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: 30 · max: 30Required

Parameter identifier

Example: par_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

204

Parameter deleted

No content

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Parameter not found

application/json

500

Internal Server Error

application/json

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

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

No content

Update Parameter

patch

Partially updates a Parameter item by its id.

Parameter is a reusable request parameter definition scoped to a path or a single operation.

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: 30 · max: 30Required

Parameter identifier

Example: par_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

idstring · min: 30 · max: 30Optional

Object ID with prefix "par_"

Default: par_agqkbwfj3n3bzeiznbdi326v6iExample: par_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestring · min: 1Optional

Parameter name as exposed in the API (case-sensitive for header names).

Example: page

descriptionstringOptional

Human-readable description of what the parameter controls (markdown).

Example: Page number for pagination.

pathIdstring · min: 31 · max: 31Optional

Set when the parameter applies to every operation on a path.

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Optional

Set when the parameter is specific to a single operation.

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

deprecatedbooleanOptionalDefault: false

requiredbooleanOptionalDefault: false

instring · enumOptional

Location of the parameter (query, header, path, or cookie).

Example: queryPossible values:

schemaany ofOptional

Structured shape of the parameter value (type, format, constraints).

Example: {"type":"string"}

or

or

or

or

or

or

or

allowEmptyValuebooleanOptionalDeprecated

Allows sending an empty string for query parameters (legacy OpenAPI flag; generally avoid).

Default: false

versionIdstring · min: 30 · max: 30Optional

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-09-14T16:55:48.955ZExample: 2024-01-15T10:30:00.000Z

Responses

200

Parameter updated

application/json

Parameter is a reusable request parameter definition scoped to a path or a single operation.

idstring · min: 30 · max: 30Optional

Object ID with prefix "par_"

Default: par_agqkbwfj3n3bzeizmgx32g6xjaExample: par_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestring · min: 1Required

Parameter name as exposed in the API (case-sensitive for header names).

Example: page

descriptionstringOptional

Human-readable description of what the parameter controls (markdown).

Example: Page number for pagination.

pathIdstring · min: 31 · max: 31Optional

Set when the parameter applies to every operation on a path.

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Optional

Set when the parameter is specific to a single operation.

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

deprecatedbooleanOptionalDefault: false

requiredbooleanOptionalDefault: false

instring · enumRequired

Location of the parameter (query, header, path, or cookie).

Example: queryPossible values:

schemaany ofRequired

Structured shape of the parameter value (type, format, constraints).

Example: {"type":"string"}

or

or

or

or

or

or

or

allowEmptyValuebooleanOptionalDeprecated

Allows sending an empty string for query parameters (legacy OpenAPI flag; generally avoid).

Default: false

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-09-14T16:55:48.955ZExample: 2024-01-15T10:30:00.000Z

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Parameter not found

application/json

500

Internal Server Error

application/json

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

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

{
  "id": "par_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "page",
  "description": "Page number for pagination.",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "deprecated": false,
  "required": false,
  "in": "query",
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "par_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "page",
  "description": "Page number for pagination.",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "deprecated": false,
  "required": false,
  "in": "query",
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

List Parameters

get

List all Parameters items.

Parameter is a reusable request parameter definition scoped to a path or a single operation.

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 Parameters

application/json

Parameters 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}/parameters

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

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

Create Parameter

post

Create a new Parameter item.

Parameter is a reusable request parameter definition scoped to a path or a single operation.

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

Parameter is a reusable request parameter definition scoped to a path or a single operation.

idstring · min: 30 · max: 30Optional

Object ID with prefix "par_"

Default: par_agqkbwfj3n3bzeizmgx32g6xjaExample: par_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestring · min: 1Required

Parameter name as exposed in the API (case-sensitive for header names).

Example: page

descriptionstringOptional

Human-readable description of what the parameter controls (markdown).

Example: Page number for pagination.

pathIdstring · min: 31 · max: 31Optional

Set when the parameter applies to every operation on a path.

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Optional

Set when the parameter is specific to a single operation.

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

deprecatedbooleanOptionalDefault: false

requiredbooleanOptionalDefault: false

instring · enumRequired

Location of the parameter (query, header, path, or cookie).

Example: queryPossible values:

schemaany ofRequired

Structured shape of the parameter value (type, format, constraints).

Example: {"type":"string"}

or

or

or

or

or

or

or

allowEmptyValuebooleanOptionalDeprecated

Allows sending an empty string for query parameters (legacy OpenAPI flag; generally avoid).

Default: false

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-09-14T16:55:48.955ZExample: 2024-01-15T10:30:00.000Z

Responses

201

Parameter created

application/json

Parameter is a reusable request parameter definition scoped to a path or a single operation.

idstring · min: 30 · max: 30Optional

Object ID with prefix "par_"

Default: par_agqkbwfj3n3bzeizmgx32g6xjaExample: par_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestring · min: 1Required

Parameter name as exposed in the API (case-sensitive for header names).

Example: page

descriptionstringOptional

Human-readable description of what the parameter controls (markdown).

Example: Page number for pagination.

pathIdstring · min: 31 · max: 31Optional

Set when the parameter applies to every operation on a path.

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Optional

Set when the parameter is specific to a single operation.

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

deprecatedbooleanOptionalDefault: false

requiredbooleanOptionalDefault: false

instring · enumRequired

Location of the parameter (query, header, path, or cookie).

Example: queryPossible values:

schemaany ofRequired

Structured shape of the parameter value (type, format, constraints).

Example: {"type":"string"}

or

or

or

or

or

or

or

allowEmptyValuebooleanOptionalDeprecated

Allows sending an empty string for query parameters (legacy OpenAPI flag; generally avoid).

Default: false

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-09-14T16:55:48.955ZExample: 2024-01-15T10:30:00.000Z

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}/parameters

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

{
  "id": "par_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "page",
  "description": "Page number for pagination.",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "deprecated": false,
  "required": false,
  "in": "query",
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "par_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "page",
  "description": "Page number for pagination.",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "deprecated": false,
  "required": false,
  "in": "query",
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Get Parameter

get

Get a Parameter item by its id.

Parameter is a reusable request parameter definition scoped to a path or a single operation.

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: 30 · max: 30Required

Parameter identifier

Example: par_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

200

Parameter details

application/json

Parameter is a reusable request parameter definition scoped to a path or a single operation.

idstring · min: 30 · max: 30Optional

Object ID with prefix "par_"

Default: par_agqkbwfj3n3bzeizmgx32g6xjaExample: par_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestring · min: 1Required

Parameter name as exposed in the API (case-sensitive for header names).

Example: page

descriptionstringOptional

Human-readable description of what the parameter controls (markdown).

Example: Page number for pagination.

pathIdstring · min: 31 · max: 31Optional

Set when the parameter applies to every operation on a path.

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Optional

Set when the parameter is specific to a single operation.

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

deprecatedbooleanOptionalDefault: false

requiredbooleanOptionalDefault: false

instring · enumRequired

Location of the parameter (query, header, path, or cookie).

Example: queryPossible values:

schemaany ofRequired

Structured shape of the parameter value (type, format, constraints).

Example: {"type":"string"}

or

or

or

or

or

or

or

allowEmptyValuebooleanOptionalDeprecated

Allows sending an empty string for query parameters (legacy OpenAPI flag; generally avoid).

Default: false

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-09-14T16:55:48.955ZExample: 2024-01-15T10:30:00.000Z

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Parameter not found

application/json

500

Internal Server Error

application/json

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

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

{
  "id": "par_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "page",
  "description": "Page number for pagination.",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "deprecated": false,
  "required": false,
  "in": "query",
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Replace Parameter

post

Completely replaces a Parameter item by its id.

Parameter is a reusable request parameter definition scoped to a path or a single operation.

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: 30 · max: 30Required

Parameter identifier

Example: par_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

Parameter is a reusable request parameter definition scoped to a path or a single operation.

idstring · min: 30 · max: 30Optional

Object ID with prefix "par_"

Default: par_agqkbwfj3n3bzeizmgx32g6xjaExample: par_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestring · min: 1Required

Parameter name as exposed in the API (case-sensitive for header names).

Example: page

descriptionstringOptional

Human-readable description of what the parameter controls (markdown).

Example: Page number for pagination.

pathIdstring · min: 31 · max: 31Optional

Set when the parameter applies to every operation on a path.

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Optional

Set when the parameter is specific to a single operation.

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

deprecatedbooleanOptionalDefault: false

requiredbooleanOptionalDefault: false

instring · enumRequired

Location of the parameter (query, header, path, or cookie).

Example: queryPossible values:

schemaany ofRequired

Structured shape of the parameter value (type, format, constraints).

Example: {"type":"string"}

or

or

or

or

or

or

or

allowEmptyValuebooleanOptionalDeprecated

Allows sending an empty string for query parameters (legacy OpenAPI flag; generally avoid).

Default: false

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-09-14T16:55:48.955ZExample: 2024-01-15T10:30:00.000Z

Responses

200

Parameter replaced

application/json

Parameter is a reusable request parameter definition scoped to a path or a single operation.

idstring · min: 30 · max: 30Optional

Object ID with prefix "par_"

Default: par_agqkbwfj3n3bzeizmgx32g6xjaExample: par_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestring · min: 1Required

Parameter name as exposed in the API (case-sensitive for header names).

Example: page

descriptionstringOptional

Human-readable description of what the parameter controls (markdown).

Example: Page number for pagination.

pathIdstring · min: 31 · max: 31Optional

Set when the parameter applies to every operation on a path.

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Optional

Set when the parameter is specific to a single operation.

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

deprecatedbooleanOptionalDefault: false

requiredbooleanOptionalDefault: false

instring · enumRequired

Location of the parameter (query, header, path, or cookie).

Example: queryPossible values:

schemaany ofRequired

Structured shape of the parameter value (type, format, constraints).

Example: {"type":"string"}

or

or

or

or

or

or

or

allowEmptyValuebooleanOptionalDeprecated

Allows sending an empty string for query parameters (legacy OpenAPI flag; generally avoid).

Default: false

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-09-14T16:55:48.955ZExample: 2024-01-15T10:30:00.000Z

201

Parameter created

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Parameter not found

application/json

500

Internal Server Error

application/json

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

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

{
  "id": "par_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "page",
  "description": "Page number for pagination.",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "deprecated": false,
  "required": false,
  "in": "query",
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "par_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "page",
  "description": "Page number for pagination.",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "deprecated": false,
  "required": false,
  "in": "query",
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Delete Parameter

delete

Delete a Parameter item by its id.

Parameter is a reusable request parameter definition scoped to a path or a single operation.

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: 30 · max: 30Required

Parameter identifier

Example: par_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

204

Parameter deleted

No content

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Parameter not found

application/json

500

Internal Server Error

application/json

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

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

No content

Update Parameter

patch

Partially updates a Parameter item by its id.

Parameter is a reusable request parameter definition scoped to a path or a single operation.

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: 30 · max: 30Required

Parameter identifier

Example: par_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

idstring · min: 30 · max: 30Optional

Object ID with prefix "par_"

Default: par_agqkbwfj3n3bzeizomqnsqsdpiExample: par_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestring · min: 1Optional

Parameter name as exposed in the API (case-sensitive for header names).

Example: page

descriptionstringOptional

Human-readable description of what the parameter controls (markdown).

Example: Page number for pagination.

pathIdstring · min: 31 · max: 31Optional

Set when the parameter applies to every operation on a path.

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Optional

Set when the parameter is specific to a single operation.

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

deprecatedbooleanOptionalDefault: false

requiredbooleanOptionalDefault: false

instring · enumOptional

Location of the parameter (query, header, path, or cookie).

Example: queryPossible values:

schemaany ofOptional

Structured shape of the parameter value (type, format, constraints).

Example: {"type":"string"}

or

or

or

or

or

or

or

allowEmptyValuebooleanOptionalDeprecated

Allows sending an empty string for query parameters (legacy OpenAPI flag; generally avoid).

Default: false

versionIdstring · min: 30 · max: 30Optional

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-09-14T16:55:48.955ZExample: 2024-01-15T10:30:00.000Z

Responses

200

Parameter updated

application/json

Parameter is a reusable request parameter definition scoped to a path or a single operation.

idstring · min: 30 · max: 30Optional

Object ID with prefix "par_"

Default: par_agqkbwfj3n3bzeizmgx32g6xjaExample: par_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestring · min: 1Required

Parameter name as exposed in the API (case-sensitive for header names).

Example: page

descriptionstringOptional

Human-readable description of what the parameter controls (markdown).

Example: Page number for pagination.

pathIdstring · min: 31 · max: 31Optional

Set when the parameter applies to every operation on a path.

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Optional

Set when the parameter is specific to a single operation.

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

deprecatedbooleanOptionalDefault: false

requiredbooleanOptionalDefault: false

instring · enumRequired

Location of the parameter (query, header, path, or cookie).

Example: queryPossible values:

schemaany ofRequired

Structured shape of the parameter value (type, format, constraints).

Example: {"type":"string"}

or

or

or

or

or

or

or

allowEmptyValuebooleanOptionalDeprecated

Allows sending an empty string for query parameters (legacy OpenAPI flag; generally avoid).

Default: false

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-09-14T16:55:48.955ZExample: 2024-01-15T10:30:00.000Z

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Parameter not found

application/json

500

Internal Server Error

application/json

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

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

{
  "id": "par_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "page",
  "description": "Page number for pagination.",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "deprecated": false,
  "required": false,
  "in": "query",
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "par_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "page",
  "description": "Page number for pagination.",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "deprecated": false,
  "required": false,
  "in": "query",
  "schema": {
    "type": "string"
  },
  "examples": {},
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}