Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Private API Network API

The **Private API Network** endpoints enable you to manage and work with your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/). These endpoints are only available on Postman [**Enterprise** plans](https://www.postman.com/pricing/#enterprise-solutions).

This API exposes 6 operations across 4 paths, and defines 23 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

6 operations 4 paths 23 schemas 1 DELETE2 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Private API Network API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 6

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

Private API Network 6

The Private API Network endpoints enable you to manage and work with your team's [Private API Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-ne…

GET
/network/private
APIs.io Engineering Platform Get all elements and folders
getAllElementsAndFolders 13 params → 200401403500
POST
/network/private
APIs.io Engineering Platform Add an element or folder
postPanElementOrFolder body → 201401403404500
PUT
/network/private/{elementType}/{elementId}
APIs.io Engineering Platform Update an element or folder
updatePanElementOrFolder 2 params body → 200401403404500
DELETE
/network/private/{elementType}/{elementId}
APIs.io Engineering Platform Remove an element or folder
deletePanElementOrFolder 2 params → 200400401403404500
GET
/network/private/network-entity/request/all
APIs.io Engineering Platform Get all element add requests
getAllPanAddElementRequests 10 params → 200400401403500
PUT
/network/private/network-entity/request/{requestId}
APIs.io Engineering Platform Respond to an element add request
respondPanElementAddRequest 1 param body → 200400401403500

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are panElementCreated (14 properties), panFolderCreated (9 properties), common403Error (4 properties), getPanElementsAndFolders (3 properties). Each schema is shown below with its type and property counts.

sinceDateTime
string
pan400ErrorInvalidParams
object
2 properties
updatePanCollection
object
1 property
panFolder400ErrorNotEmpty
object
2 properties
updatePanFolder
object
1 property
updatePanApi
object
1 property
panCreateApi
object
1 property
deletePanElementOrFolder
object
1 property
panCreateCollection
object
1 property
pan400ErrorInvalidQueryParams
object
2 properties
common403Error
object
4 properties
ascDesc
string
respondPanElementAddRequestBody
object
2 properties 1 required
panCreateWorkspace
object
1 property
untilDateTime
string
panFolderCreated
object
Information about the Private API Network folder.
9 properties
updatePanWorkspace
object
1 property
respondPanElementAddRequestResponse
object
1 property
instanceNotFoundElementFolder
object
1 property
getAllPanAddElementRequests
object
2 properties
panCreateFolder
object
1 property
panElementCreated
object
Information about the Private API Network element.
14 properties
getPanElementsAndFolders
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-private-api-network-api-openapi.yml Raw ↑