Security Schemes | Appear docs

List Security Schemes

get

List all Security Schemes items.

SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.

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 Security Schemes

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}/security-schemes

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

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

Create Security Scheme

post

Create a new Security Scheme item.

SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.

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

SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.

idstring · min: 34 · max: 34Optional

Object ID with prefix "sec_sch_"

Default: sec_sch_agob4v2per3ujmlksd54bekdvuExample: sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve

typestring · enumRequired

Kind of authentication mechanism (API key, HTTP auth/bearer, mutual TLS, OAuth 2.0, or OpenID Connect).

Example: httpPossible values:

instring · enumOptional

Location of the API key for apiKey schemes (query, header, or cookie).

Example: headerPossible values:

namestringRequired

Identifier for the security scheme; matches the name used when publishing or importing API definitions.

Example: ApiKeyAuth

descriptionstringOptional

Security scheme description in markdown.

Example: Bearer token authentication using JWT.

descriptionBlocksany ofOptional

Security scheme description in ProseMirror JSON blocks.

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

or

schemestringOptional

HTTP auth scheme label (for example: basic, bearer, digest).

Example: bearer

bearerFormatstringOptional

Optional hint about the bearer token format (for example: JWT).

Example: JWT

flowsanyOptional

OAuth 2.0 flow configuration (e.g., auth code, client credentials) detailing token and authorization URLs.

Example: {"clientCredentials":{"tokenUrl":"https://example.com/oauth/token","scopes":{}}}

openIdConnectUrlstringOptional

OpenID Connect discovery endpoint when type is openIdConnect.

Example: https://example.com/.well-known/openid-configuration

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

Security Scheme 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}/security-schemes

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

{
  "id": "sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "type": "http",
  "in": "header",
  "name": "ApiKeyAuth",
  "description": "Bearer token authentication using JWT.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Security scheme description in rich text format."
      }
    ]
  },
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "flows": {
    "clientCredentials": {
      "tokenUrl": "https://example.com/oauth/token",
      "scopes": {}
    }
  },
  "openIdConnectUrl": "https://example.com/.well-known/openid-configuration",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "type": "http",
  "in": "header",
  "name": "ApiKeyAuth",
  "description": "Bearer token authentication using JWT.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Security scheme description in rich text format."
      }
    ]
  },
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "flows": {
    "clientCredentials": {
      "tokenUrl": "https://example.com/oauth/token",
      "scopes": {}
    }
  },
  "openIdConnectUrl": "https://example.com/.well-known/openid-configuration",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Get Security Scheme

get

Get a Security Scheme item by its id.

SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.

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

Security Scheme identifier

Example: sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

200

Security Scheme details

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Security Scheme not found

application/json

500

Internal Server Error

application/json

get

/v2/catalog/versions/{versionId}/security-schemes/{id}

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

{
  "id": "sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "type": "http",
  "in": "header",
  "name": "ApiKeyAuth",
  "description": "Bearer token authentication using JWT.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Security scheme description in rich text format."
      }
    ]
  },
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "flows": {
    "clientCredentials": {
      "tokenUrl": "https://example.com/oauth/token",
      "scopes": {}
    }
  },
  "openIdConnectUrl": "https://example.com/.well-known/openid-configuration",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Replace Security Scheme

post

Completely replaces a Security Scheme item by its id.

SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.

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

Security Scheme identifier

Example: sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.

idstring · min: 34 · max: 34Optional

Object ID with prefix "sec_sch_"

Default: sec_sch_agob4v2per3ujmlksd54bekdvuExample: sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve

typestring · enumRequired

Kind of authentication mechanism (API key, HTTP auth/bearer, mutual TLS, OAuth 2.0, or OpenID Connect).

Example: httpPossible values:

instring · enumOptional

Location of the API key for apiKey schemes (query, header, or cookie).

Example: headerPossible values:

namestringRequired

Identifier for the security scheme; matches the name used when publishing or importing API definitions.

Example: ApiKeyAuth

descriptionstringOptional

Security scheme description in markdown.

Example: Bearer token authentication using JWT.

descriptionBlocksany ofOptional

Security scheme description in ProseMirror JSON blocks.

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

or

schemestringOptional

HTTP auth scheme label (for example: basic, bearer, digest).

Example: bearer

bearerFormatstringOptional

Optional hint about the bearer token format (for example: JWT).

Example: JWT

flowsanyOptional

OAuth 2.0 flow configuration (e.g., auth code, client credentials) detailing token and authorization URLs.

Example: {"clientCredentials":{"tokenUrl":"https://example.com/oauth/token","scopes":{}}}

openIdConnectUrlstringOptional

OpenID Connect discovery endpoint when type is openIdConnect.

Example: https://example.com/.well-known/openid-configuration

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

Security Scheme replaced

application/json

201

Security Scheme created

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Security Scheme not found

application/json

500

Internal Server Error

application/json

post

/v2/catalog/versions/{versionId}/security-schemes/{id}

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

{
  "id": "sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "type": "http",
  "in": "header",
  "name": "ApiKeyAuth",
  "description": "Bearer token authentication using JWT.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Security scheme description in rich text format."
      }
    ]
  },
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "flows": {
    "clientCredentials": {
      "tokenUrl": "https://example.com/oauth/token",
      "scopes": {}
    }
  },
  "openIdConnectUrl": "https://example.com/.well-known/openid-configuration",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "type": "http",
  "in": "header",
  "name": "ApiKeyAuth",
  "description": "Bearer token authentication using JWT.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Security scheme description in rich text format."
      }
    ]
  },
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "flows": {
    "clientCredentials": {
      "tokenUrl": "https://example.com/oauth/token",
      "scopes": {}
    }
  },
  "openIdConnectUrl": "https://example.com/.well-known/openid-configuration",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Delete Security Scheme

delete

Delete a Security Scheme item by its id.

SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.

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

Security Scheme identifier

Example: sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

204

Security Scheme deleted

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Security Scheme not found

application/json

500

Internal Server Error

application/json

delete

/v2/catalog/versions/{versionId}/security-schemes/{id}

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

No content

Update Security Scheme

patch

Partially updates a Security Scheme item by its id.

SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.

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

Security Scheme identifier

Example: sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

idstring · min: 34 · max: 34Optional

Object ID with prefix "sec_sch_"

Default: sec_sch_agob4v2per3ujmlktcs7cfe3umExample: sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve

typestring · enumOptional

Kind of authentication mechanism (API key, HTTP auth/bearer, mutual TLS, OAuth 2.0, or OpenID Connect).

Example: httpPossible values:

instring,null · enum · nullableOptional

Location of the API key for apiKey schemes (query, header, or cookie).

Example: headerPossible values:

namestringOptional

Identifier for the security scheme; matches the name used when publishing or importing API definitions.

Example: ApiKeyAuth

descriptionstringOptional

Security scheme description in markdown.

Example: Bearer token authentication using JWT.

descriptionBlocksany ofOptional

Security scheme description in ProseMirror JSON blocks.

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

or

schemestringOptional

HTTP auth scheme label (for example: basic, bearer, digest).

Example: bearer

bearerFormatstringOptional

Optional hint about the bearer token format (for example: JWT).

Example: JWT

flowsanyOptional

OAuth 2.0 flow configuration (e.g., auth code, client credentials) detailing token and authorization URLs.

Example: {"clientCredentials":{"tokenUrl":"https://example.com/oauth/token","scopes":{}}}

openIdConnectUrlstringOptional

OpenID Connect discovery endpoint when type is openIdConnect.

Example: https://example.com/.well-known/openid-configuration

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

Security Scheme updated

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Security Scheme not found

application/json

500

Internal Server Error

application/json

patch

/v2/catalog/versions/{versionId}/security-schemes/{id}

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

{
  "id": "sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "type": "http",
  "in": "header",
  "name": "ApiKeyAuth",
  "description": "Bearer token authentication using JWT.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Security scheme description in rich text format."
      }
    ]
  },
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "flows": {
    "clientCredentials": {
      "tokenUrl": "https://example.com/oauth/token",
      "scopes": {}
    }
  },
  "openIdConnectUrl": "https://example.com/.well-known/openid-configuration",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "type": "http",
  "in": "header",
  "name": "ApiKeyAuth",
  "description": "Bearer token authentication using JWT.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Security scheme description in rich text format."
      }
    ]
  },
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "flows": {
    "clientCredentials": {
      "tokenUrl": "https://example.com/oauth/token",
      "scopes": {}
    }
  },
  "openIdConnectUrl": "https://example.com/.well-known/openid-configuration",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

List Security Schemes

get

List all Security Schemes items.

SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.

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 Security Schemes

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}/security-schemes

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

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

Create Security Scheme

post

Create a new Security Scheme item.

SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.

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

SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.

idstring · min: 34 · max: 34Optional

Object ID with prefix "sec_sch_"

Default: sec_sch_agob4v2per3ujmlksd54bekdvuExample: sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve

typestring · enumRequired

Kind of authentication mechanism (API key, HTTP auth/bearer, mutual TLS, OAuth 2.0, or OpenID Connect).

Example: httpPossible values:

instring · enumOptional

Location of the API key for apiKey schemes (query, header, or cookie).

Example: headerPossible values:

namestringRequired

Identifier for the security scheme; matches the name used when publishing or importing API definitions.

Example: ApiKeyAuth

descriptionstringOptional

Security scheme description in markdown.

Example: Bearer token authentication using JWT.

descriptionBlocksany ofOptional

Security scheme description in ProseMirror JSON blocks.

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

or

schemestringOptional

HTTP auth scheme label (for example: basic, bearer, digest).

Example: bearer

bearerFormatstringOptional

Optional hint about the bearer token format (for example: JWT).

Example: JWT

flowsanyOptional

OAuth 2.0 flow configuration (e.g., auth code, client credentials) detailing token and authorization URLs.

Example: {"clientCredentials":{"tokenUrl":"https://example.com/oauth/token","scopes":{}}}

openIdConnectUrlstringOptional

OpenID Connect discovery endpoint when type is openIdConnect.

Example: https://example.com/.well-known/openid-configuration

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

Security Scheme 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}/security-schemes

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

{
  "id": "sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "type": "http",
  "in": "header",
  "name": "ApiKeyAuth",
  "description": "Bearer token authentication using JWT.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Security scheme description in rich text format."
      }
    ]
  },
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "flows": {
    "clientCredentials": {
      "tokenUrl": "https://example.com/oauth/token",
      "scopes": {}
    }
  },
  "openIdConnectUrl": "https://example.com/.well-known/openid-configuration",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "type": "http",
  "in": "header",
  "name": "ApiKeyAuth",
  "description": "Bearer token authentication using JWT.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Security scheme description in rich text format."
      }
    ]
  },
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "flows": {
    "clientCredentials": {
      "tokenUrl": "https://example.com/oauth/token",
      "scopes": {}
    }
  },
  "openIdConnectUrl": "https://example.com/.well-known/openid-configuration",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Get Security Scheme

get

Get a Security Scheme item by its id.

SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.

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

Security Scheme identifier

Example: sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

200

Security Scheme details

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Security Scheme not found

application/json

500

Internal Server Error

application/json

get

/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/security-schemes/{id}

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

{
  "id": "sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "type": "http",
  "in": "header",
  "name": "ApiKeyAuth",
  "description": "Bearer token authentication using JWT.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Security scheme description in rich text format."
      }
    ]
  },
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "flows": {
    "clientCredentials": {
      "tokenUrl": "https://example.com/oauth/token",
      "scopes": {}
    }
  },
  "openIdConnectUrl": "https://example.com/.well-known/openid-configuration",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Replace Security Scheme

post

Completely replaces a Security Scheme item by its id.

SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.

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

Security Scheme identifier

Example: sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.

idstring · min: 34 · max: 34Optional

Object ID with prefix "sec_sch_"

Default: sec_sch_agob4v2per3ujmlksd54bekdvuExample: sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve

typestring · enumRequired

Kind of authentication mechanism (API key, HTTP auth/bearer, mutual TLS, OAuth 2.0, or OpenID Connect).

Example: httpPossible values:

instring · enumOptional

Location of the API key for apiKey schemes (query, header, or cookie).

Example: headerPossible values:

namestringRequired

Identifier for the security scheme; matches the name used when publishing or importing API definitions.

Example: ApiKeyAuth

descriptionstringOptional

Security scheme description in markdown.

Example: Bearer token authentication using JWT.

descriptionBlocksany ofOptional

Security scheme description in ProseMirror JSON blocks.

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

or

schemestringOptional

HTTP auth scheme label (for example: basic, bearer, digest).

Example: bearer

bearerFormatstringOptional

Optional hint about the bearer token format (for example: JWT).

Example: JWT

flowsanyOptional

OAuth 2.0 flow configuration (e.g., auth code, client credentials) detailing token and authorization URLs.

Example: {"clientCredentials":{"tokenUrl":"https://example.com/oauth/token","scopes":{}}}

openIdConnectUrlstringOptional

OpenID Connect discovery endpoint when type is openIdConnect.

Example: https://example.com/.well-known/openid-configuration

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

Security Scheme replaced

application/json

201

Security Scheme created

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Security Scheme not found

application/json

500

Internal Server Error

application/json

post

/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/security-schemes/{id}

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

{
  "id": "sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "type": "http",
  "in": "header",
  "name": "ApiKeyAuth",
  "description": "Bearer token authentication using JWT.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Security scheme description in rich text format."
      }
    ]
  },
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "flows": {
    "clientCredentials": {
      "tokenUrl": "https://example.com/oauth/token",
      "scopes": {}
    }
  },
  "openIdConnectUrl": "https://example.com/.well-known/openid-configuration",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "type": "http",
  "in": "header",
  "name": "ApiKeyAuth",
  "description": "Bearer token authentication using JWT.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Security scheme description in rich text format."
      }
    ]
  },
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "flows": {
    "clientCredentials": {
      "tokenUrl": "https://example.com/oauth/token",
      "scopes": {}
    }
  },
  "openIdConnectUrl": "https://example.com/.well-known/openid-configuration",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

Delete Security Scheme

delete

Delete a Security Scheme item by its id.

SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.

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

Security Scheme identifier

Example: sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve

Responses

204

Security Scheme deleted

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Security Scheme not found

application/json

500

Internal Server Error

application/json

delete

/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/security-schemes/{id}

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

No content

Update Security Scheme

patch

Partially updates a Security Scheme item by its id.

SecurityScheme is an authentication scheme definition covering API keys, HTTP auth (including bearer), mutual TLS, OAuth 2.0, and OpenID Connect that callers must satisfy.

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

Security Scheme identifier

Example: sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve

Body

idstring · min: 34 · max: 34Optional

Object ID with prefix "sec_sch_"

Default: sec_sch_agob4v2per3ujmlkug7u5thhfmExample: sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve

typestring · enumOptional

Kind of authentication mechanism (API key, HTTP auth/bearer, mutual TLS, OAuth 2.0, or OpenID Connect).

Example: httpPossible values:

instring,null · enum · nullableOptional

Location of the API key for apiKey schemes (query, header, or cookie).

Example: headerPossible values:

namestringOptional

Identifier for the security scheme; matches the name used when publishing or importing API definitions.

Example: ApiKeyAuth

descriptionstringOptional

Security scheme description in markdown.

Example: Bearer token authentication using JWT.

descriptionBlocksany ofOptional

Security scheme description in ProseMirror JSON blocks.

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

or

schemestringOptional

HTTP auth scheme label (for example: basic, bearer, digest).

Example: bearer

bearerFormatstringOptional

Optional hint about the bearer token format (for example: JWT).

Example: JWT

flowsanyOptional

OAuth 2.0 flow configuration (e.g., auth code, client credentials) detailing token and authorization URLs.

Example: {"clientCredentials":{"tokenUrl":"https://example.com/oauth/token","scopes":{}}}

openIdConnectUrlstringOptional

OpenID Connect discovery endpoint when type is openIdConnect.

Example: https://example.com/.well-known/openid-configuration

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

Security Scheme updated

application/json

400

Invalid request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Security Scheme not found

application/json

500

Internal Server Error

application/json

patch

/v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/security-schemes/{id}

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

{
  "id": "sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "type": "http",
  "in": "header",
  "name": "ApiKeyAuth",
  "description": "Bearer token authentication using JWT.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Security scheme description in rich text format."
      }
    ]
  },
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "flows": {
    "clientCredentials": {
      "tokenUrl": "https://example.com/oauth/token",
      "scopes": {}
    }
  },
  "openIdConnectUrl": "https://example.com/.well-known/openid-configuration",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

{
  "id": "sec_sch_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "type": "http",
  "in": "header",
  "name": "ApiKeyAuth",
  "description": "Bearer token authentication using JWT.",
  "descriptionBlocks": {
    "type": "paragraph",
    "content": [
      {
        "type": "text",
        "text": "Security scheme description in rich text format."
      }
    ]
  },
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "flows": {
    "clientCredentials": {
      "tokenUrl": "https://example.com/oauth/token",
      "scopes": {}
    }
  },
  "openIdConnectUrl": "https://example.com/.well-known/openid-configuration",
  "versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

hashtagList Security Schemes

hashtagCreate Security Scheme

hashtagGet Security Scheme

hashtagReplace Security Scheme

hashtagDelete Security Scheme

hashtagUpdate Security Scheme

hashtagList Security Schemes

hashtagCreate Security Scheme

hashtagGet Security Scheme

hashtagReplace Security Scheme

hashtagDelete Security Scheme

hashtagUpdate Security Scheme

List Security Schemes

Create Security Scheme

Get Security Scheme

Replace Security Scheme

Delete Security Scheme

Update Security Scheme

List Security Schemes

Create Security Scheme

Get Security Scheme

Replace Security Scheme

Delete Security Scheme

Update Security Scheme