Postman apiCatalog API
The apiCatalog API from Postman — 11 operation(s) for apicatalog.
Postman apiCatalog API is one of 51 APIs that Postman publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include API Catalog. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 16 operations across 11 paths, and defines 175 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api.postman.com, https://api.eu.postman.com.
16 operations
11 paths
175 schemas
1 DELETE11 GET1 PATCH3 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Postman apiCatalog API declares
3 security schemes
for authenticating requests.
An API key is passed in the header as x-api-key (PostmanApiKey).
It accepts HTTP basic authentication (basicAuth).
An API key is passed in the header as Authorization (scimApiKey).
scimApiKey— A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/generating-scim-api-key) for calls to SCIM…
Paths & Operations 16
Across 11 paths, the API surfaces 16 operations — 1 DELETE, 11 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.
apiCatalog 16
GET
/api-catalog/discovery-services
Get discovered services
POST
/api-catalog/discovery-services
Add discovered services to the API Catalog
GET
/api-catalog/discovery-services/{serviceId}
Get a discovered service's information
GET
/api-catalog/services
Get all services
GET
/api-catalog/services/{serviceId}
Get a service by ID
GET
/api-catalog/services/{serviceId}/endpoints
Get a service's endpoints
GET
/api-catalog/services/{serviceId}/monitor-runs
Get a service's monitor runs
GET
/api-catalog/services/{serviceId}/spec-lints
Get a service's specification lints
GET
/api-catalog/services/{serviceId}/ci-runs
Get a service's CI runs
GET
/api-catalog/system-environments
Get all system environments
POST
/api-catalog/system-environments
Create a system environment
GET
/api-catalog/system-environments/{systemEnvironmentId}
Get a system environment
PATCH
/api-catalog/system-environments/{systemEnvironmentId}
Update a system environment
GET
/api-catalog/system-environments/{systemEnvironmentId}/associations
Get a system environment's associations
POST
/api-catalog/system-environments/{systemEnvironmentId}/associations
Add system environment associations
DELETE
/api-catalog/system-environments/{systemEnvironmentId}/associations
Remove system environment associations
Schemas 175
The contract defines 175 schemas that model the data the API accepts and returns. The most detailed are getApiCatalogDiscoveryService (20 properties), postApiCatalogDiscoveryServicesServiceData (14 properties), GetApiCatalogServiceData (13 properties), apiCatalogServiceServiceData (11 properties). Each schema is shown below with its type and property counts.
ApiCatalogServiceServiceDataOwnerType
string
The type of owner.
UpdateApiCatalogSystemEnvironmentRequestInternalServerError
GetApiCatalogServiceComplianceDataMonitorRun
object
The scheduled monitor run summary.
6 properties
6 required
apiCatalogServiceActorFilter
string
ApiCatalogServiceServiceDataGovernanceGroup
object
The governance group that the workspace belongs to. If no governance group is assigned, this returns a null value.
2 properties
2 required
GetApiCatalogServiceComplianceDataSpecLintStatus
string
Whether the specifications' latest lints passed or failed. If no lints exist, this returns a null value.
addApiCatalogSystemEnvironmentAssociationsWorkspaceEnvId
string
A workspace environment ID.
addApiCatalogSystemEnvironmentAssociationsResponse
object
2 properties
2 required
collectionUid
string
GetApiCatalogServiceDataStatus
string
The overall health status, derived from compliance signals.
GetApiCatalogServiceEndpointsDataItemsPerformance
object
Information about latency percentile metrics.
2 properties
2 required
apiCatalogSystemEnvironmentsMetaData
object
The response's meta information for paginated results.
4 properties
3 required
GetApiCatalogServiceMonitorRunsRequestInternalServerError
ApiCatalogServiceServiceDataComplianceCliRun
object
Information about the CI/CD pipeline.
1 property
1 required
apiCatalogServiceHostsFilter
string
GetApiCatalogDiscoveryServicesRequestInternalServerError
GetApiCatalogServiceEndpointsDataItems
object
6 properties
6 required
apiCatalogServiceMetadataConformanceRatePctData
number
The percentage of runs that passed, rounded to two decimal places.
GetApiCatalogServiceComplianceDataMonitorRunStatus
string
Whether the monitor's latest runs passed or failed. If no runs exist, this returns a null value.
apiCatalogErrorPathMessage
object
Information about the error.
2 properties
cursor
string
AddApiCatalogSystemEnvironmentAssociationsDataStatus
string
The association's status: - created — An association was created. - existing — The association already existed and is unchanged. - replaced — The association w…
GetApiCatalogServiceDataGovernanceGroup
object
The governance group that the workspace belongs to. If no governance group is assigned, this returns a null value.
2 properties
2 required
apiCatalogServiceMetadataPassedRunsData
integer
The number of successful runs.
GetApiCatalogSystemEnvironmentRequestBadRequestError
commonErrorNameMessage
object
1 property
apiCatalogDiscoveryServicesTagsData
array
A list of tags associated with the service.
CommonErrorTypeTitleDetailStatusType
getApiCatalogServiceEntityCountData
object
Information about the workspace's entities.
6 properties
6 required
GetApiCatalogServiceDataDependenciesItemsDirection
string
Whether traffic flows into (inbound) or out of (outbound) the service.
systemEnvironmentWorkspaceId
string
ApiCatalogServiceServiceDataComplianceSpecLint
object
Information about the API specification lint.
1 property
1 required
apiCatalogServiceEnvironmentData
object
Information about the environment.
2 properties
2 required
RemoveApiCatalogSystemEnvironmentAssociationsDataStatus
string
The status of the operation: - deleted — The association was successfully removed. - notFound — The association could not be removed.
discoveryServicesStatus
string
GetApiCatalogServiceCiRunsDataItemsExecutionSystem
object
The system information about the execution run. This returns as null if unavailable.
3 properties
getApiCatalogServiceEndpoints
object
2 properties
2 required
apiCatalogServiceSortCiFilter
string
GetApiCatalogSystemEnvironmentsRequestInternalServerError
RemoveApiCatalogSystemEnvironmentAssociationsRequestInternalServerError
GetApiCatalogSystemEnvironmentAssociationsRequestBadRequestError
systemEnvironmentId
string
GetApiCatalogServiceCiRunsDataItemsExecution
object
Information about the environment run.
2 properties
2 required
postApiCatalogDiscoveryServicesResponseMetaData
object
The operation's metadata summary.
3 properties
ApiCatalogServiceServiceDataComplianceMonitorRun
object
The scheduled monitor run summary.
1 property
1 required
GetApiCatalogServiceCiRunsDataItemsSourceRepo
object
Information about the source repository.
3 properties
3 required
PostApiCatalogDiscoveryServicesRequestInternalServerError
apiCatalogServiceRepoOwnerFilter
string
apiCatalogError
object
5 properties
getApiCatalogServiceOwnerData
object
The service's owner. If no owner is assigned, this returns a null value.
5 properties
5 required
apiCatalogServiceGovernanceGroupIdFilter
string
apiCatalogServiceNameFilter
string
postApiCatalogDiscoveryServices
object
1 property
1 required
ApiCatalogServiceServiceDataCompliance
object
Information about compliance and governance.
3 properties
3 required
CommonErrorNameMessageError
object
Information about the error.
2 properties
GetApiCatalogServiceRequestInternalServerError
getApiCatalogDiscoveryServiceApiDefinitionData
object
The API definition associated with the service.
4 properties
apiCatalogServiceBranchFilter
string
GetApiCatalogServiceSpecificationLintsDataItemsStatus
string
Whether the lint run passed or failed.
apiCatalogSystemEnvironmentsFiltersData
object
The applied filters, if any.
1 property
apiCatalogServiceSortEndpointsFilter
string
getApiCatalogSystemEnvironmentAssociationsData
object
Information about the workspace-environment association.
4 properties
4 required
GetApiCatalogDiscoveryServiceRequestInternalServerError
GetApiCatalogServiceCiRunsDataItemsStatus
string
Whether the CI run passed or failed.
GetApiCatalogSystemEnvironmentsRequestBadRequestError
GetApiCatalogServiceComplianceDataCliRunStatus
string
Whether the pipelines' latest runs passed or failed. If no runs exist, this returns a null value.
GetApiCatalogServiceSpecificationLintsRequestInternalServerError
AddApiCatalogSystemEnvironmentAssociationsRequestInternalServerError
apiCatalogServiceServiceData
object
Information about the service.
11 properties
11 required
getApiCatalogServiceCiRuns
object
2 properties
2 required
RemoveApiCatalogSystemEnvironmentAssociationsRequestBadRequestError
GetApiCatalogSystemEnvironmentAssociationsRequestInternalServerError
removeApiCatalogSystemEnvironmentAssociationsData
object
Information about the associated workspace environment.
2 properties
2 required
GetApiCatalogServiceCiRunsDataItemsPipeline
object
Information about the CI/CD pipeline.
9 properties
9 required
specId
string
GetApiCatalogServiceMeta
object
The response's meta information for paginated results.
2 properties
1 required
GetApiCatalogServiceMonitorRunsMeta
object
The response's meta information for paginated results.
8 properties
8 required
ApiCatalogServiceServiceDataComplianceSpecLintStatus
string
Whether the specifications' latest lints passed or failed. If no lints exist, this returns a null value.
apiCatalogServiceHttpMethodFilter
string
getApiCatalogServiceTrafficData
object
Information about traffic and performance within the time window. If there's no traffic data, this returns a null value.
8 properties
createApiCatalogSystemEnvironmentResponse
object
1 property
1 required
postApiCatalogDiscoveryServicesServiceData
object
Information about a discovered service.
14 properties
limitDefault20
integer
discoveryServicesSource
string
discoveryServicesSearch
string
GetApiCatalogServiceMonitorRunsDataItems
object
7 properties
7 required
apiCatalogServicePerformanceData
object
Information about the response time range across all requests in the run.
2 properties
2 required
apiCatalogDiscoveryServicesProviderMetadata
object
Additional metadata from the discovery source provider.
4 properties
CreateApiCatalogSystemEnvironmentRequestBadRequestError
GetApiCatalogSystemEnvironmentRequestInternalServerError
apiCatalogServiceSpecLintSeverityFilter
string
postApiCatalogDiscoveryServiceData
object
Information about the discovered service.
9 properties
1 required
GetApiCatalogServiceComplianceDataCliRun
object
Information about the CI/CD pipeline.
5 properties
5 required
createApiCatalogSystemEnvironment
object
5 properties
2 required
GetApiCatalogServiceCiRunsDataItemsSourcePullRequest
object
Information about the pull request. This returns null if the run wasn't triggered by a pull request.
6 properties
6 required
apiCatalogSystemEnvironmentData
object
Information about the system environment.
9 properties
9 required
removeApiCatalogSystemEnvironmentAssociations
object
1 property
1 required
systemEnvironmentAllowPartial
boolean
getApiCatalogServiceMonitorRuns
object
2 properties
2 required
apiCatalogServiceMetadataLimitData
integer
The maximum number of records in the paginated response.
GetApiCatalogServiceEndpointsMeta
object
The response's meta information for paginated results.
6 properties
6 required
apiCatalogServiceSearchFilter
string
getApiCatalogSystemEnvironments
object
2 properties
2 required
postApiCatalogDiscoveryServicesApiDefinitionData
object
The API definition (specification) for the service. If you pass this with the endpoints array, this object is given preference and endpoints is ignored.
1 property
commonErrorTypeTitleDetailStatus
object
4 properties
apiCatalogServiceStatusFilter
string
GetApiCatalogServiceCiRunsDataItemsSource
object
Information about the Git source control for the CI run.
4 properties
4 required
GetApiCatalogServiceEndpointsDataItemsMethod
string
The endpoint's HTTP method.
getApiCatalogDiscoveryService
object
Information about the discovered service.
20 properties
UpdateApiCatalogSystemEnvironmentRequestBadRequestError
getApiCatalogServiceData
object
Information about the discovered service.
10 properties
GetApiCatalogServiceCiRunsDataItemsSummary
object
Information about the CI run.
5 properties
5 required
GetApiCatalogServiceDataDependenciesItems
object
3 properties
3 required
GetApiCatalogServiceCiRunsDataItems
object
10 properties
10 required
GetApiCatalogServiceCiRunsRequestInternalServerError
ApiCatalogServiceServiceDataOwner
object
The service's owner. If no owner is assigned, this returns a null value.
5 properties
5 required
apiCatalogServiceCollectionData
object
Information about the collection.
2 properties
2 required
ApiCatalogServiceServiceDataTraffic
object
Information about traffic and performance within the time window. If there's no traffic data, this returns a null value.
2 properties
2 required
apiCatalogServiceRepoNameFilter
string
apiCatalogServiceSortSpecLintFilter
string
apiCatalogServiceMetadataSuccessRatePctData
number
The percentage of runs that passed, rounded to two decimal places.
postApiCatalogDiscoveryServicesProviderMetadataData
object
Additional metadata from the discovery source provider.
4 properties
removeApiCatalogSystemEnvironmentAssociationsResponse
object
2 properties
2 required
apiCatalogServiceWorkflowNameFilter
string
apiCatalogServiceMetadataNextCursorData
string
The pagination cursor that points to the next record in the results set.
serviceId
string
getApiCatalogSystemEnvironment
object
1 property
1 required
GetApiCatalogServiceSpecificationLintsMeta
object
The response's meta information for paginated results.
8 properties
8 required
apiCatalogServiceMetadataTotalRunsData
integer
The total number of runs that match the given filters.
ApiCatalogServiceServiceDataComplianceMonitorRunStatus
string
Whether the monitor's latest runs passed or failed. If no runs exist, this returns a null value.
GetApiCatalogServicesMeta
object
The response's meta information for paginated results.
4 properties
4 required
getApiCatalogServices
object
2 properties
apiCatalogDiscoveryServiceEndpointsData
object
Information about a service's endpoint.
4 properties
GetApiCatalogServiceMonitorRunsDataItemsStatus
string
Whether the monitor run passed or failed.
environmentId
string
GetApiCatalogServiceMonitorRunsDataItemsSummary
object
Information about the monitor run.
5 properties
5 required
getApiCatalogDiscoveryServices
object
2 properties
GetApiCatalogServiceEndpointsDataItemsErrors
object
Information about the endpoint's errors.
3 properties
3 required
getApiCatalogServiceComplianceData
object
Information about compliance and governance.
4 properties
4 required
ApiCatalogServiceMetadataTimeRangeDataLabel
string
The time range's label.
updateApiCatalogSystemEnvironmentResponse
object
1 property
1 required
postPatchApiCatalogSystemEnvironmentData
object
Information about the system environment.
8 properties
8 required
apiCatalogServiceMetadataTimeRangeData
object
The time window for the returned data.
3 properties
3 required
getApiCatalogDiscoveryMetaData
object
The response's meta information for paginated results.
2 properties
commonErrorTypeTitleDetail
object
3 properties
workspaceEnvironmentIdsData
array
A list of workspace environment IDs to remove. Accepts both the environment ID or the environment's unique ID (userId-environmentId).
GetApiCatalogServiceOwnerDataType
string
The type of owner.
apiCatalogServiceTagsFilter
string
apiCatalogServiceResponseCodeFilter
string
systemEnvironmentProductionFilter
boolean
CommonErrorTypeTitleDetailDetail
Information about the error.
apiCatalogServiceSortMonitorRun
string
getApiCatalogServiceSpecificationLints
object
2 properties
2 required
addApiCatalogSystemEnvironmentAssociationsMetaData
object
The response's meta information for paginated results.
4 properties
4 required
getApiCatalogService
object
2 properties
2 required
apiCatalogServiceMetadataFiltersData
object
The filters applied to the request.
AddApiCatalogSystemEnvironmentAssociationsRequestBadRequestError
GetApiCatalogServiceComplianceDataSpecLint
object
Information about the API specification lint.
6 properties
6 required
GetApiCatalogServicesRequestInternalServerError
removeApiCatalogSystemEnvironmentAssociationsMetaData
object
The response's meta information for paginated results.
2 properties
2 required
addApiCatalogSystemEnvironmentAssociations
object
1 property
1 required
ApiCatalogServiceServiceDataStatus
string
The overall health status, derived from compliance signals.
ApiCatalogServiceServiceDataComplianceCliRunStatus
string
Whether the pipelines' latest runs passed or failed. If no runs exist, this returns a null value.
GetApiCatalogServiceSpecificationLintsDataItems
object
6 properties
6 required
addApiCatalogSystemEnvironmentAssociationsData
object
Information about the associated workspace environment.
7 properties
2 required
GetApiCatalogServiceCiRunsMeta
object
The response's meta information for paginated results.
8 properties
8 required
GetApiCatalogServiceEndpointsRequestInternalServerError
apiCatalogServiceMetadataFailedRunsData
integer
The number of runs with at least one failure.
updateApiCatalogSystemEnvironment
object
4 properties
getApiCatalogSystemEnvironmentAssociations
object
2 properties
2 required
GetApiCatalogServiceData
object
Information about the service.
13 properties
13 required
postApiCatalogDiscoveryServicesResponse
object
2 properties
GetApiCatalogServiceComplianceDataCollectionRuns
object
Information about collection runs, including monitor runs, CI pipeline runs, and manual runs.
8 properties
8 required
CreateApiCatalogSystemEnvironmentRequestInternalServerError
GetApiCatalogServiceSpecificationLintsDataItemsIssues
object
Issue counts by severity level.
3 properties
3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Postman 12
Other APIs Postman publishes across the network.
Postman
Postman Collections API
Postman Workspaces API
Postman Environments API
Postman Monitors API
Postman Webhooks API
Postman Tags API
Postman Billing API
Postman SCIM API
Postman MCP Server
Postman Flows
Postman Mocks API
#API Catalog
Where this information came from
This is an independent, third-party profile of Postman apiCatalog API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.