How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Postman sdKs API

The sdKs API from Postman — 6 operation(s) for sdks.

Postman sdKs API is one of 51 APIs that Postman publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include SDK. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 10 operations across 6 paths, and defines 82 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.

10 operations 6 paths 82 schemas 1 DELETE6 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.getpostman.com
Authentication
API Key, HTTP Basic, API Key
Resource Areas
1

Authentication & Security 3

Postman sdKs 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 10

Across 6 paths, the API surfaces 10 operations — 1 DELETE, 6 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

sdKs 10
GET
/sdks
Get all SDKs
getSdks 8 params → 200400401403429500
POST
/sdks
Generate an SDK
createSdk 1 param body → 202400401403422429500
GET
/sdks/{sdkId}
Get an SDK
getSdk 2 params → 200401403404429500
DELETE
/sdks/{sdkId}
Delete an SDK
deleteSdk 2 params → 204401403404409429500
GET
/sdks/{sdkId}/downloads
Get an SDK's download URL
getSdkDownloadUrl 2 params → 200401403404409429500
GET
/sdk-git-connections
Get all SDK Git connections
getSdkGitConnections 8 params → 200400401403429500
POST
/sdk-git-connections
Connect a Git repository to an SDK
createSdkGitConnection 1 param body → 201400401403409429500
GET
/sdk-git-connections/{sdkGitConnectionId}
Get an SDK Git connection
getSdkGitConnection 2 params → 200401403404429500
PUT
/sdk-git-connections/{sdkGitConnectionId}
Update an SDK Git connection
updateSdkGitConnection 2 params body → 200400401403404422429500
GET
/sdk-git-connections/{sdkGitConnectionId}/pull-requests
Get an SDK Git connection's pull requests
getSdkGitConnectionPullRequests 5 params → 200401403404429500

Schemas 82

The contract defines 82 schemas that model the data the API accepts and returns. The most detailed are createSdk (15 properties), sdkGitConnection (11 properties), sdk (10 properties), sdkRetryOptions (8 properties). Each schema is shown below with its type and property counts.

GetSdkGitConnectionPullRequestsRequestUnauthorizedError
CreateSdkGitConnectionRequestForbiddenError
sdkGitConnectionStatus
string
The lifecycle status of the Git connection: - active — The connection is live and all opened pull requests ship SDK updates into the repository. - disconnected…
GetSdkDownloadUrlRequestInternalServerError
sdk
object
Information about the generated SDK.
10 properties 7 required
pythonOptions
object
Python-specific SDK generation options.
1 property
GetSdkRequestUnauthorizedError
sdkErrorBuildStatusFailure
object
Information about the SDK build's status when buildStatus is failed.
2 properties 2 required
DeleteSdkRequestUnauthorizedError
cursor
string
commonErrorNameMessage
object
1 property
CommonErrorTypeTitleDetailStatusType
GetSdkGitConnectionPullRequestsRequestForbiddenError
GetSdkDownloadUrlRequestForbiddenError
sdkGitConnectionPullRequestList
object
2 properties 2 required
metaNextCursorTotal
object
The response's meta information for paginated results.
2 properties
sdkLanguage
string
The target output language for the generated SDK.
javaOptions
object
Java-specific SDK generation options.
2 properties
CreateSdkRequestUnauthorizedError
sdkGitConnectionPullRequest
object
Information about a pull request that shipped the SDK update.
6 properties 5 required
GetSdkGitConnectionPullRequestsRequestInternalServerError
CommonErrorNameMessageError
object
Information about the error.
2 properties
sdkId
string
The SDK's ID.
sdkError
object
6 properties 3 required
cliOptions
object
CLI-specific SDK generation options.
1 property
csharpOptions
object
C-specific SDK generation options.
1 property
elementType-2
string
The type of Postman element.
rubyOptions
object
Ruby-specific generation options.
1 property
UpdateSdkGitConnectionRequestInternalServerError
sdkGitConnectionList
object
2 properties 2 required
goOptions
object
Go-specific SDK generation options.
1 property
sdkDownload
object
4 properties 4 required
SdkRetryOptionsHttpMethodsToRetryItems
string
UpdateSdkGitConnectionRequestUnauthorizedError
simpleSdkGitConnectionPullRequest
object
3 properties 3 required
createSdkGitConnection
object
5 properties 3 required
sdkList
object
2 properties 2 required
GetSdkGitConnectionsRequestInternalServerError
GetSdksRequestForbiddenError
UpdateSdkGitConnectionStatus
string
The updated SDK Git connection lifecycle state.
GetSdkGitConnectionRequestUnauthorizedError
sdkGitConnectionId
string
The Git connection's ID.
createSdk
object
Note: - Only the object passed in the request body that matches the value in the language property gets read, and all other objects are ignored. - The language…
15 properties 2 required
GetSdkGitConnectionRequestInternalServerError
CreateSdkRequestForbiddenError
GetSdkGitConnectionsRequestForbiddenError
GetSdkDownloadUrlRequestUnauthorizedError
autoUpdatePullRequestsEnabled
boolean
If true, pull requests are opened automatically whenever the source changes or a new version of the SDK generator is released. If false, pull requests are open…
GetSdkGitConnectionsRequestUnauthorizedError
DeleteSdkRequestForbiddenError
commonErrorTypeTitleDetailStatus
object
4 properties
workspaceId
string
SDKs_createSdk_Response_202
object
Empty response body
sdkBuildStatus
string
The SDK's build lifecycle: - queued — Accepted but not yet started. - inprogress — The SDK generation is running and in progress. - succeeded — The archive is…
kotlinOptions
object
Kotlin-specific SDK generation options.
2 properties
limitDefault25
integer
GetSdksRequestInternalServerError
sdkGitConnectionPRStatus
string
The lifecycle status of a pull request.
UpdateSdkGitConnectionRequestForbiddenError
GetSdkGitConnectionRequestForbiddenError
sdkSource
object
The collection or specification that the SDK is generated from.
2 properties 2 required
sdkRetryOptions
object
Retry behavior baked into the generated SDK's HTTP client. A power-user option; sensible defaults apply for any field left unset.
8 properties 1 required
sdkGitConnection
object
Information about the SDK's Git connection to a Postman element.
11 properties 10 required
GetSdkRequestForbiddenError
sdkAuthorData
object
Information about the author of the generated SDK.
2 properties 1 required
DeleteSdkRequestInternalServerError
phpOptions
object
PHP-specific SDK generation options.
1 property
CreateSdkGitConnectionRequestInternalServerError
rustOptions
object
Rust-specific SDK generation options.
1 property
SDKs_getSdks_Response_200
typescriptOptions
object
TypeScript-specific SDK generation options.
2 properties
sdkGitConnectionRepositoryUrl
string
Filter results by the canonical URL of the target Git repository.
commonErrorTypeTitleDetail
object
3 properties
httpCodesToRetry
integer
An HTTP status code.
CreateSdkGitConnectionRequestUnauthorizedError
CommonErrorTypeTitleDetailDetail
Information about the error.
GetSdkRequestInternalServerError
sdkPullRequest
object
If the SDK was shipped (or proposed for shipping) through a Git connection, this is a compact representation of the pull request that shipped it. Otherwise, th…
3 properties 3 required
CreateSdkRequestInternalServerError
updateSdkGitConnection
object
2 properties 1 required
GetSdksRequestUnauthorizedError
sdkSourceId
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

postman-sdks-api-openapi.yml Raw ↑

Other APIs Postman publishes across the network.

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
Where this information came from

This is an independent, third-party profile of Postman sdKs 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.