Paths

List Paths

get

List all Paths items.

Path is an API path entry representing a templated URL segment and any metadata shared by its operations.

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 Paths

application/json

Paths 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}/paths

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

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

Create Path

post

Create a new Path item.

Path is an API path entry representing a templated URL segment and any metadata shared by its operations.

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

Path is an API path entry representing a templated URL segment and any metadata shared by its operations.

idstring · min: 31 · max: 31Optional

Object ID with prefix "path_"

Default: path_agqkbwfj3n3bzeizgittryq7fuExample: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

serviceIdstring · min: 30 · max: 30Required

Object ID with prefix "svc_"

Example: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve

pathstringRequired

Concrete API path template (must start with a forward slash).

Example: /users/{userId}

summarystringOptional

Short summary of the path across its operations.

Example: User management endpoints

descriptionstringOptional

Long-form description of the path shared across operations (markdown).

Example: Operations for managing user resources.

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

Path created

application/json

Path is an API path entry representing a templated URL segment and any metadata shared by its operations.

idstring · min: 31 · max: 31Optional

Object ID with prefix "path_"

Default: path_agqkbwfj3n3bzeizgittryq7fuExample: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

serviceIdstring · min: 30 · max: 30Required

Object ID with prefix "svc_"

Example: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve

pathstringRequired

Concrete API path template (must start with a forward slash).

Example: /users/{userId}

summarystringOptional

Short summary of the path across its operations.

Example: User management endpoints

descriptionstringOptional

Long-form description of the path shared across operations (markdown).

Example: Operations for managing user resources.

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

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

{
  "id": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "path": "/users/{userId}",
  "summary": "User management endpoints",
  "description": "Operations for managing user resources.",
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "path": "/users/{userId}",
  "summary": "User management endpoints",
  "description": "Operations for managing user resources.",
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Get Path

get

Get a Path item by its id.

Path is an API path entry representing a templated URL segment and any metadata shared by its operations.

Authorizations

AuthorizationstringRequired

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

Path parameters

versionIdstring · min: 30 · max: 30Required

Catalog version identifier

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

idstring · min: 31 · max: 31Required

Path identifier

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

200

Path details

application/json

Path is an API path entry representing a templated URL segment and any metadata shared by its operations.

idstring · min: 31 · max: 31Optional

Object ID with prefix "path_"

Default: path_agqkbwfj3n3bzeizgittryq7fuExample: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

serviceIdstring · min: 30 · max: 30Required

Object ID with prefix "svc_"

Example: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve

pathstringRequired

Concrete API path template (must start with a forward slash).

Example: /users/{userId}

summarystringOptional

Short summary of the path across its operations.

Example: User management endpoints

descriptionstringOptional

Long-form description of the path shared across operations (markdown).

Example: Operations for managing user resources.

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

Path not found

application/json

500

Internal Server Error

application/json

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

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

{
  "id": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "path": "/users/{userId}",
  "summary": "User management endpoints",
  "description": "Operations for managing user resources.",
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Replace Path

post

Completely replaces a Path item by its id.

Path is an API path entry representing a templated URL segment and any metadata shared by its operations.

Authorizations

AuthorizationstringRequired

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

Path parameters

versionIdstring · min: 30 · max: 30Required

Catalog version identifier

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

idstring · min: 31 · max: 31Required

Path identifier

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

Path is an API path entry representing a templated URL segment and any metadata shared by its operations.

idstring · min: 31 · max: 31Optional

Object ID with prefix "path_"

Default: path_agqkbwfj3n3bzeizgittryq7fuExample: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

serviceIdstring · min: 30 · max: 30Required

Object ID with prefix "svc_"

Example: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve

pathstringRequired

Concrete API path template (must start with a forward slash).

Example: /users/{userId}

summarystringOptional

Short summary of the path across its operations.

Example: User management endpoints

descriptionstringOptional

Long-form description of the path shared across operations (markdown).

Example: Operations for managing user resources.

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

Path replaced

application/json

Path is an API path entry representing a templated URL segment and any metadata shared by its operations.

idstring · min: 31 · max: 31Optional

Object ID with prefix "path_"

Default: path_agqkbwfj3n3bzeizgittryq7fuExample: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

serviceIdstring · min: 30 · max: 30Required

Object ID with prefix "svc_"

Example: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve

pathstringRequired

Concrete API path template (must start with a forward slash).

Example: /users/{userId}

summarystringOptional

Short summary of the path across its operations.

Example: User management endpoints

descriptionstringOptional

Long-form description of the path shared across operations (markdown).

Example: Operations for managing user resources.

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

Path created

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Path not found

application/json

500

Internal Server Error

application/json

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

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

{
  "id": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "path": "/users/{userId}",
  "summary": "User management endpoints",
  "description": "Operations for managing user resources.",
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "path": "/users/{userId}",
  "summary": "User management endpoints",
  "description": "Operations for managing user resources.",
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Delete Path

delete

Delete a Path item by its id.

Path is an API path entry representing a templated URL segment and any metadata shared by its operations.

Authorizations

AuthorizationstringRequired

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

Path parameters

versionIdstring · min: 30 · max: 30Required

Catalog version identifier

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

idstring · min: 31 · max: 31Required

Path identifier

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

204

Path deleted

No content

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Path not found

application/json

500

Internal Server Error

application/json

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

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

No content

Update Path

patch

Partially updates a Path item by its id.

Path is an API path entry representing a templated URL segment and any metadata shared by its operations.

Authorizations

AuthorizationstringRequired

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

Path parameters

versionIdstring · min: 30 · max: 30Required

Catalog version identifier

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

idstring · min: 31 · max: 31Required

Path identifier

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

idstring · min: 31 · max: 31Optional

Object ID with prefix "path_"

Default: path_agqkbwfj3n3bzeizhftdfd5cv4Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

serviceIdstring · min: 30 · max: 30Optional

Object ID with prefix "svc_"

Example: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve

pathstringOptional

Concrete API path template (must start with a forward slash).

Example: /users/{userId}

summarystringOptional

Short summary of the path across its operations.

Example: User management endpoints

descriptionstringOptional

Long-form description of the path shared across operations (markdown).

Example: Operations for managing user resources.

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

Path updated

application/json

Path is an API path entry representing a templated URL segment and any metadata shared by its operations.

idstring · min: 31 · max: 31Optional

Object ID with prefix "path_"

Default: path_agqkbwfj3n3bzeizgittryq7fuExample: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

serviceIdstring · min: 30 · max: 30Required

Object ID with prefix "svc_"

Example: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve

pathstringRequired

Concrete API path template (must start with a forward slash).

Example: /users/{userId}

summarystringOptional

Short summary of the path across its operations.

Example: User management endpoints

descriptionstringOptional

Long-form description of the path shared across operations (markdown).

Example: Operations for managing user resources.

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

Path not found

application/json

500

Internal Server Error

application/json

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

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

{
  "id": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "path": "/users/{userId}",
  "summary": "User management endpoints",
  "description": "Operations for managing user resources.",
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "path": "/users/{userId}",
  "summary": "User management endpoints",
  "description": "Operations for managing user resources.",
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

List Paths

get

List all Paths items.

Path is an API path entry representing a templated URL segment and any metadata shared by its operations.

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 Paths

application/json

Paths 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}/paths

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

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

Create Path

post

Create a new Path item.

Path is an API path entry representing a templated URL segment and any metadata shared by its operations.

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

Path is an API path entry representing a templated URL segment and any metadata shared by its operations.

idstring · min: 31 · max: 31Optional

Object ID with prefix "path_"

Default: path_agqkbwfj3n3bzeizgittryq7fuExample: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

serviceIdstring · min: 30 · max: 30Required

Object ID with prefix "svc_"

Example: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve

pathstringRequired

Concrete API path template (must start with a forward slash).

Example: /users/{userId}

summarystringOptional

Short summary of the path across its operations.

Example: User management endpoints

descriptionstringOptional

Long-form description of the path shared across operations (markdown).

Example: Operations for managing user resources.

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

Path created

application/json

Path is an API path entry representing a templated URL segment and any metadata shared by its operations.

idstring · min: 31 · max: 31Optional

Object ID with prefix "path_"

Default: path_agqkbwfj3n3bzeizgittryq7fuExample: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

serviceIdstring · min: 30 · max: 30Required

Object ID with prefix "svc_"

Example: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve

pathstringRequired

Concrete API path template (must start with a forward slash).

Example: /users/{userId}

summarystringOptional

Short summary of the path across its operations.

Example: User management endpoints

descriptionstringOptional

Long-form description of the path shared across operations (markdown).

Example: Operations for managing user resources.

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

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

{
  "id": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "path": "/users/{userId}",
  "summary": "User management endpoints",
  "description": "Operations for managing user resources.",
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "path": "/users/{userId}",
  "summary": "User management endpoints",
  "description": "Operations for managing user resources.",
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Get Path

get

Get a Path item by its id.

Path is an API path entry representing a templated URL segment and any metadata shared by its operations.

Authorizations

AuthorizationstringRequired

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

Path parameters

projectRefany ofRequired

Project slug or project id (proj_*)

string · min: 31 · max: 31Optional

Object ID with prefix "proj_"

Example: proj_c4x6k3w8j7n9b1z5s2t4m8q0ve

or

string · min: 1Optional

versionTypestring · enumRequired

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

Example: branchPossible values:

versionSlugstring · min: 1Required

Version slug

Example: main

idstring · min: 31 · max: 31Required

Path identifier

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

200

Path details

application/json

Path is an API path entry representing a templated URL segment and any metadata shared by its operations.

idstring · min: 31 · max: 31Optional

Object ID with prefix "path_"

Default: path_agqkbwfj3n3bzeizgittryq7fuExample: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

serviceIdstring · min: 30 · max: 30Required

Object ID with prefix "svc_"

Example: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve

pathstringRequired

Concrete API path template (must start with a forward slash).

Example: /users/{userId}

summarystringOptional

Short summary of the path across its operations.

Example: User management endpoints

descriptionstringOptional

Long-form description of the path shared across operations (markdown).

Example: Operations for managing user resources.

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

Path not found

application/json

500

Internal Server Error

application/json

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

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

{
  "id": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "path": "/users/{userId}",
  "summary": "User management endpoints",
  "description": "Operations for managing user resources.",
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Replace Path

post

Completely replaces a Path item by its id.

Path is an API path entry representing a templated URL segment and any metadata shared by its operations.

Authorizations

AuthorizationstringRequired

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

Path parameters

projectRefany ofRequired

Project slug or project id (proj_*)

string · min: 31 · max: 31Optional

Object ID with prefix "proj_"

Example: proj_c4x6k3w8j7n9b1z5s2t4m8q0ve

or

string · min: 1Optional

versionTypestring · enumRequired

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

Example: branchPossible values:

versionSlugstring · min: 1Required

Version slug

Example: main

idstring · min: 31 · max: 31Required

Path identifier

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

Path is an API path entry representing a templated URL segment and any metadata shared by its operations.

idstring · min: 31 · max: 31Optional

Object ID with prefix "path_"

Default: path_agqkbwfj3n3bzeizgittryq7fuExample: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

serviceIdstring · min: 30 · max: 30Required

Object ID with prefix "svc_"

Example: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve

pathstringRequired

Concrete API path template (must start with a forward slash).

Example: /users/{userId}

summarystringOptional

Short summary of the path across its operations.

Example: User management endpoints

descriptionstringOptional

Long-form description of the path shared across operations (markdown).

Example: Operations for managing user resources.

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

Path replaced

application/json

Path is an API path entry representing a templated URL segment and any metadata shared by its operations.

idstring · min: 31 · max: 31Optional

Object ID with prefix "path_"

Default: path_agqkbwfj3n3bzeizgittryq7fuExample: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

serviceIdstring · min: 30 · max: 30Required

Object ID with prefix "svc_"

Example: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve

pathstringRequired

Concrete API path template (must start with a forward slash).

Example: /users/{userId}

summarystringOptional

Short summary of the path across its operations.

Example: User management endpoints

descriptionstringOptional

Long-form description of the path shared across operations (markdown).

Example: Operations for managing user resources.

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

Path created

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Path not found

application/json

500

Internal Server Error

application/json

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

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

{
  "id": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "path": "/users/{userId}",
  "summary": "User management endpoints",
  "description": "Operations for managing user resources.",
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "path": "/users/{userId}",
  "summary": "User management endpoints",
  "description": "Operations for managing user resources.",
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Delete Path

delete

Delete a Path item by its id.

Path is an API path entry representing a templated URL segment and any metadata shared by its operations.

Authorizations

AuthorizationstringRequired

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

Path parameters

projectRefany ofRequired

Project slug or project id (proj_*)

string · min: 31 · max: 31Optional

Object ID with prefix "proj_"

Example: proj_c4x6k3w8j7n9b1z5s2t4m8q0ve

or

string · min: 1Optional

versionTypestring · enumRequired

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

Example: branchPossible values:

versionSlugstring · min: 1Required

Version slug

Example: main

idstring · min: 31 · max: 31Required

Path identifier

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

204

Path deleted

No content

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Path not found

application/json

500

Internal Server Error

application/json

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

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

No content

Update Path

patch

Partially updates a Path item by its id.

Path is an API path entry representing a templated URL segment and any metadata shared by its operations.

Authorizations

AuthorizationstringRequired

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

Path parameters

projectRefany ofRequired

Project slug or project id (proj_*)

string · min: 31 · max: 31Optional

Object ID with prefix "proj_"

Example: proj_c4x6k3w8j7n9b1z5s2t4m8q0ve

or

string · min: 1Optional

versionTypestring · enumRequired

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

Example: branchPossible values:

versionSlugstring · min: 1Required

Version slug

Example: main

idstring · min: 31 · max: 31Required

Path identifier

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

idstring · min: 31 · max: 31Optional

Object ID with prefix "path_"

Default: path_agqkbwfj3n3bzeizia5zfk6l2mExample: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

serviceIdstring · min: 30 · max: 30Optional

Object ID with prefix "svc_"

Example: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve

pathstringOptional

Concrete API path template (must start with a forward slash).

Example: /users/{userId}

summarystringOptional

Short summary of the path across its operations.

Example: User management endpoints

descriptionstringOptional

Long-form description of the path shared across operations (markdown).

Example: Operations for managing user resources.

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

Path updated

application/json

Path is an API path entry representing a templated URL segment and any metadata shared by its operations.

idstring · min: 31 · max: 31Optional

Object ID with prefix "path_"

Default: path_agqkbwfj3n3bzeizgittryq7fuExample: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

serviceIdstring · min: 30 · max: 30Required

Object ID with prefix "svc_"

Example: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve

pathstringRequired

Concrete API path template (must start with a forward slash).

Example: /users/{userId}

summarystringOptional

Short summary of the path across its operations.

Example: User management endpoints

descriptionstringOptional

Long-form description of the path shared across operations (markdown).

Example: Operations for managing user resources.

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

Path not found

application/json

500

Internal Server Error

application/json

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

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

{
  "id": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "path": "/users/{userId}",
  "summary": "User management endpoints",
  "description": "Operations for managing user resources.",
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "path": "/users/{userId}",
  "summary": "User management endpoints",
  "description": "Operations for managing user resources.",
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}