Resources

List Resources

get

List all Resources items.

Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.

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 Resources

application/json

Resources 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}/resources

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

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

Create Resource

post

Create a new Resource item.

Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.

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

Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.

idstring · min: 30 · max: 30Optional

Object ID with prefix "rsc_"

Default: rsc_agqumsqmzryetpiazuyt4yablmExample: rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringOptional

Resource name, typically the same key used when the schema is referenced in API definitions.

Default: ""Example: User

descriptionstringOptional

Description of what this reusable schema represents (markdown).

Example: User object schema with id, name, and email fields.

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

schemaany ofRequired

Structured schema describing the reusable object shape.

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

or

or

or

or

or

or

or

createdAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z

updatedAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z

Responses

201

Resource created

application/json

Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.

idstring · min: 30 · max: 30Optional

Object ID with prefix "rsc_"

Default: rsc_agqumsqmzryetpiazuyt4yablmExample: rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringOptional

Resource name, typically the same key used when the schema is referenced in API definitions.

Default: ""Example: User

descriptionstringOptional

Description of what this reusable schema represents (markdown).

Example: User object schema with id, name, and email fields.

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

schemaany ofRequired

Structured schema describing the reusable object shape.

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

or

or

or

or

or

or

or

createdAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z

updatedAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 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}/resources

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

{
  "id": "rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "User",
  "description": "User object schema with id, name, and email fields.",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "Schema documentation"
  },
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "User",
  "description": "User object schema with id, name, and email fields.",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "Schema documentation"
  },
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Get Resource

get

Get a Resource item by its id.

Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.

Authorizations

AuthorizationstringRequired

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

Path parameters

versionIdstring · min: 30 · max: 30Required

Catalog version identifier

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

idstring · min: 30 · max: 30Required

Resource identifier

Example: rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

200

Resource details

application/json

Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.

idstring · min: 30 · max: 30Optional

Object ID with prefix "rsc_"

Default: rsc_agqumsqmzryetpiazuyt4yablmExample: rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringOptional

Resource name, typically the same key used when the schema is referenced in API definitions.

Default: ""Example: User

descriptionstringOptional

Description of what this reusable schema represents (markdown).

Example: User object schema with id, name, and email fields.

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

schemaany ofRequired

Structured schema describing the reusable object shape.

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

or

or

or

or

or

or

or

createdAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z

updatedAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Resource not found

application/json

500

Internal Server Error

application/json

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

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

{
  "id": "rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "User",
  "description": "User object schema with id, name, and email fields.",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "Schema documentation"
  },
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Replace Resource

post

Completely replaces a Resource item by its id.

Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.

Authorizations

AuthorizationstringRequired

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

Path parameters

versionIdstring · min: 30 · max: 30Required

Catalog version identifier

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

idstring · min: 30 · max: 30Required

Resource identifier

Example: rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.

idstring · min: 30 · max: 30Optional

Object ID with prefix "rsc_"

Default: rsc_agqumsqmzryetpiazuyt4yablmExample: rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringOptional

Resource name, typically the same key used when the schema is referenced in API definitions.

Default: ""Example: User

descriptionstringOptional

Description of what this reusable schema represents (markdown).

Example: User object schema with id, name, and email fields.

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

schemaany ofRequired

Structured schema describing the reusable object shape.

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

or

or

or

or

or

or

or

createdAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z

updatedAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z

Responses

200

Resource replaced

application/json

Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.

idstring · min: 30 · max: 30Optional

Object ID with prefix "rsc_"

Default: rsc_agqumsqmzryetpiazuyt4yablmExample: rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringOptional

Resource name, typically the same key used when the schema is referenced in API definitions.

Default: ""Example: User

descriptionstringOptional

Description of what this reusable schema represents (markdown).

Example: User object schema with id, name, and email fields.

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

schemaany ofRequired

Structured schema describing the reusable object shape.

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

or

or

or

or

or

or

or

createdAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z

updatedAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z

201

Resource created

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Resource not found

application/json

500

Internal Server Error

application/json

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

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

{
  "id": "rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "User",
  "description": "User object schema with id, name, and email fields.",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "Schema documentation"
  },
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "User",
  "description": "User object schema with id, name, and email fields.",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "Schema documentation"
  },
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Delete Resource

delete

Delete a Resource item by its id.

Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.

Authorizations

AuthorizationstringRequired

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

Path parameters

versionIdstring · min: 30 · max: 30Required

Catalog version identifier

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

idstring · min: 30 · max: 30Required

Resource identifier

Example: rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

204

Resource deleted

No content

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Resource not found

application/json

500

Internal Server Error

application/json

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

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

No content

Update Resource

patch

Partially updates a Resource item by its id.

Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.

Authorizations

AuthorizationstringRequired

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

Path parameters

versionIdstring · min: 30 · max: 30Required

Catalog version identifier

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

idstring · min: 30 · max: 30Required

Resource identifier

Example: rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

idstring · min: 30 · max: 30Optional

Object ID with prefix "rsc_"

Default: rsc_agqumsqmzryetpia2sui7ellyqExample: rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringOptional

Resource name, typically the same key used when the schema is referenced in API definitions.

Default: ""Example: User

descriptionstringOptional

Description of what this reusable schema represents (markdown).

Example: User object schema with id, name, and email fields.

versionIdstring · min: 30 · max: 30Optional

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

schemaany ofOptional

Structured schema describing the reusable object shape.

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

or

or

or

or

or

or

or

createdAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z

updatedAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z

Responses

200

Resource updated

application/json

Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.

idstring · min: 30 · max: 30Optional

Object ID with prefix "rsc_"

Default: rsc_agqumsqmzryetpiazuyt4yablmExample: rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringOptional

Resource name, typically the same key used when the schema is referenced in API definitions.

Default: ""Example: User

descriptionstringOptional

Description of what this reusable schema represents (markdown).

Example: User object schema with id, name, and email fields.

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

schemaany ofRequired

Structured schema describing the reusable object shape.

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

or

or

or

or

or

or

or

createdAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z

updatedAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Resource not found

application/json

500

Internal Server Error

application/json

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

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

{
  "id": "rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "User",
  "description": "User object schema with id, name, and email fields.",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "Schema documentation"
  },
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "User",
  "description": "User object schema with id, name, and email fields.",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "Schema documentation"
  },
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

List Resources

get

List all Resources items.

Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.

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 Resources

application/json

Resources 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}/resources

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

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

Create Resource

post

Create a new Resource item.

Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.

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

Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.

idstring · min: 30 · max: 30Optional

Object ID with prefix "rsc_"

Default: rsc_agqumsqmzryetpiazuyt4yablmExample: rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringOptional

Resource name, typically the same key used when the schema is referenced in API definitions.

Default: ""Example: User

descriptionstringOptional

Description of what this reusable schema represents (markdown).

Example: User object schema with id, name, and email fields.

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

schemaany ofRequired

Structured schema describing the reusable object shape.

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

or

or

or

or

or

or

or

createdAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z

updatedAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z

Responses

201

Resource created

application/json

Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.

idstring · min: 30 · max: 30Optional

Object ID with prefix "rsc_"

Default: rsc_agqumsqmzryetpiazuyt4yablmExample: rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringOptional

Resource name, typically the same key used when the schema is referenced in API definitions.

Default: ""Example: User

descriptionstringOptional

Description of what this reusable schema represents (markdown).

Example: User object schema with id, name, and email fields.

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

schemaany ofRequired

Structured schema describing the reusable object shape.

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

or

or

or

or

or

or

or

createdAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z

updatedAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 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}/resources

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

{
  "id": "rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "User",
  "description": "User object schema with id, name, and email fields.",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "Schema documentation"
  },
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "User",
  "description": "User object schema with id, name, and email fields.",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "Schema documentation"
  },
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Get Resource

get

Get a Resource item by its id.

Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.

Authorizations

AuthorizationstringRequired

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

Path parameters

projectRefany ofRequired

Project slug or project id (proj_*)

string · min: 31 · max: 31Optional

Object ID with prefix "proj_"

Example: proj_c4x6k3w8j7n9b1z5s2t4m8q0ve

or

string · min: 1Optional

versionTypestring · enumRequired

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

Example: branchPossible values:

versionSlugstring · min: 1Required

Version slug

Example: main

idstring · min: 30 · max: 30Required

Resource identifier

Example: rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

200

Resource details

application/json

Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.

idstring · min: 30 · max: 30Optional

Object ID with prefix "rsc_"

Default: rsc_agqumsqmzryetpiazuyt4yablmExample: rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringOptional

Resource name, typically the same key used when the schema is referenced in API definitions.

Default: ""Example: User

descriptionstringOptional

Description of what this reusable schema represents (markdown).

Example: User object schema with id, name, and email fields.

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

schemaany ofRequired

Structured schema describing the reusable object shape.

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

or

or

or

or

or

or

or

createdAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z

updatedAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Resource not found

application/json

500

Internal Server Error

application/json

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

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

{
  "id": "rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "User",
  "description": "User object schema with id, name, and email fields.",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "Schema documentation"
  },
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Replace Resource

post

Completely replaces a Resource item by its id.

Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.

Authorizations

AuthorizationstringRequired

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

Path parameters

projectRefany ofRequired

Project slug or project id (proj_*)

string · min: 31 · max: 31Optional

Object ID with prefix "proj_"

Example: proj_c4x6k3w8j7n9b1z5s2t4m8q0ve

or

string · min: 1Optional

versionTypestring · enumRequired

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

Example: branchPossible values:

versionSlugstring · min: 1Required

Version slug

Example: main

idstring · min: 30 · max: 30Required

Resource identifier

Example: rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.

idstring · min: 30 · max: 30Optional

Object ID with prefix "rsc_"

Default: rsc_agqumsqmzryetpiazuyt4yablmExample: rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringOptional

Resource name, typically the same key used when the schema is referenced in API definitions.

Default: ""Example: User

descriptionstringOptional

Description of what this reusable schema represents (markdown).

Example: User object schema with id, name, and email fields.

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

schemaany ofRequired

Structured schema describing the reusable object shape.

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

or

or

or

or

or

or

or

createdAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z

updatedAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z

Responses

200

Resource replaced

application/json

Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.

idstring · min: 30 · max: 30Optional

Object ID with prefix "rsc_"

Default: rsc_agqumsqmzryetpiazuyt4yablmExample: rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringOptional

Resource name, typically the same key used when the schema is referenced in API definitions.

Default: ""Example: User

descriptionstringOptional

Description of what this reusable schema represents (markdown).

Example: User object schema with id, name, and email fields.

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

schemaany ofRequired

Structured schema describing the reusable object shape.

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

or

or

or

or

or

or

or

createdAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z

updatedAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z

201

Resource created

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Resource not found

application/json

500

Internal Server Error

application/json

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

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

{
  "id": "rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "User",
  "description": "User object schema with id, name, and email fields.",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "Schema documentation"
  },
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "User",
  "description": "User object schema with id, name, and email fields.",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "Schema documentation"
  },
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Delete Resource

delete

Delete a Resource item by its id.

Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.

Authorizations

AuthorizationstringRequired

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

Path parameters

projectRefany ofRequired

Project slug or project id (proj_*)

string · min: 31 · max: 31Optional

Object ID with prefix "proj_"

Example: proj_c4x6k3w8j7n9b1z5s2t4m8q0ve

or

string · min: 1Optional

versionTypestring · enumRequired

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

Example: branchPossible values:

versionSlugstring · min: 1Required

Version slug

Example: main

idstring · min: 30 · max: 30Required

Resource identifier

Example: rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

204

Resource deleted

No content

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Resource not found

application/json

500

Internal Server Error

application/json

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

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

No content

Update Resource

patch

Partially updates a Resource item by its id.

Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.

Authorizations

AuthorizationstringRequired

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

Path parameters

projectRefany ofRequired

Project slug or project id (proj_*)

string · min: 31 · max: 31Optional

Object ID with prefix "proj_"

Example: proj_c4x6k3w8j7n9b1z5s2t4m8q0ve

or

string · min: 1Optional

versionTypestring · enumRequired

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

Example: branchPossible values:

versionSlugstring · min: 1Required

Version slug

Example: main

idstring · min: 30 · max: 30Required

Resource identifier

Example: rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

idstring · min: 30 · max: 30Optional

Object ID with prefix "rsc_"

Default: rsc_agqumsqmzryetpia33dt5ldlwyExample: rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringOptional

Resource name, typically the same key used when the schema is referenced in API definitions.

Default: ""Example: User

descriptionstringOptional

Description of what this reusable schema represents (markdown).

Example: User object schema with id, name, and email fields.

versionIdstring · min: 30 · max: 30Optional

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

schemaany ofOptional

Structured schema describing the reusable object shape.

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

or

or

or

or

or

or

or

createdAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z

updatedAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z

Responses

200

Resource updated

application/json

Resource is a reusable object schema that can be referenced by requests, responses, and parameters. Resource is also known as an Entity or Object Schema.

idstring · min: 30 · max: 30Optional

Object ID with prefix "rsc_"

Default: rsc_agqumsqmzryetpiazuyt4yablmExample: rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve

namestringOptional

Resource name, typically the same key used when the schema is referenced in API definitions.

Default: ""Example: User

descriptionstringOptional

Description of what this reusable schema represents (markdown).

Example: User object schema with id, name, and email fields.

versionIdstring · min: 30 · max: 30Required

Object ID with prefix "ver_"

Example: ver_c4x6k3w8j7n9b1z5s2t4m8q0ve

schemaany ofRequired

Structured schema describing the reusable object shape.

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

or

or

or

or

or

or

or

createdAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z

updatedAtstring · nullableOptionalDefault: 2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Resource not found

application/json

500

Internal Server Error

application/json

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

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

{
  "id": "rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "User",
  "description": "User object schema with id, name, and email fields.",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "Schema documentation"
  },
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "rsc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "name": "User",
  "description": "User object schema with id, name, and email fields.",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "schema": {
    "type": "object",
    "properties": {}
  },
  "kvStorage": {},
  "externalDocs": {
    "url": "https://example.com/docs",
    "description": "Schema documentation"
  },
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}