Operations

List Operations

get

List all Operations items.

Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.

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 Operations

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

HTTPcURLJavaScriptPython

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

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

Create Operation

post

Create a new Operation item.

Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.

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

Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.

idstring · min: 29 · max: 29Optional

Object ID with prefix "op_"

Default: op_agob4v2per3ujmlkdb2ytkqqe4Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

methodstringRequired

HTTP method for the operation (e.g., get, post).

Example: get

pathIdstring · min: 31 · max: 31Required

Object ID with prefix "path_"

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

summarystringOptional

Short summary of the operation.

Example: Get user by ID

descriptionstringOptional

Markdown description of the operation.

Example: Retrieves a user by their unique identifier.

descriptionBlocksany ofOptional

Operation description represented as ProseMirror JSON.

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

or

deprecatedbooleanOptionalDefault: false

operationIdstringRequired

Stable operation identifier mirroring OpenAPI operationId.

Example: get-user-by-id

tagsstring[]Optional

Tags applied to the operation for grouping.

Default: []Example: ["users","authentication"]

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

Operation 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}/operations

HTTPcURLJavaScriptPython

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

{
  "id": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "method": "get",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "summary": "Get user by ID",
  "description": "Retrieves a user by their unique identifier.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Operation description in rich text format."
      }
    ]
  },
  "deprecated": false,
  "operationId": "get-user-by-id",
  "tags": [
    "users",
    "authentication"
  ],
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "API documentation"
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "method": "get",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "summary": "Get user by ID",
  "description": "Retrieves a user by their unique identifier.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Operation description in rich text format."
      }
    ]
  },
  "deprecated": false,
  "operationId": "get-user-by-id",
  "tags": [
    "users",
    "authentication"
  ],
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "API documentation"
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Get Operation

get

Get a Operation item by its id.

Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.

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

Operation identifier

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

200

Operation details

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Operation not found

application/json

500

Internal Server Error

application/json

get

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

HTTPcURLJavaScriptPython

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

{
  "id": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "method": "get",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "summary": "Get user by ID",
  "description": "Retrieves a user by their unique identifier.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Operation description in rich text format."
      }
    ]
  },
  "deprecated": false,
  "operationId": "get-user-by-id",
  "tags": [
    "users",
    "authentication"
  ],
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "API documentation"
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Replace Operation

post

Completely replaces a Operation item by its id.

Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.

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

Operation identifier

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

application/json

Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.

idstring · min: 29 · max: 29Optional

Object ID with prefix "op_"

Default: op_agob4v2per3ujmlkdb2ytkqqe4Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

methodstringRequired

HTTP method for the operation (e.g., get, post).

Example: get

pathIdstring · min: 31 · max: 31Required

Object ID with prefix "path_"

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

summarystringOptional

Short summary of the operation.

Example: Get user by ID

descriptionstringOptional

Markdown description of the operation.

Example: Retrieves a user by their unique identifier.

descriptionBlocksany ofOptional

Operation description represented as ProseMirror JSON.

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

or

deprecatedbooleanOptionalDefault: false

operationIdstringRequired

Stable operation identifier mirroring OpenAPI operationId.

Example: get-user-by-id

tagsstring[]Optional

Tags applied to the operation for grouping.

Default: []Example: ["users","authentication"]

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

Operation replaced

application/json

201

Operation created

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Operation not found

application/json

500

Internal Server Error

application/json

post

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

HTTPcURLJavaScriptPython

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

{
  "id": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "method": "get",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "summary": "Get user by ID",
  "description": "Retrieves a user by their unique identifier.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Operation description in rich text format."
      }
    ]
  },
  "deprecated": false,
  "operationId": "get-user-by-id",
  "tags": [
    "users",
    "authentication"
  ],
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "API documentation"
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "method": "get",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "summary": "Get user by ID",
  "description": "Retrieves a user by their unique identifier.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Operation description in rich text format."
      }
    ]
  },
  "deprecated": false,
  "operationId": "get-user-by-id",
  "tags": [
    "users",
    "authentication"
  ],
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "API documentation"
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Delete Operation

delete

Delete a Operation item by its id.

Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.

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

Operation identifier

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

204

Operation deleted

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Operation not found

application/json

500

Internal Server Error

application/json

delete

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

HTTPcURLJavaScriptPython

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

No content

Update Operation

patch

Partially updates a Operation item by its id.

Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.

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

Operation identifier

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

application/json

idstring · min: 29 · max: 29Optional

Object ID with prefix "op_"

Default: op_agob4v2per3ujmlkejdbawhpseExample: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

methodstringOptional

HTTP method for the operation (e.g., get, post).

Example: get

pathIdstring · min: 31 · max: 31Optional

Object ID with prefix "path_"

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

summarystringOptional

Short summary of the operation.

Example: Get user by ID

descriptionstringOptional

Markdown description of the operation.

Example: Retrieves a user by their unique identifier.

descriptionBlocksany ofOptional

Operation description represented as ProseMirror JSON.

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

or

deprecatedbooleanOptionalDefault: false

operationIdstringOptional

Stable operation identifier mirroring OpenAPI operationId.

Example: get-user-by-id

tagsstring[]Optional

Tags applied to the operation for grouping.

Default: []Example: ["users","authentication"]

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

Operation updated

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Operation not found

application/json

500

Internal Server Error

application/json

patch

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

HTTPcURLJavaScriptPython

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

{
  "id": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "method": "get",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "summary": "Get user by ID",
  "description": "Retrieves a user by their unique identifier.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Operation description in rich text format."
      }
    ]
  },
  "deprecated": false,
  "operationId": "get-user-by-id",
  "tags": [
    "users",
    "authentication"
  ],
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "API documentation"
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "method": "get",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "summary": "Get user by ID",
  "description": "Retrieves a user by their unique identifier.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Operation description in rich text format."
      }
    ]
  },
  "deprecated": false,
  "operationId": "get-user-by-id",
  "tags": [
    "users",
    "authentication"
  ],
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "API documentation"
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

List Operations

get

List all Operations items.

Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.

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 Operations

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

HTTPcURLJavaScriptPython

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

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

Create Operation

post

Create a new Operation item.

Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.

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

Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.

idstring · min: 29 · max: 29Optional

Object ID with prefix "op_"

Default: op_agob4v2per3ujmlkdb2ytkqqe4Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

methodstringRequired

HTTP method for the operation (e.g., get, post).

Example: get

pathIdstring · min: 31 · max: 31Required

Object ID with prefix "path_"

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

summarystringOptional

Short summary of the operation.

Example: Get user by ID

descriptionstringOptional

Markdown description of the operation.

Example: Retrieves a user by their unique identifier.

descriptionBlocksany ofOptional

Operation description represented as ProseMirror JSON.

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

or

deprecatedbooleanOptionalDefault: false

operationIdstringRequired

Stable operation identifier mirroring OpenAPI operationId.

Example: get-user-by-id

tagsstring[]Optional

Tags applied to the operation for grouping.

Default: []Example: ["users","authentication"]

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

Operation 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}/operations

HTTPcURLJavaScriptPython

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

{
  "id": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "method": "get",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "summary": "Get user by ID",
  "description": "Retrieves a user by their unique identifier.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Operation description in rich text format."
      }
    ]
  },
  "deprecated": false,
  "operationId": "get-user-by-id",
  "tags": [
    "users",
    "authentication"
  ],
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "API documentation"
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "method": "get",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "summary": "Get user by ID",
  "description": "Retrieves a user by their unique identifier.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Operation description in rich text format."
      }
    ]
  },
  "deprecated": false,
  "operationId": "get-user-by-id",
  "tags": [
    "users",
    "authentication"
  ],
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "API documentation"
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Get Operation

get

Get a Operation item by its id.

Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.

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

Operation identifier

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

200

Operation details

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Operation not found

application/json

500

Internal Server Error

application/json

get

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

HTTPcURLJavaScriptPython

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

{
  "id": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "method": "get",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "summary": "Get user by ID",
  "description": "Retrieves a user by their unique identifier.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Operation description in rich text format."
      }
    ]
  },
  "deprecated": false,
  "operationId": "get-user-by-id",
  "tags": [
    "users",
    "authentication"
  ],
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "API documentation"
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Replace Operation

post

Completely replaces a Operation item by its id.

Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.

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

Operation identifier

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

application/json

Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.

idstring · min: 29 · max: 29Optional

Object ID with prefix "op_"

Default: op_agob4v2per3ujmlkdb2ytkqqe4Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

methodstringRequired

HTTP method for the operation (e.g., get, post).

Example: get

pathIdstring · min: 31 · max: 31Required

Object ID with prefix "path_"

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

summarystringOptional

Short summary of the operation.

Example: Get user by ID

descriptionstringOptional

Markdown description of the operation.

Example: Retrieves a user by their unique identifier.

descriptionBlocksany ofOptional

Operation description represented as ProseMirror JSON.

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

or

deprecatedbooleanOptionalDefault: false

operationIdstringRequired

Stable operation identifier mirroring OpenAPI operationId.

Example: get-user-by-id

tagsstring[]Optional

Tags applied to the operation for grouping.

Default: []Example: ["users","authentication"]

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

Operation replaced

application/json

201

Operation created

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Operation not found

application/json

500

Internal Server Error

application/json

post

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

HTTPcURLJavaScriptPython

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

{
  "id": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "method": "get",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "summary": "Get user by ID",
  "description": "Retrieves a user by their unique identifier.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Operation description in rich text format."
      }
    ]
  },
  "deprecated": false,
  "operationId": "get-user-by-id",
  "tags": [
    "users",
    "authentication"
  ],
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "API documentation"
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "method": "get",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "summary": "Get user by ID",
  "description": "Retrieves a user by their unique identifier.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Operation description in rich text format."
      }
    ]
  },
  "deprecated": false,
  "operationId": "get-user-by-id",
  "tags": [
    "users",
    "authentication"
  ],
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "API documentation"
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Delete Operation

delete

Delete a Operation item by its id.

Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.

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

Operation identifier

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

204

Operation deleted

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Operation not found

application/json

500

Internal Server Error

application/json

delete

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

HTTPcURLJavaScriptPython

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

No content

Update Operation

patch

Partially updates a Operation item by its id.

Operation is an HTTP operation bound to a path, including documentation, authentication requirements, and optional external docs.

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

Operation identifier

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

application/json

idstring · min: 29 · max: 29Optional

Object ID with prefix "op_"

Default: op_agob4v2per3ujmlkfizsq4uzuuExample: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

methodstringOptional

HTTP method for the operation (e.g., get, post).

Example: get

pathIdstring · min: 31 · max: 31Optional

Object ID with prefix "path_"

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

summarystringOptional

Short summary of the operation.

Example: Get user by ID

descriptionstringOptional

Markdown description of the operation.

Example: Retrieves a user by their unique identifier.

descriptionBlocksany ofOptional

Operation description represented as ProseMirror JSON.

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

or

deprecatedbooleanOptionalDefault: false

operationIdstringOptional

Stable operation identifier mirroring OpenAPI operationId.

Example: get-user-by-id

tagsstring[]Optional

Tags applied to the operation for grouping.

Default: []Example: ["users","authentication"]

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

Operation updated

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Operation not found

application/json

500

Internal Server Error

application/json

patch

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

HTTPcURLJavaScriptPython

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

{
  "id": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "method": "get",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "summary": "Get user by ID",
  "description": "Retrieves a user by their unique identifier.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Operation description in rich text format."
      }
    ]
  },
  "deprecated": false,
  "operationId": "get-user-by-id",
  "tags": [
    "users",
    "authentication"
  ],
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "API documentation"
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "method": "get",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "summary": "Get user by ID",
  "description": "Retrieves a user by their unique identifier.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Operation description in rich text format."
      }
    ]
  },
  "deprecated": false,
  "operationId": "get-user-by-id",
  "tags": [
    "users",
    "authentication"
  ],
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "API documentation"
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}