Services
List all Services items.
Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.
Project API key authentication. Use your project API key as a Bearer token in the Authorization header.
Catalog version identifier
ver_c4x6k3w8j7n9b1z5s2t4m8q0veCursor for pagination (item ID)
Maximum number of items to return (default: 50, max: 1000)
50Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)
List of Services
Services collection
Invalid request
Unauthorized
Forbidden
Internal Server Error
GET /v2/catalog/versions/{versionId}/services HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"items": [],
"pagination": {
"nextCursor": null,
"hasMore": true,
"limit": 1
}
}Create a new Service item.
Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.
Project API key authentication. Use your project API key as a Bearer token in the Authorization header.
Catalog version identifier
ver_c4x6k3w8j7n9b1z5s2t4m8q0veService is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.
Object ID with prefix "svc_"
svc_agqumsqmzryetpiaw7dh5aryaqExample: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve""Example: User Serviceuser-servicePattern: ^[a-z0-9-]+$Short plain-text summary of the service.
""Example: User management services that allows adding, updating, and deleting users.Service description written in markdown.
""Example: Service for managing users, authentication, and user profiles.Service description as ProseMirror JSON blocks.
{"type":"paragraph","content":[{"type":"text","text":"Service description in rich text format."}]}[]Example: ["authentication","users"][]Example: ["user-api","users-api"]Object ID with prefix "ver_"
ver_c4x6k3w8j7n9b1z5s2t4m8q0veorg_sample_org2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000ZTimestamp of the most recent report received from the service.
2024-01-15T10:30:00.000ZTimestamp when the service was last mentioned in a report, either directly or via connected services.
2024-01-15T10:30:00.000ZTimestamp of the last successful connection observed from the service (ping or report).
2024-01-15T10:30:00.000ZIndicates that the service maintains a direct connection from which reports are expected.
falseService created
Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.
Object ID with prefix "svc_"
svc_agqumsqmzryetpiaw7dh5aryaqExample: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve""Example: User Serviceuser-servicePattern: ^[a-z0-9-]+$Short plain-text summary of the service.
""Example: User management services that allows adding, updating, and deleting users.Service description written in markdown.
""Example: Service for managing users, authentication, and user profiles.Service description as ProseMirror JSON blocks.
{"type":"paragraph","content":[{"type":"text","text":"Service description in rich text format."}]}[]Example: ["authentication","users"][]Example: ["user-api","users-api"]Object ID with prefix "ver_"
ver_c4x6k3w8j7n9b1z5s2t4m8q0veorg_sample_org2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000ZTimestamp of the most recent report received from the service.
2024-01-15T10:30:00.000ZTimestamp when the service was last mentioned in a report, either directly or via connected services.
2024-01-15T10:30:00.000ZTimestamp of the last successful connection observed from the service (ping or report).
2024-01-15T10:30:00.000ZIndicates that the service maintains a direct connection from which reports are expected.
falseInvalid request
Unauthorized
Forbidden
Conflict
Internal Server Error
POST /v2/catalog/versions/{versionId}/services HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 799
{
"id": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"name": "User Service",
"slug": "user-service",
"summary": "User management services that allows adding, updating, and deleting users.",
"description": "Service for managing users, authentication, and user profiles.",
"descriptionBlocks": {
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Service description in rich text format."
}
]
},
"tags": [
"authentication",
"users"
],
"security": [
{
"ApiKeyAuth": []
}
],
"previousSlugs": [
"user-api",
"users-api"
],
"versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"organizationId": "org_sample_org",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z",
"kvStorage": {},
"lastReportAt": "2024-01-15T10:30:00.000Z",
"lastMentionAt": "2024-01-15T10:30:00.000Z",
"lastConnectionAt": "2024-01-15T10:30:00.000Z",
"hasConnection": false
}{
"id": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"name": "User Service",
"slug": "user-service",
"summary": "User management services that allows adding, updating, and deleting users.",
"description": "Service for managing users, authentication, and user profiles.",
"descriptionBlocks": {
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Service description in rich text format."
}
]
},
"tags": [
"authentication",
"users"
],
"security": [
{
"ApiKeyAuth": []
}
],
"previousSlugs": [
"user-api",
"users-api"
],
"versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"organizationId": "org_sample_org",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z",
"kvStorage": {},
"lastReportAt": "2024-01-15T10:30:00.000Z",
"lastMentionAt": "2024-01-15T10:30:00.000Z",
"lastConnectionAt": "2024-01-15T10:30:00.000Z",
"hasConnection": false
}Get a Service item by its id.
Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.
Project API key authentication. Use your project API key as a Bearer token in the Authorization header.
Catalog version identifier
ver_c4x6k3w8j7n9b1z5s2t4m8q0veService identifier
svc_c4x6k3w8j7n9b1z5s2t4m8q0veService details
Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.
Object ID with prefix "svc_"
svc_agqumsqmzryetpiaw7dh5aryaqExample: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve""Example: User Serviceuser-servicePattern: ^[a-z0-9-]+$Short plain-text summary of the service.
""Example: User management services that allows adding, updating, and deleting users.Service description written in markdown.
""Example: Service for managing users, authentication, and user profiles.Service description as ProseMirror JSON blocks.
{"type":"paragraph","content":[{"type":"text","text":"Service description in rich text format."}]}[]Example: ["authentication","users"][]Example: ["user-api","users-api"]Object ID with prefix "ver_"
ver_c4x6k3w8j7n9b1z5s2t4m8q0veorg_sample_org2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000ZTimestamp of the most recent report received from the service.
2024-01-15T10:30:00.000ZTimestamp when the service was last mentioned in a report, either directly or via connected services.
2024-01-15T10:30:00.000ZTimestamp of the last successful connection observed from the service (ping or report).
2024-01-15T10:30:00.000ZIndicates that the service maintains a direct connection from which reports are expected.
falseInvalid request
Unauthorized
Forbidden
Service not found
Internal Server Error
GET /v2/catalog/versions/{versionId}/services/{id} HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"name": "User Service",
"slug": "user-service",
"summary": "User management services that allows adding, updating, and deleting users.",
"description": "Service for managing users, authentication, and user profiles.",
"descriptionBlocks": {
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Service description in rich text format."
}
]
},
"tags": [
"authentication",
"users"
],
"security": [
{
"ApiKeyAuth": []
}
],
"previousSlugs": [
"user-api",
"users-api"
],
"versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"organizationId": "org_sample_org",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z",
"kvStorage": {},
"lastReportAt": "2024-01-15T10:30:00.000Z",
"lastMentionAt": "2024-01-15T10:30:00.000Z",
"lastConnectionAt": "2024-01-15T10:30:00.000Z",
"hasConnection": false
}Completely replaces a Service item by its id.
Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.
Project API key authentication. Use your project API key as a Bearer token in the Authorization header.
Catalog version identifier
ver_c4x6k3w8j7n9b1z5s2t4m8q0veService identifier
svc_c4x6k3w8j7n9b1z5s2t4m8q0veService is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.
Object ID with prefix "svc_"
svc_agqumsqmzryetpiaw7dh5aryaqExample: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve""Example: User Serviceuser-servicePattern: ^[a-z0-9-]+$Short plain-text summary of the service.
""Example: User management services that allows adding, updating, and deleting users.Service description written in markdown.
""Example: Service for managing users, authentication, and user profiles.Service description as ProseMirror JSON blocks.
{"type":"paragraph","content":[{"type":"text","text":"Service description in rich text format."}]}[]Example: ["authentication","users"][]Example: ["user-api","users-api"]Object ID with prefix "ver_"
ver_c4x6k3w8j7n9b1z5s2t4m8q0veorg_sample_org2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000ZTimestamp of the most recent report received from the service.
2024-01-15T10:30:00.000ZTimestamp when the service was last mentioned in a report, either directly or via connected services.
2024-01-15T10:30:00.000ZTimestamp of the last successful connection observed from the service (ping or report).
2024-01-15T10:30:00.000ZIndicates that the service maintains a direct connection from which reports are expected.
falseService replaced
Service created
Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.
Object ID with prefix "svc_"
svc_agqumsqmzryetpiaw7dh5aryaqExample: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve""Example: User Serviceuser-servicePattern: ^[a-z0-9-]+$Short plain-text summary of the service.
""Example: User management services that allows adding, updating, and deleting users.Service description written in markdown.
""Example: Service for managing users, authentication, and user profiles.Service description as ProseMirror JSON blocks.
{"type":"paragraph","content":[{"type":"text","text":"Service description in rich text format."}]}[]Example: ["authentication","users"][]Example: ["user-api","users-api"]Object ID with prefix "ver_"
ver_c4x6k3w8j7n9b1z5s2t4m8q0veorg_sample_org2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000ZTimestamp of the most recent report received from the service.
2024-01-15T10:30:00.000ZTimestamp when the service was last mentioned in a report, either directly or via connected services.
2024-01-15T10:30:00.000ZTimestamp of the last successful connection observed from the service (ping or report).
2024-01-15T10:30:00.000ZIndicates that the service maintains a direct connection from which reports are expected.
falseInvalid request
Unauthorized
Forbidden
Service not found
Internal Server Error
POST /v2/catalog/versions/{versionId}/services/{id} HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 799
{
"id": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"name": "User Service",
"slug": "user-service",
"summary": "User management services that allows adding, updating, and deleting users.",
"description": "Service for managing users, authentication, and user profiles.",
"descriptionBlocks": {
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Service description in rich text format."
}
]
},
"tags": [
"authentication",
"users"
],
"security": [
{
"ApiKeyAuth": []
}
],
"previousSlugs": [
"user-api",
"users-api"
],
"versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"organizationId": "org_sample_org",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z",
"kvStorage": {},
"lastReportAt": "2024-01-15T10:30:00.000Z",
"lastMentionAt": "2024-01-15T10:30:00.000Z",
"lastConnectionAt": "2024-01-15T10:30:00.000Z",
"hasConnection": false
}{
"id": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"name": "User Service",
"slug": "user-service",
"summary": "User management services that allows adding, updating, and deleting users.",
"description": "Service for managing users, authentication, and user profiles.",
"descriptionBlocks": {
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Service description in rich text format."
}
]
},
"tags": [
"authentication",
"users"
],
"security": [
{
"ApiKeyAuth": []
}
],
"previousSlugs": [
"user-api",
"users-api"
],
"versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"organizationId": "org_sample_org",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z",
"kvStorage": {},
"lastReportAt": "2024-01-15T10:30:00.000Z",
"lastMentionAt": "2024-01-15T10:30:00.000Z",
"lastConnectionAt": "2024-01-15T10:30:00.000Z",
"hasConnection": false
}Delete a Service item by its id.
Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.
Project API key authentication. Use your project API key as a Bearer token in the Authorization header.
Catalog version identifier
ver_c4x6k3w8j7n9b1z5s2t4m8q0veService identifier
svc_c4x6k3w8j7n9b1z5s2t4m8q0veService deleted
No content
Invalid request
Unauthorized
Forbidden
Service not found
Internal Server Error
DELETE /v2/catalog/versions/{versionId}/services/{id} HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Partially updates a Service item by its id.
Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.
Project API key authentication. Use your project API key as a Bearer token in the Authorization header.
Catalog version identifier
ver_c4x6k3w8j7n9b1z5s2t4m8q0veService identifier
svc_c4x6k3w8j7n9b1z5s2t4m8q0veObject ID with prefix "svc_"
svc_agqumsqmzryetpiax3jhxv5r7mExample: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve""Example: User Serviceuser-servicePattern: ^[a-z0-9-]+$Short plain-text summary of the service.
""Example: User management services that allows adding, updating, and deleting users.Service description written in markdown.
""Example: Service for managing users, authentication, and user profiles.Service description as ProseMirror JSON blocks.
{"type":"paragraph","content":[{"type":"text","text":"Service description in rich text format."}]}[]Example: ["authentication","users"][]Example: ["user-api","users-api"]Object ID with prefix "ver_"
ver_c4x6k3w8j7n9b1z5s2t4m8q0veorg_sample_org2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000ZTimestamp of the most recent report received from the service.
2024-01-15T10:30:00.000ZTimestamp when the service was last mentioned in a report, either directly or via connected services.
2024-01-15T10:30:00.000ZTimestamp of the last successful connection observed from the service (ping or report).
2024-01-15T10:30:00.000ZIndicates that the service maintains a direct connection from which reports are expected.
falseService updated
Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.
Object ID with prefix "svc_"
svc_agqumsqmzryetpiaw7dh5aryaqExample: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve""Example: User Serviceuser-servicePattern: ^[a-z0-9-]+$Short plain-text summary of the service.
""Example: User management services that allows adding, updating, and deleting users.Service description written in markdown.
""Example: Service for managing users, authentication, and user profiles.Service description as ProseMirror JSON blocks.
{"type":"paragraph","content":[{"type":"text","text":"Service description in rich text format."}]}[]Example: ["authentication","users"][]Example: ["user-api","users-api"]Object ID with prefix "ver_"
ver_c4x6k3w8j7n9b1z5s2t4m8q0veorg_sample_org2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000ZTimestamp of the most recent report received from the service.
2024-01-15T10:30:00.000ZTimestamp when the service was last mentioned in a report, either directly or via connected services.
2024-01-15T10:30:00.000ZTimestamp of the last successful connection observed from the service (ping or report).
2024-01-15T10:30:00.000ZIndicates that the service maintains a direct connection from which reports are expected.
falseInvalid request
Unauthorized
Forbidden
Service not found
Internal Server Error
PATCH /v2/catalog/versions/{versionId}/services/{id} HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 799
{
"id": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"name": "User Service",
"slug": "user-service",
"summary": "User management services that allows adding, updating, and deleting users.",
"description": "Service for managing users, authentication, and user profiles.",
"descriptionBlocks": {
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Service description in rich text format."
}
]
},
"tags": [
"authentication",
"users"
],
"security": [
{
"ApiKeyAuth": []
}
],
"previousSlugs": [
"user-api",
"users-api"
],
"versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"organizationId": "org_sample_org",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z",
"kvStorage": {},
"lastReportAt": "2024-01-15T10:30:00.000Z",
"lastMentionAt": "2024-01-15T10:30:00.000Z",
"lastConnectionAt": "2024-01-15T10:30:00.000Z",
"hasConnection": false
}{
"id": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"name": "User Service",
"slug": "user-service",
"summary": "User management services that allows adding, updating, and deleting users.",
"description": "Service for managing users, authentication, and user profiles.",
"descriptionBlocks": {
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Service description in rich text format."
}
]
},
"tags": [
"authentication",
"users"
],
"security": [
{
"ApiKeyAuth": []
}
],
"previousSlugs": [
"user-api",
"users-api"
],
"versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"organizationId": "org_sample_org",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z",
"kvStorage": {},
"lastReportAt": "2024-01-15T10:30:00.000Z",
"lastMentionAt": "2024-01-15T10:30:00.000Z",
"lastConnectionAt": "2024-01-15T10:30:00.000Z",
"hasConnection": false
}List all Services items.
Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.
Project API key authentication. Use your project API key as a Bearer token in the Authorization header.
Project slug or project id (proj_*)
Object ID with prefix "proj_"
proj_c4x6k3w8j7n9b1z5s2t4m8q0veVersion type, can be either 'branch' or 'environment'
branchPossible values: Version slug
mainCursor for pagination (item ID)
Maximum number of items to return (default: 50, max: 1000)
50Sort order. Use 'prop' for ascending, '-prop' for descending. Multiple params supported (e.g. sort=name&sort=-createdAt)
List of Services
Services collection
Invalid request
Unauthorized
Forbidden
Internal Server Error
GET /v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/services HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"items": [],
"pagination": {
"nextCursor": null,
"hasMore": true,
"limit": 1
}
}Create a new Service item.
Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.
Project API key authentication. Use your project API key as a Bearer token in the Authorization header.
Project slug or project id (proj_*)
Object ID with prefix "proj_"
proj_c4x6k3w8j7n9b1z5s2t4m8q0veVersion type, can be either 'branch' or 'environment'
branchPossible values: Version slug
mainService is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.
Object ID with prefix "svc_"
svc_agqumsqmzryetpiaw7dh5aryaqExample: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve""Example: User Serviceuser-servicePattern: ^[a-z0-9-]+$Short plain-text summary of the service.
""Example: User management services that allows adding, updating, and deleting users.Service description written in markdown.
""Example: Service for managing users, authentication, and user profiles.Service description as ProseMirror JSON blocks.
{"type":"paragraph","content":[{"type":"text","text":"Service description in rich text format."}]}[]Example: ["authentication","users"][]Example: ["user-api","users-api"]Object ID with prefix "ver_"
ver_c4x6k3w8j7n9b1z5s2t4m8q0veorg_sample_org2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000ZTimestamp of the most recent report received from the service.
2024-01-15T10:30:00.000ZTimestamp when the service was last mentioned in a report, either directly or via connected services.
2024-01-15T10:30:00.000ZTimestamp of the last successful connection observed from the service (ping or report).
2024-01-15T10:30:00.000ZIndicates that the service maintains a direct connection from which reports are expected.
falseService created
Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.
Object ID with prefix "svc_"
svc_agqumsqmzryetpiaw7dh5aryaqExample: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve""Example: User Serviceuser-servicePattern: ^[a-z0-9-]+$Short plain-text summary of the service.
""Example: User management services that allows adding, updating, and deleting users.Service description written in markdown.
""Example: Service for managing users, authentication, and user profiles.Service description as ProseMirror JSON blocks.
{"type":"paragraph","content":[{"type":"text","text":"Service description in rich text format."}]}[]Example: ["authentication","users"][]Example: ["user-api","users-api"]Object ID with prefix "ver_"
ver_c4x6k3w8j7n9b1z5s2t4m8q0veorg_sample_org2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000ZTimestamp of the most recent report received from the service.
2024-01-15T10:30:00.000ZTimestamp when the service was last mentioned in a report, either directly or via connected services.
2024-01-15T10:30:00.000ZTimestamp of the last successful connection observed from the service (ping or report).
2024-01-15T10:30:00.000ZIndicates that the service maintains a direct connection from which reports are expected.
falseInvalid request
Unauthorized
Forbidden
Conflict
Internal Server Error
POST /v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/services HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 799
{
"id": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"name": "User Service",
"slug": "user-service",
"summary": "User management services that allows adding, updating, and deleting users.",
"description": "Service for managing users, authentication, and user profiles.",
"descriptionBlocks": {
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Service description in rich text format."
}
]
},
"tags": [
"authentication",
"users"
],
"security": [
{
"ApiKeyAuth": []
}
],
"previousSlugs": [
"user-api",
"users-api"
],
"versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"organizationId": "org_sample_org",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z",
"kvStorage": {},
"lastReportAt": "2024-01-15T10:30:00.000Z",
"lastMentionAt": "2024-01-15T10:30:00.000Z",
"lastConnectionAt": "2024-01-15T10:30:00.000Z",
"hasConnection": false
}{
"id": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"name": "User Service",
"slug": "user-service",
"summary": "User management services that allows adding, updating, and deleting users.",
"description": "Service for managing users, authentication, and user profiles.",
"descriptionBlocks": {
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Service description in rich text format."
}
]
},
"tags": [
"authentication",
"users"
],
"security": [
{
"ApiKeyAuth": []
}
],
"previousSlugs": [
"user-api",
"users-api"
],
"versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"organizationId": "org_sample_org",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z",
"kvStorage": {},
"lastReportAt": "2024-01-15T10:30:00.000Z",
"lastMentionAt": "2024-01-15T10:30:00.000Z",
"lastConnectionAt": "2024-01-15T10:30:00.000Z",
"hasConnection": false
}Get a Service item by its id.
Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.
Project API key authentication. Use your project API key as a Bearer token in the Authorization header.
Project slug or project id (proj_*)
Object ID with prefix "proj_"
proj_c4x6k3w8j7n9b1z5s2t4m8q0veVersion type, can be either 'branch' or 'environment'
branchPossible values: Version slug
mainService identifier
svc_c4x6k3w8j7n9b1z5s2t4m8q0veService details
Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.
Object ID with prefix "svc_"
svc_agqumsqmzryetpiaw7dh5aryaqExample: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve""Example: User Serviceuser-servicePattern: ^[a-z0-9-]+$Short plain-text summary of the service.
""Example: User management services that allows adding, updating, and deleting users.Service description written in markdown.
""Example: Service for managing users, authentication, and user profiles.Service description as ProseMirror JSON blocks.
{"type":"paragraph","content":[{"type":"text","text":"Service description in rich text format."}]}[]Example: ["authentication","users"][]Example: ["user-api","users-api"]Object ID with prefix "ver_"
ver_c4x6k3w8j7n9b1z5s2t4m8q0veorg_sample_org2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000ZTimestamp of the most recent report received from the service.
2024-01-15T10:30:00.000ZTimestamp when the service was last mentioned in a report, either directly or via connected services.
2024-01-15T10:30:00.000ZTimestamp of the last successful connection observed from the service (ping or report).
2024-01-15T10:30:00.000ZIndicates that the service maintains a direct connection from which reports are expected.
falseInvalid request
Unauthorized
Forbidden
Service not found
Internal Server Error
GET /v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/services/{id} HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"name": "User Service",
"slug": "user-service",
"summary": "User management services that allows adding, updating, and deleting users.",
"description": "Service for managing users, authentication, and user profiles.",
"descriptionBlocks": {
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Service description in rich text format."
}
]
},
"tags": [
"authentication",
"users"
],
"security": [
{
"ApiKeyAuth": []
}
],
"previousSlugs": [
"user-api",
"users-api"
],
"versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"organizationId": "org_sample_org",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z",
"kvStorage": {},
"lastReportAt": "2024-01-15T10:30:00.000Z",
"lastMentionAt": "2024-01-15T10:30:00.000Z",
"lastConnectionAt": "2024-01-15T10:30:00.000Z",
"hasConnection": false
}Completely replaces a Service item by its id.
Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.
Project API key authentication. Use your project API key as a Bearer token in the Authorization header.
Project slug or project id (proj_*)
Object ID with prefix "proj_"
proj_c4x6k3w8j7n9b1z5s2t4m8q0veVersion type, can be either 'branch' or 'environment'
branchPossible values: Version slug
mainService identifier
svc_c4x6k3w8j7n9b1z5s2t4m8q0veService is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.
Object ID with prefix "svc_"
svc_agqumsqmzryetpiaw7dh5aryaqExample: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve""Example: User Serviceuser-servicePattern: ^[a-z0-9-]+$Short plain-text summary of the service.
""Example: User management services that allows adding, updating, and deleting users.Service description written in markdown.
""Example: Service for managing users, authentication, and user profiles.Service description as ProseMirror JSON blocks.
{"type":"paragraph","content":[{"type":"text","text":"Service description in rich text format."}]}[]Example: ["authentication","users"][]Example: ["user-api","users-api"]Object ID with prefix "ver_"
ver_c4x6k3w8j7n9b1z5s2t4m8q0veorg_sample_org2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000ZTimestamp of the most recent report received from the service.
2024-01-15T10:30:00.000ZTimestamp when the service was last mentioned in a report, either directly or via connected services.
2024-01-15T10:30:00.000ZTimestamp of the last successful connection observed from the service (ping or report).
2024-01-15T10:30:00.000ZIndicates that the service maintains a direct connection from which reports are expected.
falseService replaced
Service created
Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.
Object ID with prefix "svc_"
svc_agqumsqmzryetpiaw7dh5aryaqExample: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve""Example: User Serviceuser-servicePattern: ^[a-z0-9-]+$Short plain-text summary of the service.
""Example: User management services that allows adding, updating, and deleting users.Service description written in markdown.
""Example: Service for managing users, authentication, and user profiles.Service description as ProseMirror JSON blocks.
{"type":"paragraph","content":[{"type":"text","text":"Service description in rich text format."}]}[]Example: ["authentication","users"][]Example: ["user-api","users-api"]Object ID with prefix "ver_"
ver_c4x6k3w8j7n9b1z5s2t4m8q0veorg_sample_org2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000ZTimestamp of the most recent report received from the service.
2024-01-15T10:30:00.000ZTimestamp when the service was last mentioned in a report, either directly or via connected services.
2024-01-15T10:30:00.000ZTimestamp of the last successful connection observed from the service (ping or report).
2024-01-15T10:30:00.000ZIndicates that the service maintains a direct connection from which reports are expected.
falseInvalid request
Unauthorized
Forbidden
Service not found
Internal Server Error
POST /v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/services/{id} HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 799
{
"id": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"name": "User Service",
"slug": "user-service",
"summary": "User management services that allows adding, updating, and deleting users.",
"description": "Service for managing users, authentication, and user profiles.",
"descriptionBlocks": {
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Service description in rich text format."
}
]
},
"tags": [
"authentication",
"users"
],
"security": [
{
"ApiKeyAuth": []
}
],
"previousSlugs": [
"user-api",
"users-api"
],
"versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"organizationId": "org_sample_org",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z",
"kvStorage": {},
"lastReportAt": "2024-01-15T10:30:00.000Z",
"lastMentionAt": "2024-01-15T10:30:00.000Z",
"lastConnectionAt": "2024-01-15T10:30:00.000Z",
"hasConnection": false
}{
"id": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"name": "User Service",
"slug": "user-service",
"summary": "User management services that allows adding, updating, and deleting users.",
"description": "Service for managing users, authentication, and user profiles.",
"descriptionBlocks": {
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Service description in rich text format."
}
]
},
"tags": [
"authentication",
"users"
],
"security": [
{
"ApiKeyAuth": []
}
],
"previousSlugs": [
"user-api",
"users-api"
],
"versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"organizationId": "org_sample_org",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z",
"kvStorage": {},
"lastReportAt": "2024-01-15T10:30:00.000Z",
"lastMentionAt": "2024-01-15T10:30:00.000Z",
"lastConnectionAt": "2024-01-15T10:30:00.000Z",
"hasConnection": false
}Delete a Service item by its id.
Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.
Project API key authentication. Use your project API key as a Bearer token in the Authorization header.
Project slug or project id (proj_*)
Object ID with prefix "proj_"
proj_c4x6k3w8j7n9b1z5s2t4m8q0veVersion type, can be either 'branch' or 'environment'
branchPossible values: Version slug
mainService identifier
svc_c4x6k3w8j7n9b1z5s2t4m8q0veService deleted
No content
Invalid request
Unauthorized
Forbidden
Service not found
Internal Server Error
DELETE /v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/services/{id} HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Partially updates a Service item by its id.
Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.
Project API key authentication. Use your project API key as a Bearer token in the Authorization header.
Project slug or project id (proj_*)
Object ID with prefix "proj_"
proj_c4x6k3w8j7n9b1z5s2t4m8q0veVersion type, can be either 'branch' or 'environment'
branchPossible values: Version slug
mainService identifier
svc_c4x6k3w8j7n9b1z5s2t4m8q0veObject ID with prefix "svc_"
svc_agqumsqmzryetpiays2wwfrkp4Example: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve""Example: User Serviceuser-servicePattern: ^[a-z0-9-]+$Short plain-text summary of the service.
""Example: User management services that allows adding, updating, and deleting users.Service description written in markdown.
""Example: Service for managing users, authentication, and user profiles.Service description as ProseMirror JSON blocks.
{"type":"paragraph","content":[{"type":"text","text":"Service description in rich text format."}]}[]Example: ["authentication","users"][]Example: ["user-api","users-api"]Object ID with prefix "ver_"
ver_c4x6k3w8j7n9b1z5s2t4m8q0veorg_sample_org2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000ZTimestamp of the most recent report received from the service.
2024-01-15T10:30:00.000ZTimestamp when the service was last mentioned in a report, either directly or via connected services.
2024-01-15T10:30:00.000ZTimestamp of the last successful connection observed from the service (ping or report).
2024-01-15T10:30:00.000ZIndicates that the service maintains a direct connection from which reports are expected.
falseService updated
Service is a top-level record representing a product or microservice; owns the collection of endpoints plus shared authentication and metadata.
Object ID with prefix "svc_"
svc_agqumsqmzryetpiaw7dh5aryaqExample: svc_c4x6k3w8j7n9b1z5s2t4m8q0ve""Example: User Serviceuser-servicePattern: ^[a-z0-9-]+$Short plain-text summary of the service.
""Example: User management services that allows adding, updating, and deleting users.Service description written in markdown.
""Example: Service for managing users, authentication, and user profiles.Service description as ProseMirror JSON blocks.
{"type":"paragraph","content":[{"type":"text","text":"Service description in rich text format."}]}[]Example: ["authentication","users"][]Example: ["user-api","users-api"]Object ID with prefix "ver_"
ver_c4x6k3w8j7n9b1z5s2t4m8q0veorg_sample_org2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000Z2026-10-16T19:57:00.492ZExample: 2024-01-15T10:30:00.000ZTimestamp of the most recent report received from the service.
2024-01-15T10:30:00.000ZTimestamp when the service was last mentioned in a report, either directly or via connected services.
2024-01-15T10:30:00.000ZTimestamp of the last successful connection observed from the service (ping or report).
2024-01-15T10:30:00.000ZIndicates that the service maintains a direct connection from which reports are expected.
falseInvalid request
Unauthorized
Forbidden
Service not found
Internal Server Error
PATCH /v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/services/{id} HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 799
{
"id": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"name": "User Service",
"slug": "user-service",
"summary": "User management services that allows adding, updating, and deleting users.",
"description": "Service for managing users, authentication, and user profiles.",
"descriptionBlocks": {
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Service description in rich text format."
}
]
},
"tags": [
"authentication",
"users"
],
"security": [
{
"ApiKeyAuth": []
}
],
"previousSlugs": [
"user-api",
"users-api"
],
"versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"organizationId": "org_sample_org",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z",
"kvStorage": {},
"lastReportAt": "2024-01-15T10:30:00.000Z",
"lastMentionAt": "2024-01-15T10:30:00.000Z",
"lastConnectionAt": "2024-01-15T10:30:00.000Z",
"hasConnection": false
}{
"id": "svc_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"name": "User Service",
"slug": "user-service",
"summary": "User management services that allows adding, updating, and deleting users.",
"description": "Service for managing users, authentication, and user profiles.",
"descriptionBlocks": {
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Service description in rich text format."
}
]
},
"tags": [
"authentication",
"users"
],
"security": [
{
"ApiKeyAuth": []
}
],
"previousSlugs": [
"user-api",
"users-api"
],
"versionId": "ver_c4x6k3w8j7n9b1z5s2t4m8q0ve",
"organizationId": "org_sample_org",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z",
"kvStorage": {},
"lastReportAt": "2024-01-15T10:30:00.000Z",
"lastMentionAt": "2024-01-15T10:30:00.000Z",
"lastConnectionAt": "2024-01-15T10:30:00.000Z",
"hasConnection": false
}Returns the machine-readable OpenAPI specification for a service. Supported versions: v3_1 (JSON only).
Project API key authentication. Use your project API key as a Bearer token in the Authorization header.
Catalog version identifier
ver_c4x6k3w8j7n9b1z5s2t4m8q0veService ID or slug
OpenAPI spec filename (e.g. v3_1.json)
v3_1.jsonPossible values: OpenAPI specification (JSON)
Invalid request
Service not found
Internal Server Error
GET /v2/catalog/versions/{versionId}/services/{idOrSlug}/openapi/{filename} HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}Accepts an OpenAPI specification in the request body. If the service exists (by id or slug), replaces its definition (paths, operations, servers, etc.) with the spec. If not found, creates a new service using idOrSlug as the slug.
Project API key authentication. Use your project API key as a Bearer token in the Authorization header.
Catalog version identifier
ver_c4x6k3w8j7n9b1z5s2t4m8q0veService ID or slug
Service updated from OpenAPI spec
Invalid request
Service not found
Internal Server Error
POST /v2/catalog/versions/{versionId}/services/{idOrSlug}/openapi HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 101
{
"openapi": "text",
"info": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ok": true
}Returns the machine-readable OpenAPI specification for a service. Supported versions: v3_1 (JSON only).
Project API key authentication. Use your project API key as a Bearer token in the Authorization header.
Project slug or project id (proj_*)
Object ID with prefix "proj_"
proj_c4x6k3w8j7n9b1z5s2t4m8q0veVersion type, can be either 'branch' or 'environment'
branchPossible values: Version slug
mainService ID or slug
OpenAPI spec filename (e.g. v3_1.json)
v3_1.jsonPossible values: OpenAPI specification (JSON)
Invalid request
Service not found
Internal Server Error
GET /v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/services/{idOrSlug}/openapi/{filename} HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}Accepts an OpenAPI specification in the request body. If the service exists (by id or slug), replaces its definition (paths, operations, servers, etc.) with the spec. If not found, creates a new service using idOrSlug as the slug.
Project API key authentication. Use your project API key as a Bearer token in the Authorization header.
Project slug or project id (proj_*)
Object ID with prefix "proj_"
proj_c4x6k3w8j7n9b1z5s2t4m8q0veVersion type, can be either 'branch' or 'environment'
branchPossible values: Version slug
mainService ID or slug
Service updated from OpenAPI spec
Invalid request
Service not found
Internal Server Error
POST /v2/catalog/projects/{projectRef}/{versionType}/{versionSlug}/services/{idOrSlug}/openapi HTTP/1.1
Host: api.appear.sh
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 101
{
"openapi": "text",
"info": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ok": true
}Last updated