Postman API Catalog API
The apiCatalog API from Postman — 11 operation(s) for apicatalog.
Postman API Catalog API is one of 43 APIs that Postman publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 6 JSON Schema definitions.
Tagged areas include API Catalog. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 6 JSON Schemas.
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 API Catalog 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.
commonErrorTypeTitleDetail
object
3 properties
GetApiCatalogServiceCiRunsDataItemsStatus
string
Whether the CI run passed or failed.
postApiCatalogDiscoveryServices
object
1 property
1 required
GetApiCatalogServiceCiRunsDataItemsSourceRepo
object
Information about the source repository.
3 properties
3 required
apiCatalogServiceGovernanceGroupIdFilter
string
RemoveApiCatalogSystemEnvironmentAssociationsDataStatus
string
The status of the operation: - deleted — The association was successfully removed. - notFound — The association could not be removed.
apiCatalogSystemEnvironmentData
object
Information about the system environment.
9 properties
9 required
GetApiCatalogServicesMeta
object
The response's meta information for paginated results.
4 properties
4 required
systemEnvironmentAllowPartial
boolean
GetApiCatalogServiceOwnerDataType
string
The type of owner.
serviceId
string
apiCatalogServiceActorFilter
string
postApiCatalogDiscoveryServicesResponse
object
2 properties
getApiCatalogServices
object
2 properties
specId
string
systemEnvironmentWorkspaceId
string
AddApiCatalogSystemEnvironmentAssociationsDataStatus
string
The association's status: - created — An association was created. - existing — The association already existed and is unchanged. - replaced — The association w…
collectionUid
string
postApiCatalogDiscoveryServiceData
object
Information about the discovered service.
9 properties
1 required
GetApiCatalogServiceCiRunsDataItems
object
10 properties
10 required
apiCatalogServiceCollectionData
object
Information about the collection.
2 properties
2 required
apiCatalogServiceMetadataNextCursorData
string
The pagination cursor that points to the next record in the results set.
apiCatalogServiceMetadataConformanceRatePctData
number
The percentage of runs that passed, rounded to two decimal places.
limitDefault20
integer
ApiCatalogServiceServiceDataComplianceSpecLintStatus
string
Whether the specifications' latest lints passed or failed. If no lints exist, this returns a null value.
apiCatalogServiceWorkflowNameFilter
string
apiCatalogServiceSearchFilter
string
ApiCatalogServiceMetadataTimeRangeDataLabel
string
The time range's label.
GetApiCatalogServiceComplianceDataCliRunStatus
string
Whether the pipelines' latest runs passed or failed. If no runs exist, this returns a null value.
ApiCatalogServiceServiceDataComplianceCliRun
object
Information about the CI/CD pipeline.
1 property
1 required
apiCatalogServiceMetadataFailedRunsData
integer
The number of runs with at least one failure.
GetApiCatalogServiceCiRunsMeta
object
The response's meta information for paginated results.
8 properties
8 required
GetApiCatalogServiceEndpointsDataItemsMethod
string
The endpoint's HTTP method.
UpdateApiCatalogSystemEnvironmentRequestInternalServerError
ApiCatalogServiceServiceDataComplianceMonitorRunStatus
string
Whether the monitor's latest runs passed or failed. If no runs exist, this returns a null value.
UpdateApiCatalogSystemEnvironmentRequestBadRequestError
workspaceEnvironmentIdsData
array
A list of workspace environment IDs to remove. Accepts both the environment ID or the environment's unique ID (userId-environmentId).
apiCatalogDiscoveryServicesTagsData
array
A list of tags associated with the service.
GetApiCatalogServiceCiRunsDataItemsSummary
object
Information about the CI run.
5 properties
5 required
ApiCatalogServiceServiceDataOwner
object
The service's owner. If no owner is assigned, this returns a null value.
5 properties
5 required
ApiCatalogServiceServiceDataOwnerType
string
The type of owner.
cursor
string
getApiCatalogServiceOwnerData
object
The service's owner. If no owner is assigned, this returns a null value.
5 properties
5 required
GetApiCatalogServiceComplianceDataMonitorRun
object
The scheduled monitor run summary.
6 properties
6 required
apiCatalogServiceRepoOwnerFilter
string
environmentId
string
getApiCatalogDiscoveryMetaData
object
The response's meta information for paginated results.
2 properties
ApiCatalogServiceServiceDataStatus
string
The overall health status, derived from compliance signals.
apiCatalogServiceSortSpecLintFilter
string
CommonErrorTypeTitleDetailStatusType
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
removeApiCatalogSystemEnvironmentAssociationsMetaData
object
The response's meta information for paginated results.
2 properties
2 required
apiCatalogServiceMetadataLimitData
integer
The maximum number of records in the paginated response.
GetApiCatalogServiceMeta
object
The response's meta information for paginated results.
2 properties
1 required
updateApiCatalogSystemEnvironmentResponse
object
1 property
1 required
postApiCatalogDiscoveryServicesProviderMetadataData
object
Additional metadata from the discovery source provider.
4 properties
apiCatalogServiceResponseCodeFilter
string
apiCatalogServiceHttpMethodFilter
string
apiCatalogServiceBranchFilter
string
systemEnvironmentId
string
GetApiCatalogSystemEnvironmentRequestInternalServerError
getApiCatalogDiscoveryService
object
Information about the discovered service.
20 properties
apiCatalogServiceNameFilter
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
apiCatalogServiceSortCiFilter
string
getApiCatalogServiceSpecificationLints
object
2 properties
2 required
apiCatalogSystemEnvironmentsFiltersData
object
The applied filters, if any.
1 property
ApiCatalogServiceServiceDataComplianceCliRunStatus
string
Whether the pipelines' latest runs passed or failed. If no runs exist, this returns a null value.
CommonErrorTypeTitleDetailDetail
Information about the error.
GetApiCatalogServiceMonitorRunsRequestInternalServerError
GetApiCatalogServiceMonitorRunsMeta
object
The response's meta information for paginated results.
8 properties
8 required
addApiCatalogSystemEnvironmentAssociations
object
1 property
1 required
getApiCatalogDiscoveryServices
object
2 properties
GetApiCatalogSystemEnvironmentAssociationsRequestInternalServerError
apiCatalogErrorPathMessage
object
Information about the error.
2 properties
postPatchApiCatalogSystemEnvironmentData
object
Information about the system environment.
8 properties
8 required
GetApiCatalogServiceComplianceDataCliRun
object
Information about the CI/CD pipeline.
5 properties
5 required
addApiCatalogSystemEnvironmentAssociationsWorkspaceEnvId
string
A workspace environment ID.
apiCatalogServiceHostsFilter
string
getApiCatalogServiceData
object
Information about the discovered service.
10 properties
GetApiCatalogServiceCiRunsDataItemsSource
object
Information about the Git source control for the CI run.
4 properties
4 required
ApiCatalogServiceServiceDataComplianceMonitorRun
object
The scheduled monitor run summary.
1 property
1 required
GetApiCatalogServiceCiRunsDataItemsExecutionSystem
object
The system information about the execution run. This returns as null if unavailable.
3 properties
removeApiCatalogSystemEnvironmentAssociationsResponse
object
2 properties
2 required
apiCatalogServiceMetadataPassedRunsData
integer
The number of successful runs.
updateApiCatalogSystemEnvironment
object
4 properties
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
GetApiCatalogDiscoveryServicesRequestInternalServerError
GetApiCatalogServiceEndpointsDataItemsErrors
object
Information about the endpoint's errors.
3 properties
3 required
createApiCatalogSystemEnvironment
object
5 properties
2 required
getApiCatalogServiceEndpoints
object
2 properties
2 required
apiCatalogServicePerformanceData
object
Information about the response time range across all requests in the run.
2 properties
2 required
AddApiCatalogSystemEnvironmentAssociationsRequestInternalServerError
getApiCatalogSystemEnvironment
object
1 property
1 required
apiCatalogServiceMetadataTimeRangeData
object
The time window for the returned data.
3 properties
3 required
GetApiCatalogDiscoveryServiceRequestInternalServerError
getApiCatalogServiceCiRuns
object
2 properties
2 required
GetApiCatalogServiceMonitorRunsDataItemsStatus
string
Whether the monitor run passed or failed.
GetApiCatalogServiceEndpointsMeta
object
The response's meta information for paginated results.
6 properties
6 required
GetApiCatalogServiceSpecificationLintsDataItemsStatus
string
Whether the lint run passed or failed.
getApiCatalogDiscoveryServiceApiDefinitionData
object
The API definition associated with the service.
4 properties
GetApiCatalogServiceDataDependenciesItemsDirection
string
Whether traffic flows into (inbound) or out of (outbound) the service.
GetApiCatalogServiceData
object
Information about the service.
13 properties
13 required
postApiCatalogDiscoveryServicesResponseMetaData
object
The operation's metadata summary.
3 properties
apiCatalogServiceEnvironmentData
object
Information about the environment.
2 properties
2 required
apiCatalogError
object
5 properties
addApiCatalogSystemEnvironmentAssociationsMetaData
object
The response's meta information for paginated results.
4 properties
4 required
GetApiCatalogSystemEnvironmentsRequestInternalServerError
discoveryServicesSearch
string
ApiCatalogServiceServiceDataCompliance
object
Information about compliance and governance.
3 properties
3 required
GetApiCatalogServiceDataDependenciesItems
object
3 properties
3 required
getApiCatalogSystemEnvironmentAssociationsData
object
Information about the workspace-environment association.
4 properties
4 required
apiCatalogServiceTagsFilter
string
GetApiCatalogServiceComplianceDataMonitorRunStatus
string
Whether the monitor's latest runs passed or failed. If no runs exist, this returns a null value.
discoveryServicesSource
string
addApiCatalogSystemEnvironmentAssociationsData
object
Information about the associated workspace environment.
7 properties
2 required
apiCatalogServiceStatusFilter
string
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
GetApiCatalogServiceEndpointsDataItems
object
6 properties
6 required
getApiCatalogServiceEntityCountData
object
Information about the workspace's entities.
6 properties
6 required
systemEnvironmentProductionFilter
boolean
GetApiCatalogServiceCiRunsRequestInternalServerError
GetApiCatalogServiceDataStatus
string
The overall health status, derived from compliance signals.
removeApiCatalogSystemEnvironmentAssociationsData
object
Information about the associated workspace environment.
2 properties
2 required
GetApiCatalogServiceComplianceDataSpecLint
object
Information about the API specification lint.
6 properties
6 required
CommonErrorNameMessageError
object
Information about the error.
2 properties
addApiCatalogSystemEnvironmentAssociationsResponse
object
2 properties
2 required
GetApiCatalogServiceMonitorRunsDataItems
object
7 properties
7 required
apiCatalogServiceMetadataSuccessRatePctData
number
The percentage of runs that passed, rounded to two decimal places.
postApiCatalogDiscoveryServicesServiceData
object
Information about a discovered service.
14 properties
apiCatalogServiceServiceData
object
Information about the service.
11 properties
11 required
GetApiCatalogServiceMonitorRunsDataItemsSummary
object
Information about the monitor run.
5 properties
5 required
commonErrorNameMessage
object
1 property
GetApiCatalogServiceEndpointsDataItemsPerformance
object
Information about latency percentile metrics.
2 properties
2 required
GetApiCatalogServiceRequestInternalServerError
GetApiCatalogServiceCiRunsDataItemsExecution
object
Information about the environment run.
2 properties
2 required
GetApiCatalogServiceSpecificationLintsDataItems
object
6 properties
6 required
getApiCatalogServiceMonitorRuns
object
2 properties
2 required
GetApiCatalogSystemEnvironmentAssociationsRequestBadRequestError
removeApiCatalogSystemEnvironmentAssociations
object
1 property
1 required
RemoveApiCatalogSystemEnvironmentAssociationsRequestInternalServerError
GetApiCatalogServiceComplianceDataCollectionRuns
object
Information about collection runs, including monitor runs, CI pipeline runs, and manual runs.
8 properties
8 required
GetApiCatalogServiceSpecificationLintsDataItemsIssues
object
Issue counts by severity level.
3 properties
3 required
apiCatalogSystemEnvironmentsMetaData
object
The response's meta information for paginated results.
4 properties
3 required
GetApiCatalogServiceSpecificationLintsMeta
object
The response's meta information for paginated results.
8 properties
8 required
getApiCatalogServiceComplianceData
object
Information about compliance and governance.
4 properties
4 required
apiCatalogServiceSortMonitorRun
string
GetApiCatalogServiceCiRunsDataItemsSourcePullRequest
object
Information about the pull request. This returns null if the run wasn't triggered by a pull request.
6 properties
6 required
commonErrorTypeTitleDetailStatus
object
4 properties
apiCatalogServiceMetadataFiltersData
object
The filters applied to the request.
createApiCatalogSystemEnvironmentResponse
object
1 property
1 required
CreateApiCatalogSystemEnvironmentRequestBadRequestError
AddApiCatalogSystemEnvironmentAssociationsRequestBadRequestError
apiCatalogServiceSortEndpointsFilter
string
discoveryServicesStatus
string
apiCatalogServiceRepoNameFilter
string
getApiCatalogSystemEnvironments
object
2 properties
2 required
CreateApiCatalogSystemEnvironmentRequestInternalServerError
RemoveApiCatalogSystemEnvironmentAssociationsRequestBadRequestError
ApiCatalogServiceServiceDataComplianceSpecLint
object
Information about the API specification lint.
1 property
1 required
getApiCatalogSystemEnvironmentAssociations
object
2 properties
2 required
apiCatalogServiceMetadataTotalRunsData
integer
The total number of runs that match the given filters.
apiCatalogServiceSpecLintSeverityFilter
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
apiCatalogDiscoveryServiceEndpointsData
object
Information about a service's endpoint.
4 properties
getApiCatalogService
object
2 properties
2 required
GetApiCatalogServiceEndpointsRequestInternalServerError
GetApiCatalogSystemEnvironmentRequestBadRequestError
GetApiCatalogServicesRequestInternalServerError
PostApiCatalogDiscoveryServicesRequestInternalServerError
GetApiCatalogServiceCiRunsDataItemsPipeline
object
Information about the CI/CD pipeline.
9 properties
9 required
GetApiCatalogServiceComplianceDataSpecLintStatus
string
Whether the specifications' latest lints passed or failed. If no lints exist, this returns a null value.
GetApiCatalogSystemEnvironmentsRequestBadRequestError
apiCatalogDiscoveryServicesProviderMetadata
object
Additional metadata from the discovery source provider.
4 properties
GetApiCatalogServiceSpecificationLintsRequestInternalServerError
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 MCP Server
Postman Flows
Postman Mocks API
Postman Analytics API
Postman Billing API
#API Catalog
Where this information came from
This is an independent, third-party profile of Postman API Catalog 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.