Add discovered services to the API Catalog

POST

/api-catalog/discovery-services

POST

/api-catalog/discovery-services

$ curl -X POST https://api.postman.com/api-catalog/discovery-services \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "discoveredServices": [
>     {
>       "name": "payment-service"
>     }
>   ]
> }'

1 {
2   "data": [
3     {
4       "id": "9feb4e3c-0cd8-44db-b137-7bf09aee73cd",
5       "organizationId": 123,
6       "name": "user-service",
7       "description": "Handles user registration, authentication, and profile management.",
8       "version": "3.0.0",
9       "sourceEnvironment": "production",
10       "systemEnvironmentId": null,
11       "tags": [
12         "auth",
13         "core",
14         "identity"
15       ],
16       "status": "discovered",
17       "endpointsCount": 5,
18       "providerServiceId": "usr-svc-custom-id-001",
19       "discoveredAt": "2026-02-25 03:22:54",
20       "discoveredBy": 12345678,
21       "lastSyncedAt": "2026-02-25 03:22:54"
22     }
23   ],
24   "meta": {
25     "total": 1,
26     "created": 1,
27     "updated": 0
28   }
29 }

Adds discovered services to the API Catalog. Accepts up to 20 services in a single call.

Authentication

x-api-keystring

API Key authentication via header

Request

This endpoint expects an object.

discoveredServiceslist of objectsRequired

A list of discovered services to add to the API Catalog.

Response

Successful Response

datalist of objects

A list of discovered services.

metaobject

The operation's metadata summary.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error