Requests

List Requests

get

List all Requests items.

Request is an operation request body definition including MIME type, payload shape, headers, and examples.

Authorizations

projectApiKeypersonalAccessToken

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 Requests

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get

/v2/catalog/versions/{versionId}/requests

HTTPcURLJavaScriptPython

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

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

Create Request

post

Create a new Request item.

Request is an operation request body definition including MIME type, payload shape, headers, and examples.

Authorizations

projectApiKeypersonalAccessToken

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

application/json

Request is an operation request body definition including MIME type, payload shape, headers, and examples.

idstring · min: 30 · max: 30Optional

Object ID with prefix "req_"

Default: req_agob4v2per3ujmlkjo2xyydeimExample: req_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Required

Object ID with prefix "op_"

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

descriptionstringOptional

Markdown description of the request.

Example: Request body for creating a new user.

descriptionBlocksany ofOptional

Request description in ProseMirror JSON.

Example: {"type":"paragraph","content":[{"type":"text","text":"Request description in rich text format."}]}

or

contentMediaTypeany ofOptional

MIME type of the request body (for example, application/json); null means the request has no body.

Example: application/json

stringOptional

or

nullOptional

schemaany ofOptional

Structured shape of the request payload (types, required fields, constraints).

Example: {"type":"object","properties":{}}

or

or

or

or

or

or

or

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-02-02T12:32:44.324ZExample: 2024-01-15T10:30:00.000Z

Responses

201

Request created

application/json

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

HTTPcURLJavaScriptPython

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

{
  "id": "req_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "description": "Request body for creating a new user.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Request description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "headers": {},
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "examples": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "req_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "description": "Request body for creating a new user.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Request description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "headers": {},
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "examples": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Get Request

get

Get a Request item by its id.

Request is an operation request body definition including MIME type, payload shape, headers, and examples.

Authorizations

projectApiKeypersonalAccessToken

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

Request identifier

Example: req_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

200

Request details

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Request not found

application/json

500

Internal Server Error

application/json

get

/v2/catalog/versions/{versionId}/requests/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "req_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "description": "Request body for creating a new user.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Request description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "headers": {},
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "examples": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Replace Request

post

Completely replaces a Request item by its id.

Request is an operation request body definition including MIME type, payload shape, headers, and examples.

Authorizations

projectApiKeypersonalAccessToken

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

Request identifier

Example: req_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

application/json

Request is an operation request body definition including MIME type, payload shape, headers, and examples.

idstring · min: 30 · max: 30Optional

Object ID with prefix "req_"

Default: req_agob4v2per3ujmlkjo2xyydeimExample: req_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Required

Object ID with prefix "op_"

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

descriptionstringOptional

Markdown description of the request.

Example: Request body for creating a new user.

descriptionBlocksany ofOptional

Request description in ProseMirror JSON.

Example: {"type":"paragraph","content":[{"type":"text","text":"Request description in rich text format."}]}

or

contentMediaTypeany ofOptional

MIME type of the request body (for example, application/json); null means the request has no body.

Example: application/json

stringOptional

or

nullOptional

schemaany ofOptional

Structured shape of the request payload (types, required fields, constraints).

Example: {"type":"object","properties":{}}

or

or

or

or

or

or

or

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-02-02T12:32:44.324ZExample: 2024-01-15T10:30:00.000Z

Responses

200

Request replaced

application/json

201

Request created

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Request not found

application/json

500

Internal Server Error

application/json

post

/v2/catalog/versions/{versionId}/requests/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "req_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "description": "Request body for creating a new user.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Request description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "headers": {},
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "examples": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "req_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "description": "Request body for creating a new user.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Request description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "headers": {},
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "examples": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Delete Request

delete

Delete a Request item by its id.

Request is an operation request body definition including MIME type, payload shape, headers, and examples.

Authorizations

projectApiKeypersonalAccessToken

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

Request identifier

Example: req_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

204

Request deleted

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Request not found

application/json

500

Internal Server Error

application/json

delete

/v2/catalog/versions/{versionId}/requests/{id}

HTTPcURLJavaScriptPython

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

No content

Update Request

patch

Partially updates a Request item by its id.

Request is an operation request body definition including MIME type, payload shape, headers, and examples.

Authorizations

projectApiKeypersonalAccessToken

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

Request identifier

Example: req_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

application/json

idstring · min: 30 · max: 30Optional

Object ID with prefix "req_"

Default: req_agob4v2per3ujmlkknk3xwrwzeExample: req_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Optional

Object ID with prefix "op_"

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

descriptionstringOptional

Markdown description of the request.

Example: Request body for creating a new user.

descriptionBlocksany ofOptional

Request description in ProseMirror JSON.

Example: {"type":"paragraph","content":[{"type":"text","text":"Request description in rich text format."}]}

or

contentMediaTypeany ofOptional

MIME type of the request body (for example, application/json); null means the request has no body.

Example: application/json

stringOptional

or

nullOptional

schemaany ofOptional

Structured shape of the request payload (types, required fields, constraints).

Example: {"type":"object","properties":{}}

or

or

or

or

or

or

or

versionIdstring · min: 30 · max: 30Optional

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-02-02T12:32:44.324ZExample: 2024-01-15T10:30:00.000Z

Responses

200

Request updated

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Request not found

application/json

500

Internal Server Error

application/json

patch

/v2/catalog/versions/{versionId}/requests/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "req_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "description": "Request body for creating a new user.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Request description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "headers": {},
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "examples": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "req_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "description": "Request body for creating a new user.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Request description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "headers": {},
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "examples": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

List Requests

get

List all Requests items.

Request is an operation request body definition including MIME type, payload shape, headers, and examples.

Authorizations

projectApiKeypersonalAccessToken

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 Requests

application/json

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

HTTPcURLJavaScriptPython

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

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

Create Request

post

Create a new Request item.

Request is an operation request body definition including MIME type, payload shape, headers, and examples.

Authorizations

projectApiKeypersonalAccessToken

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

application/json

Request is an operation request body definition including MIME type, payload shape, headers, and examples.

idstring · min: 30 · max: 30Optional

Object ID with prefix "req_"

Default: req_agob4v2per3ujmlkjo2xyydeimExample: req_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Required

Object ID with prefix "op_"

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

descriptionstringOptional

Markdown description of the request.

Example: Request body for creating a new user.

descriptionBlocksany ofOptional

Request description in ProseMirror JSON.

Example: {"type":"paragraph","content":[{"type":"text","text":"Request description in rich text format."}]}

or

contentMediaTypeany ofOptional

MIME type of the request body (for example, application/json); null means the request has no body.

Example: application/json

stringOptional

or

nullOptional

schemaany ofOptional

Structured shape of the request payload (types, required fields, constraints).

Example: {"type":"object","properties":{}}

or

or

or

or

or

or

or

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-02-02T12:32:44.324ZExample: 2024-01-15T10:30:00.000Z

Responses

201

Request created

application/json

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

HTTPcURLJavaScriptPython

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

{
  "id": "req_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "description": "Request body for creating a new user.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Request description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "headers": {},
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "examples": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "req_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "description": "Request body for creating a new user.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Request description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "headers": {},
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "examples": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Get Request

get

Get a Request item by its id.

Request is an operation request body definition including MIME type, payload shape, headers, and examples.

Authorizations

projectApiKeypersonalAccessToken

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

Request identifier

Example: req_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

200

Request details

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Request not found

application/json

500

Internal Server Error

application/json

get

/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/requests/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "req_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "description": "Request body for creating a new user.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Request description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "headers": {},
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "examples": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Replace Request

post

Completely replaces a Request item by its id.

Request is an operation request body definition including MIME type, payload shape, headers, and examples.

Authorizations

projectApiKeypersonalAccessToken

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

Request identifier

Example: req_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

application/json

Request is an operation request body definition including MIME type, payload shape, headers, and examples.

idstring · min: 30 · max: 30Optional

Object ID with prefix "req_"

Default: req_agob4v2per3ujmlkjo2xyydeimExample: req_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Required

Object ID with prefix "op_"

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

descriptionstringOptional

Markdown description of the request.

Example: Request body for creating a new user.

descriptionBlocksany ofOptional

Request description in ProseMirror JSON.

Example: {"type":"paragraph","content":[{"type":"text","text":"Request description in rich text format."}]}

or

contentMediaTypeany ofOptional

MIME type of the request body (for example, application/json); null means the request has no body.

Example: application/json

stringOptional

or

nullOptional

schemaany ofOptional

Structured shape of the request payload (types, required fields, constraints).

Example: {"type":"object","properties":{}}

or

or

or

or

or

or

or

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-02-02T12:32:44.324ZExample: 2024-01-15T10:30:00.000Z

Responses

200

Request replaced

application/json

201

Request created

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Request not found

application/json

500

Internal Server Error

application/json

post

/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/requests/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "req_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "description": "Request body for creating a new user.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Request description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "headers": {},
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "examples": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "req_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "description": "Request body for creating a new user.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Request description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "headers": {},
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "examples": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Delete Request

delete

Delete a Request item by its id.

Request is an operation request body definition including MIME type, payload shape, headers, and examples.

Authorizations

projectApiKeypersonalAccessToken

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

Request identifier

Example: req_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

204

Request deleted

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Request not found

application/json

500

Internal Server Error

application/json

delete

/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/requests/{id}

HTTPcURLJavaScriptPython

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

No content

Update Request

patch

Partially updates a Request item by its id.

Request is an operation request body definition including MIME type, payload shape, headers, and examples.

Authorizations

projectApiKeypersonalAccessToken

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

Request identifier

Example: req_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

application/json

idstring · min: 30 · max: 30Optional

Object ID with prefix "req_"

Default: req_agob4v2per3ujmlkln23lqmz3yExample: req_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Optional

Object ID with prefix "op_"

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

descriptionstringOptional

Markdown description of the request.

Example: Request body for creating a new user.

descriptionBlocksany ofOptional

Request description in ProseMirror JSON.

Example: {"type":"paragraph","content":[{"type":"text","text":"Request description in rich text format."}]}

or

contentMediaTypeany ofOptional

MIME type of the request body (for example, application/json); null means the request has no body.

Example: application/json

stringOptional

or

nullOptional

schemaany ofOptional

Structured shape of the request payload (types, required fields, constraints).

Example: {"type":"object","properties":{}}

or

or

or

or

or

or

or

versionIdstring · min: 30 · max: 30Optional

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

updatedAtstring · nullableOptionalDefault: 2026-02-02T12:32:44.324ZExample: 2024-01-15T10:30:00.000Z

Responses

200

Request updated

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Request not found

application/json

500

Internal Server Error

application/json

patch

/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/requests/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "req_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "description": "Request body for creating a new user.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Request description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "headers": {},
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "examples": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "req_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "description": "Request body for creating a new user.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Request description in rich text format."
      }
    ]
  },
  "contentMediaType": "application/json",
  "headers": {},
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "examples": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}