Servers | Appear docs

List Servers

get

List all Servers items.

Server is an URL endpoint template attached to a service, path, or operation, including variables when needed.

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 Servers

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

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

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

Create Server

post

Create a new Server item.

Server is an URL endpoint template attached to a service, path, or operation, including variables when needed.

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

Server is an URL endpoint template attached to a service, path, or operation, including variables when needed.

idstring · min: 30 · max: 30Optional

Object ID with prefix "srv_"

Default: srv_agob4v2per3ujmlkpinlwuvii4Example: srv_c4x6k3w8j7n9b1z5s2t4m8q0ve

serviceIdstring · min: 30 · max: 30Optional

Server scoped to a service; cannot be combined with pathId or operationId.

Example: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve

pathIdstring · min: 31 · max: 31Optional

Server scoped to a specific path; cannot be combined with serviceId or operationId.

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Optional

Server scoped to a single operation; cannot be combined with serviceId or pathId.

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

urlstringRequired

Base URL template for calling the API (may include {variable} placeholders).

Example: https://api.example.com/v1

descriptionstringOptional

Markdown description of the server.

Example: Production API server

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

Server 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}/servers

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

{
  "id": "srv_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "url": "https://api.example.com/v1",
  "description": "Production API server",
  "variables": {
    "environment": {
      "default": "production",
      "enum": [
        "production",
        "staging"
      ]
    }
  },
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "srv_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "url": "https://api.example.com/v1",
  "description": "Production API server",
  "variables": {
    "environment": {
      "default": "production",
      "enum": [
        "production",
        "staging"
      ]
    }
  },
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Get Server

get

Get a Server item by its id.

Server is an URL endpoint template attached to a service, path, or operation, including variables when needed.

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

Server identifier

Example: srv_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

200

Server details

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Server not found

application/json

500

Internal Server Error

application/json

get

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

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

{
  "id": "srv_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "url": "https://api.example.com/v1",
  "description": "Production API server",
  "variables": {
    "environment": {
      "default": "production",
      "enum": [
        "production",
        "staging"
      ]
    }
  },
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Replace Server

post

Completely replaces a Server item by its id.

Server is an URL endpoint template attached to a service, path, or operation, including variables when needed.

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

Server identifier

Example: srv_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

Server is an URL endpoint template attached to a service, path, or operation, including variables when needed.

idstring · min: 30 · max: 30Optional

Object ID with prefix "srv_"

Default: srv_agob4v2per3ujmlkpinlwuvii4Example: srv_c4x6k3w8j7n9b1z5s2t4m8q0ve

serviceIdstring · min: 30 · max: 30Optional

Server scoped to a service; cannot be combined with pathId or operationId.

Example: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve

pathIdstring · min: 31 · max: 31Optional

Server scoped to a specific path; cannot be combined with serviceId or operationId.

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Optional

Server scoped to a single operation; cannot be combined with serviceId or pathId.

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

urlstringRequired

Base URL template for calling the API (may include {variable} placeholders).

Example: https://api.example.com/v1

descriptionstringOptional

Markdown description of the server.

Example: Production API server

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

Server replaced

application/json

201

Server created

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Server not found

application/json

500

Internal Server Error

application/json

post

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

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

{
  "id": "srv_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "url": "https://api.example.com/v1",
  "description": "Production API server",
  "variables": {
    "environment": {
      "default": "production",
      "enum": [
        "production",
        "staging"
      ]
    }
  },
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "srv_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "url": "https://api.example.com/v1",
  "description": "Production API server",
  "variables": {
    "environment": {
      "default": "production",
      "enum": [
        "production",
        "staging"
      ]
    }
  },
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Delete Server

delete

Delete a Server item by its id.

Server is an URL endpoint template attached to a service, path, or operation, including variables when needed.

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

Server identifier

Example: srv_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

204

Server deleted

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Server not found

application/json

500

Internal Server Error

application/json

delete

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

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

No content

Update Server

patch

Partially updates a Server item by its id.

Server is an URL endpoint template attached to a service, path, or operation, including variables when needed.

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

Server identifier

Example: srv_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

idstring · min: 30 · max: 30Optional

Object ID with prefix "srv_"

Default: srv_agob4v2per3ujmlkqfixbotv4mExample: srv_c4x6k3w8j7n9b1z5s2t4m8q0ve

serviceIdstring · min: 30 · max: 30Optional

Server scoped to a service; cannot be combined with pathId or operationId.

Example: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve

pathIdstring · min: 31 · max: 31Optional

Server scoped to a specific path; cannot be combined with serviceId or operationId.

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Optional

Server scoped to a single operation; cannot be combined with serviceId or pathId.

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

urlstringOptional

Base URL template for calling the API (may include {variable} placeholders).

Example: https://api.example.com/v1

descriptionstringOptional

Markdown description of the server.

Example: Production API server

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

Server updated

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Server not found

application/json

500

Internal Server Error

application/json

patch

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

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

{
  "id": "srv_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "url": "https://api.example.com/v1",
  "description": "Production API server",
  "variables": {
    "environment": {
      "default": "production",
      "enum": [
        "production",
        "staging"
      ]
    }
  },
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "srv_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "url": "https://api.example.com/v1",
  "description": "Production API server",
  "variables": {
    "environment": {
      "default": "production",
      "enum": [
        "production",
        "staging"
      ]
    }
  },
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

List Servers

get

List all Servers items.

Server is an URL endpoint template attached to a service, path, or operation, including variables when needed.

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 Servers

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

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

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

Create Server

post

Create a new Server item.

Server is an URL endpoint template attached to a service, path, or operation, including variables when needed.

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

Server is an URL endpoint template attached to a service, path, or operation, including variables when needed.

idstring · min: 30 · max: 30Optional

Object ID with prefix "srv_"

Default: srv_agob4v2per3ujmlkpinlwuvii4Example: srv_c4x6k3w8j7n9b1z5s2t4m8q0ve

serviceIdstring · min: 30 · max: 30Optional

Server scoped to a service; cannot be combined with pathId or operationId.

Example: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve

pathIdstring · min: 31 · max: 31Optional

Server scoped to a specific path; cannot be combined with serviceId or operationId.

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Optional

Server scoped to a single operation; cannot be combined with serviceId or pathId.

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

urlstringRequired

Base URL template for calling the API (may include {variable} placeholders).

Example: https://api.example.com/v1

descriptionstringOptional

Markdown description of the server.

Example: Production API server

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

Server 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}/servers

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

{
  "id": "srv_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "url": "https://api.example.com/v1",
  "description": "Production API server",
  "variables": {
    "environment": {
      "default": "production",
      "enum": [
        "production",
        "staging"
      ]
    }
  },
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "srv_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "url": "https://api.example.com/v1",
  "description": "Production API server",
  "variables": {
    "environment": {
      "default": "production",
      "enum": [
        "production",
        "staging"
      ]
    }
  },
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Get Server

get

Get a Server item by its id.

Server is an URL endpoint template attached to a service, path, or operation, including variables when needed.

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

Server identifier

Example: srv_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

200

Server details

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Server not found

application/json

500

Internal Server Error

application/json

get

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

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

{
  "id": "srv_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "url": "https://api.example.com/v1",
  "description": "Production API server",
  "variables": {
    "environment": {
      "default": "production",
      "enum": [
        "production",
        "staging"
      ]
    }
  },
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Replace Server

post

Completely replaces a Server item by its id.

Server is an URL endpoint template attached to a service, path, or operation, including variables when needed.

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

Server identifier

Example: srv_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

Server is an URL endpoint template attached to a service, path, or operation, including variables when needed.

idstring · min: 30 · max: 30Optional

Object ID with prefix "srv_"

Default: srv_agob4v2per3ujmlkpinlwuvii4Example: srv_c4x6k3w8j7n9b1z5s2t4m8q0ve

serviceIdstring · min: 30 · max: 30Optional

Server scoped to a service; cannot be combined with pathId or operationId.

Example: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve

pathIdstring · min: 31 · max: 31Optional

Server scoped to a specific path; cannot be combined with serviceId or operationId.

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Optional

Server scoped to a single operation; cannot be combined with serviceId or pathId.

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

urlstringRequired

Base URL template for calling the API (may include {variable} placeholders).

Example: https://api.example.com/v1

descriptionstringOptional

Markdown description of the server.

Example: Production API server

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

Server replaced

application/json

201

Server created

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Server not found

application/json

500

Internal Server Error

application/json

post

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

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

{
  "id": "srv_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "url": "https://api.example.com/v1",
  "description": "Production API server",
  "variables": {
    "environment": {
      "default": "production",
      "enum": [
        "production",
        "staging"
      ]
    }
  },
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "srv_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "url": "https://api.example.com/v1",
  "description": "Production API server",
  "variables": {
    "environment": {
      "default": "production",
      "enum": [
        "production",
        "staging"
      ]
    }
  },
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Delete Server

delete

Delete a Server item by its id.

Server is an URL endpoint template attached to a service, path, or operation, including variables when needed.

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

Server identifier

Example: srv_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

204

Server deleted

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Server not found

application/json

500

Internal Server Error

application/json

delete

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

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

No content

Update Server

patch

Partially updates a Server item by its id.

Server is an URL endpoint template attached to a service, path, or operation, including variables when needed.

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

Server identifier

Example: srv_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

idstring · min: 30 · max: 30Optional

Object ID with prefix "srv_"

Default: srv_agob4v2per3ujmlkrb65munxsmExample: srv_c4x6k3w8j7n9b1z5s2t4m8q0ve

serviceIdstring · min: 30 · max: 30Optional

Server scoped to a service; cannot be combined with pathId or operationId.

Example: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve

pathIdstring · min: 31 · max: 31Optional

Server scoped to a specific path; cannot be combined with serviceId or operationId.

Example: path_c4x6k3w8j7n9b1z5s2t4m8q0ve

operationIdstring · min: 29 · max: 29Optional

Server scoped to a single operation; cannot be combined with serviceId or pathId.

Example: op_c4x6k3w8j7n9b1z5s2t4m8q0ve

urlstringOptional

Base URL template for calling the API (may include {variable} placeholders).

Example: https://api.example.com/v1

descriptionstringOptional

Markdown description of the server.

Example: Production API server

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

Server updated

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Server not found

application/json

500

Internal Server Error

application/json

patch

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

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

{
  "id": "srv_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "url": "https://api.example.com/v1",
  "description": "Production API server",
  "variables": {
    "environment": {
      "default": "production",
      "enum": [
        "production",
        "staging"
      ]
    }
  },
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "srv_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "serviceId": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "pathId": "path_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "operationId": "op_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "url": "https://api.example.com/v1",
  "description": "Production API server",
  "variables": {
    "environment": {
      "default": "production",
      "enum": [
        "production",
        "staging"
      ]
    }
  },
  "kvStorage": {},
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

hashtagList Servers

hashtagCreate Server

hashtagGet Server

hashtagReplace Server

hashtagDelete Server

hashtagUpdate Server

hashtagList Servers

hashtagCreate Server

hashtagGet Server

hashtagReplace Server

hashtagDelete Server

hashtagUpdate Server

List Servers

Create Server

Get Server

Replace Server

Delete Server

Update Server

List Servers

Create Server

Get Server

Replace Server

Delete Server

Update Server